Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Select events #360

Open
bvdh opened this issue May 19, 2021 · 0 comments
Open

Select events #360

bvdh opened this issue May 19, 2021 · 0 comments

Comments

@bvdh
Copy link
Collaborator

bvdh commented May 19, 2021

An event that indicates that a resource has been selected in the one of the applications is part of the content-sharing discussions. The event is not related to just content sharing and should be discussed independently.

The event has been discussed in the May 2021 Connecthaton.
The event definitions discussed are presented below. One or more of these events should be added to the specification.

FHIRcast select messages

OptionsL

  1. all
  2. general (*-select)
  3. container (5 )
  4. resource (5)

--> file each and discuss later

select events (general)

An select event indicates the resources that are currently selected. This differs from -open events in that it has no meaning related to context changes. It just indicates a selection related to anchor resource.

Workflow

An select event is send when a resource has been selected (clicked-on) and the application wants to share this. A -select event will only result in a syncerror when the event could not be delivered. There are no requirements on the clients on receiving a -select event.

Implementer feedback is requested whether this event is sufficiently different from -open and -close events.

A typical use cases for select is selecting an observation in a image and focus the report on the section related to the observation and vice-versa.

Context

The context of the -select event described in the table below.

Key Optionality # type Description
selected REQUIRED * resource The resources selected of the resource type. Typically only the id and identifiers are shared.

Example

An example select event is indicated below.

{ 
  "timestamp":"2021-01-08T14:47:07+01:00",
  "id":"607b78b7-11ae-42b9-9bsdasdabf-a88c51524298",
  "hub.topic":"Topic3",
  "hub.event":"select",
  "event":{
    "context":[
      { "key":"selected",
        "resource":{
          "resourceType":"Observation",
          "id": "OBS-1",
          "subject": {
            "reference": "Patient/WL-PA-2"
          }
        }
      },
      { "key":"selected",
        "resource":{
          "resourceType":"ImagingStudy",
          "id": "IS-684",
          "subject": {
            "reference": "Patient/WL-PA-2"
          }
        }
      }
    ]
  }
}

-containerSelect events (container)

An -select event indicates the resources that are currently selected. This differs from -open events in that it has no meaning related to context changes. It just indicates a selection related to anchor resource.

Workflow

An -select event is send when a resource in the container of the anchor resource has been selected (clicked-on). A -select event will only result in a syncerror when the event could not be delivered. There are no requirements on the clients on receiving a -select event.

Container of an resource: the resource itself or any resource that is referred to or from the resource.

Implementer feedback is requested whether this event is sufficiently different from -open and -close events.

A typical use cases for select is selecting an observation in a image and focus the report on the section related to the observation and vice-versa.

Context

The context of the -select event described in the table below.

Key Optionality # type Description
{anchor-resource-type} REQUIRED 1 resource The anchor resource.
select REQUIRED * resource The resources selected in the container of the anchor. Typically only the id and identifiers are shared.

Example

An example diagnosticreport-select event is indicated below.

{ 
  "timestamp":"2021-01-08T14:47:07+01:00"
  "id":"607b78b7-11ae-42b9-9bsdasdabf-a88c51524298",
  "hub.topic":"Topic3",
  "hub.event":"diagnosticreport-select",
  "event":{
    "context":[
      { "key":"diagnosticreport",
        "resource":{ 
          "resourceType":"DiagnosticReport",
          "id":"WL-DR-2",
          "subject": "Patient/WL-PA-2"
        }
      },
      { "key":"selected",
        "resource":{
          "resourceType":"Observation",
          "id": "OBS-1",
          "subject": {
            "reference": "Patient/WL-PA-2"
          }
        }
      },
      { "key":"selected",
        "resource":{
          "resourceType":"ImagingStudy",
          "id": "IS-684",
          "subject": {
            "reference": "Patient/WL-PA-2"
          }
        }
      }
    ]
  }
}

-select events (resource specific)

An -select event indicates the resources that are currently selected. This differs from -open events in that it has no meaning related to context changes. It just indicates a selection of resource of a certain type.

Workflow

An -select event is send when a resource of a certain type has been selected (clicked-on). A -select event will only result in a syncerror when the event could not be delivered. There are no requirements on the clients on receiving a -select event.

Implementer feedback is requested whether this event is sufficiently different from -open and -close events.

A typical use cases for select is selecting an observation in a image and focus the report on the section related to the observation and vice-versa.

Context

The context of the -select event described in the table below.

Key Optionality # type Description
select REQUIRED * resource The resources selected in the container of the anchor. Typically only the id and identifiers are shared.

Example

An example Observation-select event is indicated below.

{ 
  "timestamp":"2021-01-08T14:47:07+01:00"
  "id":"607b78b7-11ae-42b9-9bsdasdabf-a88c51524298",
  "hub.topic":"Topic3",
  "hub.event":"diagnosticreport-select",
  "event":{
    "context":[
      { "key":"selected",
        "resource":{
          "resourceType":"Observation",
          "id": "OBS-1",
          "subject": {
            "reference": "Patient/WL-PA-2"
          }
        }
      }
    ]
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant