diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 00000000..e53e9e61 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,3 @@ +{ + "blanks-around-tables": false +} \ No newline at end of file diff --git a/FHIR-fhircast.xml b/FHIR-fhircast.xml index d0830259..ac7715f7 100644 --- a/FHIR-fhircast.xml +++ b/FHIR-fhircast.xml @@ -11,8 +11,8 @@ - - + + @@ -31,8 +31,8 @@ - - + + diff --git a/input/fsh/FHIRcastDiagnosticReportSelect.fsh b/input/fsh/FHIRcastDiagnosticReportSelect.fsh index 21d6b7c2..842b18a5 100644 --- a/input/fsh/FHIRcastDiagnosticReportSelect.fsh +++ b/input/fsh/FHIRcastDiagnosticReportSelect.fsh @@ -1,35 +1,35 @@ -Profile: FHIRcastDiagnosticReportSelect -Parent: DiagnosticReport -Id: fhircast-diagnostic-report-select -Title: "FHIRcast Diagnostic Report for Select Events" -Description: -""" -Provides guidance as to which `DiagnosticReport` attributes should be present and considerations as to how each attribute should be valued in [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) events. +// Profile: FHIRcastDiagnosticReportSelect +// Parent: DiagnosticReport +// Id: fhircast-diagnostic-report-select +// Title: "FHIRcast Diagnostic Report for Select Events" +// Description: +// """ +// Provides guidance as to which `DiagnosticReport` attributes should be present and considerations as to how each attribute should be valued in [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) events. -The `DiagnosticReport` in [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) events enables verification that the selected content in the [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event belongs to the DiagnosticReport which is the current anchor context. +// The `DiagnosticReport` in [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) events enables verification that the selected content in the [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event belongs to the DiagnosticReport which is the current anchor context. -Hence, the only required attributes of `DiagnosticReport` in the [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event is the resources' `id`, as well as its `status` and `code` since these attributes are required by FHIR. Other attributes of the `DiagnosticReport` MAY be valued but would serve no purpose in the [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event. +// Hence, the only required attributes of `DiagnosticReport` in the [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event is the resources' `id`, as well as its `status` and `code` since these attributes are required by FHIR. Other attributes of the `DiagnosticReport` MAY be valued but would serve no purpose in the [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event. -""" -* ^extension[0].url = "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" -* ^extension[0].valueCode = #inm -* id 1..1 -* id ^short = "A logical id of the resource SHALL be provided." -* id ^definition = -""" -A logical id of the resource SHALL be provided. -""" -* status 1..1 -* status ^short = "Status of the DiagnosticReport, note this may not be known and hence have a value of `unknown`; however, is included since it is required by FHIR" -* status ^definition = -""" -While initially the `status` of the report may begin as `unknown` or `preliminary` (or something else), throughout the lifecycle of the context the report's status may transition. For example, a reporting application may enable a clinician to sign the report. In such a situation this change in status could become final and would be communicated through a [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event prior to the DiagnosticReport context being closed by a DiagnosticReport-close event. -""" +// """ +// * ^extension[0].url = "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" +// * ^extension[0].valueCode = #inm +// * id 1..1 +// * id ^short = "A logical id of the resource SHALL be provided." +// * id ^definition = +// """ +// A logical id of the resource SHALL be provided. +// """ +// * status 1..1 +// * status ^short = "Status of the DiagnosticReport, note this may not be known and hence have a value of `unknown`; however, is included since it is required by FHIR" +// * status ^definition = +// """ +// While initially the `status` of the report may begin as `unknown` or `preliminary` (or something else), throughout the lifecycle of the context the report's status may transition. For example, a reporting application may enable a clinician to sign the report. In such a situation this change in status could become final and would be communicated through a [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event prior to the DiagnosticReport context being closed by a DiagnosticReport-close event. +// """ -Instance: FHIRcastDiagnosticReportSelect-Example -InstanceOf: FHIRcastDiagnosticReportSelect -Usage: #example -Description: "Example of a `DiagnosticReport` which could be used in a [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event. Note that due to limitation of tools used to publishing the specification the below resource `id` is appended with '-select'. The specification requires that the resource `id` in the [FHIR resource]-select be identical to the resource `id` provided in the corresponding [FHIR resource]-open; hence in the real world the '-select' suffix would not be present." -* id = "2402d3bd-e988-414b-b7f2-4322e86c9327-select" -* status = http://terminology.hl7.org/fhir/ValueSet/diagnostic-report-status#unknown -* code = http://loinc.org#19005-8 "Radiology Imaging study [Impression] (narrative)" +// Instance: FHIRcastDiagnosticReportSelect-Example +// InstanceOf: FHIRcastDiagnosticReportSelect +// Usage: #example +// Description: "Example of a `DiagnosticReport` which could be used in a [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html) event. Note that due to limitation of tools used to publishing the specification the below resource `id` is appended with '-select'. The specification requires that the resource `id` in the [FHIR resource]-select be identical to the resource `id` provided in the corresponding [FHIR resource]-open; hence in the real world the '-select' suffix would not be present." +// * id = "2402d3bd-e988-414b-b7f2-4322e86c9327-select" +// * status = http://terminology.hl7.org/fhir/ValueSet/diagnostic-report-status#unknown +// * code = http://loinc.org#19005-8 "Radiology Imaging study [Impression] (narrative)" diff --git a/input/fsh/FHIRcastDiagnosticReportUpdate.fsh b/input/fsh/FHIRcastDiagnosticReportUpdate.fsh index 27fb0848..0f4bc461 100644 --- a/input/fsh/FHIRcastDiagnosticReportUpdate.fsh +++ b/input/fsh/FHIRcastDiagnosticReportUpdate.fsh @@ -1,41 +1,41 @@ -Profile: FHIRcastDiagnosticReportUpdate -Parent: DiagnosticReport -Id: fhircast-diagnostic-report-update -Title: "FHIRcast Diagnostic Report for Update Events" -Description: -""" -Provides guidance as to which `DiagnosticReport` attributes should be present and considerations as to how each attribute should be valued in [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) events. +// Profile: FHIRcastDiagnosticReportUpdate +// Parent: DiagnosticReport +// Id: fhircast-diagnostic-report-update +// Title: "FHIRcast Diagnostic Report for Update Events" +// Description: +// """ +// Provides guidance as to which `DiagnosticReport` attributes should be present and considerations as to how each attribute should be valued in [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) events. -The `DiagnosticReport` in [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) events enables verification that the content in the [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) event's Bundle attribute belongs to the DiagnosticReport which is the current anchor context. +// The `DiagnosticReport` in [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) events enables verification that the content in the [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) event's Bundle attribute belongs to the DiagnosticReport which is the current anchor context. -Hence, the only required attributes of `DiagnosticReport` in the [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) event is the resources' `id`, as well as its `status` since this attribute is required by FHIR. +// Hence, the only required attributes of `DiagnosticReport` in the [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) event is the resources' `id`, as well as its `status` since this attribute is required by FHIR. -**FHIR R4 versus FHIR R5** -In the FHIR R4 DiagnosticReport resource image study references would be placed in the `imagingStudy` attribute. In a FHIR R5 (or above) DiagnosticReport this attribute has been renamed `study` since the allowed reference types has been expanded to include references to GenomicStudy resources. This is obviously a breaking change. +// **FHIR R4 versus FHIR R5** +// In the FHIR R4 DiagnosticReport resource image study references would be placed in the `imagingStudy` attribute. In a FHIR R5 (or above) DiagnosticReport this attribute has been renamed `study` since the allowed reference types has been expanded to include references to GenomicStudy resources. This is obviously a breaking change. -In FHIRcast deployments based on FHIR R5, the attribute `study` SHALL be used rather than the `imagingStudy` attribute. +// In FHIRcast deployments based on FHIR R5, the attribute `study` SHALL be used rather than the `imagingStudy` attribute. -Additionally FHIR R5 includes a `supportingInfo` attribute. While not yet formally provided for in FHIR R5 (R6 formalizes this support), it has been recommended that the next release of FHIR allow an ImagingStudy reference be included in this attribute so that the DiagnosticReport could indicate one or more image studies were consulted during the creation of the report. As such in FHIR R5 deployments, this field should be considered labeled as must support. -""" -* ^extension[0].url = "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" -* ^extension[0].valueCode = #inm -* id 1..1 -* id ^short = "A logical id of the resource SHALL be provided." -* id ^definition = -""" -A logical id of the resource SHALL be provided. -""" -* status 1..1 -* status ^short = "Status of the DiagnosticReport, note this may not be known and hence have a value of `unknown`; however, is included since it is required by FHIR" -* status ^definition = -""" -While initially the `status` of the report may begin as `unknown` or `preliminary` (or something else), throughout the lifecycle of the context the report's status may transition. For example, a reporting application may enable a clinician to sign the report. In such a situation this change in `status` could become final and would be communicated through the `Bundle` resource inside the `updates` key of a [`DiagnosticReport-update` (3-6-3-DiagnosticReport-update.html) event prior to the DiagnosticReport context being closed by a [`DiagnosticReport-close`](3-6-2-DiagnosticReport-close.html) event. -""" +// Additionally FHIR R5 includes a `supportingInfo` attribute. While not yet formally provided for in FHIR R5 (R6 formalizes this support), it has been recommended that the next release of FHIR allow an ImagingStudy reference be included in this attribute so that the DiagnosticReport could indicate one or more image studies were consulted during the creation of the report. As such in FHIR R5 deployments, this field should be considered labeled as must support. +// """ +// * ^extension[0].url = "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" +// * ^extension[0].valueCode = #inm +// * id 1..1 +// * id ^short = "A logical id of the resource SHALL be provided." +// * id ^definition = +// """ +// A logical id of the resource SHALL be provided. +// """ +// * status 1..1 +// * status ^short = "Status of the DiagnosticReport, note this may not be known and hence have a value of `unknown`; however, is included since it is required by FHIR" +// * status ^definition = +// """ +// While initially the `status` of the report may begin as `unknown` or `preliminary` (or something else), throughout the lifecycle of the context the report's status may transition. For example, a reporting application may enable a clinician to sign the report. In such a situation this change in `status` could become final and would be communicated through the `Bundle` resource inside the `updates` key of a [`DiagnosticReport-update` (3-6-3-DiagnosticReport-update.html) event prior to the DiagnosticReport context being closed by a [`DiagnosticReport-close`](3-6-2-DiagnosticReport-close.html) event. +// """ -Instance: FHIRcastDiagnosticReportUpdate-Example -InstanceOf: FHIRcastDiagnosticReportUpdate -Usage: #example -Description: "Example of a `DiagnosticReport` which could be used in a [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) event. Note that due to limitation of tools used to publishing the specification the below resource `id` is appended with '-update'. The specification requires that the resource `id` in the [FHIR resource]-update be identical to the resource `id` provided in the corresponding [FHIR resource]-open; hence in the real world the '-update' suffix would not be present." -* id = "2402d3bd-e988-414b-b7f2-4322e86c9327-update" -* status = http://terminology.hl7.org/fhir/ValueSet/diagnostic-report-status#unknown -* code = http://loinc.org#19005-8 "Radiology Imaging study [Impression] (narrative)" +// Instance: FHIRcastDiagnosticReportUpdate-Example +// InstanceOf: FHIRcastDiagnosticReportUpdate +// Usage: #example +// Description: "Example of a `DiagnosticReport` which could be used in a [`DiagnosticReport-update`](3-6-3-DiagnosticReport-update.html) event. Note that due to limitation of tools used to publishing the specification the below resource `id` is appended with '-update'. The specification requires that the resource `id` in the [FHIR resource]-update be identical to the resource `id` provided in the corresponding [FHIR resource]-open; hence in the real world the '-update' suffix would not be present." +// * id = "2402d3bd-e988-414b-b7f2-4322e86c9327-update" +// * status = http://terminology.hl7.org/fhir/ValueSet/diagnostic-report-status#unknown +// * code = http://loinc.org#19005-8 "Radiology Imaging study [Impression] (narrative)" diff --git a/input/pagecontent/2-3-Events.md b/input/pagecontent/2-3-Events.md index d78066f1..bd3505a2 100644 --- a/input/pagecontent/2-3-Events.md +++ b/input/pagecontent/2-3-Events.md @@ -41,27 +41,27 @@ Event names are unique and case-insensitive. It is RECOMMENDED to use [Upper-Cam Implementers may define their own events. Such proprietary events SHALL be named with reverse domain notation (e.g. `org.example.patient_transmogrify`). Reverse domain notation SHALL NOT be used by a standard event catalog. Proprietary events SHALL NOT contain a dash ("-"). Note that this specification uses an asterisk to refer to categories of events (e.g. `*-open` for all open events), but that this syntax is not supported when interacting with a Hub. - ### Context -Describes the set of contextual data associated with this event. Only data logically and necessarily associated with the purpose of this workflow related event should be represented in context. An event SHALL contain all required data fields, MAY contain optional data fields and SHALL NOT contain any additional fields. Events defined in the standard event catalog or by implementers SHALL contain only valid JSON and MAY contain FHIR resources. +Describes the set of contextual data associated with this event. Only data logically and necessarily associated with the purpose of this workflow related event should be represented in context. An event SHALL contain all required data fields, MAY contain optional data fields and SHALL NOT contain any additional fields. Events defined in the standard event catalog or by implementers SHALL contain only valid JSON and MAY contain FHIR resources or [datatypes](https://www.hl7.org/fhir/r4/datatypes.html). All fields available within an event's context SHALL be defined in a table where each field is described by the following attributes: - **Key**: The name of the field in the context JSON object. Event authors SHOULD name their context fields to be consistent with other existing events when referring to the same context field. The key name SHALL be lower case and implementations SHALL treat them as case-sensitive. - **Cardinality**: Indicates the optionality and maximum resources instances allowed in an event's context -- **FHIR operation to generate context**: A FHIR read or search string illustrating the intended content of the event. +- **FHIR type of the field**: The [FHIR DataType](https://www.hl7.org/fhir/r4/datatypes.html) of the field, "Resource" to indicate a full resource. - **Description**: A functional description of the context value. If this value can change according to the FHIR version in use, the description SHOULD describe the value for each supported FHIR version. The key used for indicating a context change event's FHIR resource SHALL be the lower-case resourceType of the resource as defined in the [resource type valueset](http://build.fhir.org/valueset-version-independent-resource-types.html). For example, the [patient-open](3-3-1-Patient-open.html) event uses the `patient` key to signal the new Patient in context. Note that due to legacy reasons, some events deviate from this pattern. The resources to include are defined in the corresponding event definition in the [event catalog](3_Events.html). - References to resources other than anchor resources SHALL be named any string which is not a value from the resource type valueset. In the case in which other events are deriveable from the event in question, additional non-anchor FHIR resources included in the event SHALL be named what they are named in the deriveable event. The Hub SHALL only return FHIR resources that the Subscriber is authorized to receive with the existing OAuth 2.0 access_token's granted `fhircast/` scopes. +Besides a key field, each context element also holds a value element. The field of the value holds the name as its datatype in lowercase: i.e. `resource` indicates a FHIR resource, `reference` a reference, `string` a string. + ### Event types The FHIRcast specification supports many different events. These events are defined in the [event catalog](3_Events.html). The events can be grouped in different types. The following sections define the characteristics of these different event-types. @@ -124,7 +124,6 @@ FHIRcast supports all events that follow this format. The most common events def #### Selection events - Experimental - Selection events use the suffix `select`. The format of selection event names is: ```ebnf @@ -133,6 +132,6 @@ SelectionEventName ::= ( FHIRresource ) '-' ( 'select' ) {% include img.html img="SelectionEventName.png" caption="Figure: Selection Event-name specification" %} -`*-select` events provide a mechanism to select content in the context an `anchor context` (see [`anchor context`](5_glossary.html)). `*-select` events select content resources within the `anchor context`, not the `anchor context` itself (making the `anchor context` the current context is performed by the corresponding `*-open` event). The `context` array in a select event contains two attributes. The FHIR resource which is the `anchor context`, and a select array indicating the content resource(s) that are selected. If the Subscriber wants to indicate that no resource is selected, the select attribute is an empty array. +`*-select` events provide a mechanism to select content in the context an `anchor context` (see [`anchor context`](5_glossary.html)). `*-select` events select content resources within the `anchor context`, not the `anchor context` itself (making the `anchor context` the current context is performed by the corresponding `*-open` event). The `context` array in a select event contains two attributes. A reference to the FHIR resource which is the `anchor context`, and a select array indicating the content resource(s) that are selected. If the Subscriber wants to indicate that no resource is selected, the select attribute is an empty array. FHIRcast supports all events that follow this format. The most common events definitions have been provided in the [event catalog](3_Events.html). For an example see [`DiagnosticReport-select`](3-6-4-DiagnosticReport-select.html). diff --git a/input/pagecontent/3-1-1-template.md b/input/pagecontent/3-1-1-template.md index 66fe61d1..a72089fb 100644 --- a/input/pagecontent/3-1-1-template.md +++ b/input/pagecontent/3-1-1-template.md @@ -13,10 +13,11 @@ Describe when this event occurs in a workflow. Describe how the context fields r Define context values that are provided when this event occurs, and indicate whether they must be provided, and the FHIR query used to generate the resource. {:.grid} -Key | Optionality | Description ------ | ---- | ---- -`example` | REQUIRED | Describe the context value -`FHIRresource` | OPTIONAL | Describe the context value +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`patient` | 1..1 | resource | Describe the context value +`FHIRresource` | 0..1 | resource | Describe the context value +`subject` | 0..1 | reference | A reference to an important subject. ### Examples diff --git a/input/pagecontent/3-2-1-SyncError.md b/input/pagecontent/3-2-1-SyncError.md index 880dba18..200d758c 100644 --- a/input/pagecontent/3-2-1-SyncError.md +++ b/input/pagecontent/3-2-1-SyncError.md @@ -21,10 +21,12 @@ A `SyncError` is broadcast by the Hub when one of the following conditions occur In these events the field `issue.severity` SHALL beset to `warning` as is specified in [Operation outcome for Hub generated sync-errors](StructureDefinition-fhircast-hub-operation-outcome-syncerrror.html). - ### Context - -The `context` array SHALL contain a single FHIR OperationOutcome based on the profile [Operation outcome for sync-errors](StructureDefinition-fhircast-operation-outcome-syncerror.html). + +{:.grid} +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`operationoutcome` | 1..1 | resource | A FHIR OperationOutcome based on the profile [Operation outcome for sync-errors](StructureDefinition-fhircast-operation-outcome-syncerror.html). ### Example diff --git a/input/pagecontent/3-2-2-UserLogout.md b/input/pagecontent/3-2-2-UserLogout.md index c4455624..62baa2e9 100644 --- a/input/pagecontent/3-2-2-UserLogout.md +++ b/input/pagecontent/3-2-2-UserLogout.md @@ -14,7 +14,10 @@ If a Subscriber decides that it will not logout the current user it SHOULD send ### Context -The context SHOULD contain a Parameters resource according to the following profile [Logout Context](StructureDefinition-fhircast-logout.html). +{:.grid} +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`parameters` | 1..1 | resource | A Parameters resource according to the following profile [Logout Context](StructureDefinition-fhircast-logout.html). ### Examples diff --git a/input/pagecontent/3-2-3-UserHibernate.md b/input/pagecontent/3-2-3-UserHibernate.md index dfa25457..5b7fddc8 100644 --- a/input/pagecontent/3-2-3-UserHibernate.md +++ b/input/pagecontent/3-2-3-UserHibernate.md @@ -10,7 +10,10 @@ Unlike most of FHIRcast events, `UserHibernate` is a statically named event and ### Context -The context SHOULD contain a Parameters resource according to the following profile [Hibernate Context](StructureDefinition-fhircast-hibernate.html). +{:.grid} +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`parameters` | 1..1 | resource | A Parameters resource according to the following profile [Hibernate Context](StructureDefinition-fhircast-hibernate.html). ### Examples diff --git a/input/pagecontent/3-3-1-Patient-open copy.md b/input/pagecontent/3-3-1-Patient-open copy.md new file mode 100644 index 00000000..179d2391 --- /dev/null +++ b/input/pagecontent/3-3-1-Patient-open copy.md @@ -0,0 +1,88 @@ +### Event name: Patient-open + +eventMaturity | [3 - Considered](3-1-2-eventmaturitymodel.html) + +### Workflow + +User opened a patient's medical record. The indicated patient is now the current patient in context. + +### Context + +{:.grid} +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`patient` | 1..1 | resource | FHIR Patient resource describing the patient now in context. + +The following profile provides guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in a Patient open request: + +* [Patient for Open Events](StructureDefinition-fhircast-patient-open.html) + +Other attributes of the Patient resource (or resource extensions) may be present in the provided resource; however, attributes not called out in the profile are not required by the FHIRcast standard. + +### Examples + +```json +{ + "timestamp": "2023-04-01T010:38:04.16", + "id": "6efe28b2-7f8b-4cbc-bc59-a21a902f7e04", + "event": { + "hub.topic": "fdb2f928-5546-4f52-87a0-0648e9ded065", + "hub.event": "Patient-open", + "context": [ + { + "key": "patient", + "resource": { + "resourceType": "Patient", + "id": "503824b8-fe8c-4227-b061-7181ba6c3926", + "identifier" : [ + { + "use" : "official", + "type" : { + "coding" : [ + { + "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", + "code" : "MR" + } + ] + }, + "system": "urn:oid:2.16.840.1.113883.19.5", + "value": "4438001", + "assigner": { + "reference": "Organization/a92ac1be-fb34-49c1-be58-10928bd271cc", + "display": "My Healthcare Provider" + } + } + ], + "name" : [ + { + "use" : "official", + "family" : "Smith", + "given" : [ + "John" + ], + "prefix" : [ + "Dr." + ], + "suffix" : [ + "Jr.", + "M.D." + ] + } + ], + "gender" : "male", + "birthDate" : "1978-11-03" + } + } + ] + } +} +``` + +### Change Log + +{:.grid} +| Version | Description +| ---- | ---- +| 1.0 | Initial Release +| 1.1 | Deprecate encounter element in favor of dedicated `encounter-open` event +| 1.2 | Reference context resource profiles and update example to be compliant with the profiles diff --git a/input/pagecontent/3-3-1-Patient-open.md b/input/pagecontent/3-3-1-Patient-open.md index 77ac812f..179d2391 100644 --- a/input/pagecontent/3-3-1-Patient-open.md +++ b/input/pagecontent/3-3-1-Patient-open.md @@ -9,9 +9,9 @@ User opened a patient's medical record. The indicated patient is now the current ### Context {:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`patient` | 1..1 | FHIR Patient resource describing the patient now in context. +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`patient` | 1..1 | resource | FHIR Patient resource describing the patient now in context. The following profile provides guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in a Patient open request: diff --git a/input/pagecontent/3-3-2-Patient-close.md b/input/pagecontent/3-3-2-Patient-close.md index fdc0aad6..ca6686e6 100644 --- a/input/pagecontent/3-3-2-Patient-close.md +++ b/input/pagecontent/3-3-2-Patient-close.md @@ -9,9 +9,9 @@ User closed the patient's medical record. A previously opened and in context pat ### Context {:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`patient` | 1..1 | FHIR Patient resource describing the patient previously in context that is being closed. +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`patient` | 1..1 | resource | FHIR Patient resource describing the patient previously in context that is being closed. The following profiles provide guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in a Patient close request: diff --git a/input/pagecontent/3-4-1-Encounter-open.md b/input/pagecontent/3-4-1-Encounter-open.md index dda9533b..ae7dd331 100644 --- a/input/pagecontent/3-4-1-Encounter-open.md +++ b/input/pagecontent/3-4-1-Encounter-open.md @@ -9,10 +9,10 @@ User opened patient's medical record in the context of a single encounter. The i ### Context {:.grid} -Key | Cardinality |Description ------ | -------- |---- -`encounter` | 1..1 | FHIR Encounter resource describing the encounter now in context. -`patient` | 1..1 | FHIR Patient resource describing the patient whose encounter is now in context. +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`encounter` | 1..1 | resource | FHIR Encounter resource describing the encounter now in context. +`patient` | 1..1 | resource | FHIR Patient resource describing the patient whose encounter is now in context. The following profiles provide guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in an Encounter open request: diff --git a/input/pagecontent/3-4-2-Encounter-close.md b/input/pagecontent/3-4-2-Encounter-close.md index e2381c84..9dd2b0d0 100644 --- a/input/pagecontent/3-4-2-Encounter-close.md +++ b/input/pagecontent/3-4-2-Encounter-close.md @@ -9,10 +9,10 @@ User closed a patient's medical record encounter context. A previously open and ### Context {:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`encounter` | 1..1 | FHIR Encounter resource describing the encounter previously in context that is being closed. -`patient` | 1..1 | FHIR Patient resource describing the patient associated with the encounter being closed. +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`encounter` | 1..1 | resource | FHIR Encounter resource describing the encounter previously in context that is being closed. +`patient` | 1..1 | resource | FHIR Patient resource describing the patient associated with the encounter being closed. The following profiles provide guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in an Encounter close request: diff --git a/input/pagecontent/3-5-1-ImagingStudy-open.md b/input/pagecontent/3-5-1-ImagingStudy-open.md index 021bc94c..f19ad90f 100644 --- a/input/pagecontent/3-5-1-ImagingStudy-open.md +++ b/input/pagecontent/3-5-1-ImagingStudy-open.md @@ -8,12 +8,12 @@ User opened an imaging study. The newly opened image study is now the current im ### Context -{:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`study` | 1..1 | FHIR ImagingStudy resource describing the image study now in context. -`encounter` | 0..1 | A FHIR Encounter resource may be associated with the image study. -`patient` | 0..1 | FHIR Patient resource describing the patient whose image study is currently in context. A Patient SHALL be present if there is a patient associated with the image study. Note there are rare cases in which the ImagingStudy.subject references a resource which is not a patient; for example a calibration study would reference the device being calibrated. +:.grid} +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`study` | 1..1 | resource | FHIR ImagingStudy resource describing the image study now in context. +`encounter` | 0..1 | resource | A FHIR Encounter resource may be associated with the image study. +`patient` | 0..1 | resource | FHIR Patient resource describing the patient whose image study is currently in context. A Patient SHALL be present if there is a patient associated with the image study. Note there are rare cases in which the ImagingStudy.subject references a resource which is not a patient; for example a calibration study would reference the device being calibrated. The following profiles provide guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in an ImagingStudy open request: diff --git a/input/pagecontent/3-5-2-ImagingStudy-close.md b/input/pagecontent/3-5-2-ImagingStudy-close.md index 1e962d31..5739c7a4 100644 --- a/input/pagecontent/3-5-2-ImagingStudy-close.md +++ b/input/pagecontent/3-5-2-ImagingStudy-close.md @@ -9,11 +9,11 @@ User closed an imaging study. A previously open and in context image study is no ### Context {:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`study` | 1..1 | FHIR ImagingStudy resource describing the image study previously in context that is being closed. -`encounter` | 0..1 | A FHIR Encounter resource may be associated with the image study. -`patient` | 0..1 | FHIR Patient resource describing the patient associated with the image study being closed. A Patient SHALL be present if there is a patient associated with the image study. +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`study` | 1..1 | resource | FHIR ImagingStudy resource describing the image study previously in context that is being closed. +`encounter` | 0..1 | resource | A FHIR Encounter resource may be associated with the image study. +`patient` | 0..1 | resource | FHIR Patient resource describing the patient associated with the image study being closed. A Patient SHALL be present if there is a patient associated with the image study. The following profiles provide guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in an ImagingStudy close request: diff --git a/input/pagecontent/3-6-1-DiagnosticReport-open.md b/input/pagecontent/3-6-1-DiagnosticReport-open.md index f73cc4e6..5a60792c 100644 --- a/input/pagecontent/3-6-1-DiagnosticReport-open.md +++ b/input/pagecontent/3-6-1-DiagnosticReport-open.md @@ -9,12 +9,12 @@ User opened a report. The newly opened report is now the current report in cont ### Context {:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`report` | 1..1 | FHIR DiagnosticReport resource describing the report now in context. -`encounter` | 0..1 | A FHIR Encounter resource may be associated with the report -`study` | 0..* | FHIR ImagingStudy resource(s) describing the image study (or image studies) which are the subject of the report now in context. For non-imaging related uses of FHIRcast there may be no image study related to the report. In radiology or other image related uses of FHIRcast, at least one imaging study would be the subject of a report and SHALL be included in the event's context. -`patient` | 1..1 | FHIR Patient resource describing the patient whose report is currently in context. This Patient SHALL be the subject referenced by the DiagnosticReport and any ImagingStudy resources present in the context. +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`report` | 1..1 | resource | FHIR DiagnosticReport resource describing the report now in context. +`encounter` | 0..1 | resource | A FHIR Encounter resource may be associated with the report +`study` | 0..* | resource | FHIR ImagingStudy resource(s) describing the image study (or image studies) which are the subject of the report now in context. For non-imaging related uses of FHIRcast there may be no image study related to the report. In radiology or other image related uses of FHIRcast, at least one imaging study would be the subject of a report and SHALL be included in the event's context. +`patient` | 1..1 | resource | FHIR Patient resource describing the patient whose report is currently in context. This Patient SHALL be the subject referenced by the DiagnosticReport and any ImagingStudy resources present in the context. The following profiles provide guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in a DiagnosticReport open request: diff --git a/input/pagecontent/3-6-2-DiagnosticReport-close.md b/input/pagecontent/3-6-2-DiagnosticReport-close.md index 35892ee4..b177615a 100644 --- a/input/pagecontent/3-6-2-DiagnosticReport-close.md +++ b/input/pagecontent/3-6-2-DiagnosticReport-close.md @@ -9,12 +9,12 @@ User closed a report. A previously open and in context report is no longer open ### Context {:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`report` | 1..1 | FHIR DiagnosticReport resource describing the report previously in context that is being closed. -`encounter` | 0..1 | A FHIR Encounter resource may be associated with the report -`study` | 0..* | FHIR ImagingStudy resource(s) describing any image study that was opened as part of the report context that is being closed. -`patient` | 1..1 | FHIR Patient resource describing the patient associated with the report being closed. +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`report` | 1..1 | resource | FHIR DiagnosticReport resource describing the report previously in context that is being closed. +`encounter` | 0..1 | resource | A FHIR Encounter resource may be associated with the report +`study` | 0..* | resource | FHIR ImagingStudy resource(s) describing any image study that was opened as part of the report context that is being closed. +`patient` | 1..1 | resource | FHIR Patient resource describing the patient associated with the report being closed. The following profiles provide guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in DiagnosticReport close request: diff --git a/input/pagecontent/3-6-3-DiagnosticReport-update.md b/input/pagecontent/3-6-3-DiagnosticReport-update.md index f247f5a0..f1708aa9 100644 --- a/input/pagecontent/3-6-3-DiagnosticReport-update.md +++ b/input/pagecontent/3-6-3-DiagnosticReport-update.md @@ -12,15 +12,14 @@ The updates that may be included in the `updates` bundle include: #### Context {:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`report` | 1..1 | FHIR DiagnosticReport resource specifying the [`anchor context`](5_glossary.html) in which the update is being made. Note the mandatory elements defined in the [DiagnosticReport update profile](StructureDefinition-fhircast-diagnostic-report-update.html). Other attributes may be present in the DiagnosticReport resource if their values have changed or were newly populated. -`patient` | 0..1 | May be provided so that Subscribers may perform identity verification according to their requirements. -`updates` | 1..1 | Contains a single `Bundle` resource holding changes to be made to the current content of the [`anchor context`](5_glossary.html) +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`report` | 1..1 | reference | Reference to the FHIR DiagnosticReport resource specifying the [`anchor context`](5_glossary.html) in which the update is being made. +`patient` | 0..1 | reference | May be provided so that Subscribers may perform identity verification according to their requirements. +`updates` | 1..1 | resource | Contains a single `Bundle` resource holding changes to be made to the current content of the [`anchor context`](5_glossary.html) The following profiles provide guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in a DiagnosticReport-update request: -* [Diagnostic Report for Update Events](StructureDefinition-fhircast-diagnostic-report-update.html) * [Content Update Bundle](StructureDefinition-fhircast-content-update-bundle.html) #### Supported Update Request Methods @@ -50,16 +49,13 @@ The following example shows adding an imaging study to the existing diagnostic r "context": [ { "key": "report", - "resource": { - "resourceType": "DiagnosticReport", - "id": "2402d3bd-e988-414b-b7f2-4322e86c9327" + "reference": { "reference": "DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327" } }, { "key": "patient", - "resource": { - "resourceType": "Patient", - "id": "503824b8-fe8c-4227-b061-7181ba6c3926" + "reference": { + "reference": "Patient/503824b8-fe8c-4227-b061-7181ba6c3926" } }, { @@ -148,16 +144,12 @@ The Hub SHALL distribute a corresponding event to all Subscribers. The Hub SHALL "context": [ { "key": "report", - "resource": { - "resourceType": "DiagnosticReport", - "id": "2402d3bd-e988-414b-b7f2-4322e86c9327" + "reference": { "reference" : "DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327" } }, { "key": "patient", - "resource": { - "resourceType": "Patient", - "id": "503824b8-fe8c-4227-b061-7181ba6c3926" + "reference": { "reference": "Patient/503824b8-fe8c-4227-b061-7181ba6c3926" } }, { @@ -245,16 +237,12 @@ The following example shows a request to delete an observation from a content sh "context": [ { "key": "report", - "resource": { - "resourceType": "DiagnosticReport", - "id": "2402d3bd-e988-414b-b7f2-4322e86c9327" + "reference": { "reference": "DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327" } }, { "key": "patient", - "resource": { - "resourceType": "Patient", - "id": "503824b8-fe8c-4227-b061-7181ba6c3926" + "reference": { "reference": "Patient/503824b8-fe8c-4227-b061-7181ba6c3926" } }, { diff --git a/input/pagecontent/3-6-4-DiagnosticReport-select.md b/input/pagecontent/3-6-4-DiagnosticReport-select.md index 499d0d2a..148feab0 100644 --- a/input/pagecontent/3-6-4-DiagnosticReport-select.md +++ b/input/pagecontent/3-6-4-DiagnosticReport-select.md @@ -12,14 +12,11 @@ If one or more resources are noted as selected, any other resource which had bee ### Context {:.grid} -Key | Cardinality | Description ------ | -------- | ---- -`report` | 1..1 | FHIR DiagnosticReport resource specifying the [`anchor context`](5_glossary.html) in which the selection is being made. Note that only the resource.resourceType and resource.id of the [`anchor context`](5_glossary.html) are required to be present. -`select` | 1..1 | Contains zero or more references to selected resources in a `resources` array. If a reference to a resource is present in the `resources` array, there is an implicit unselect of any previously selected resource. If no resource references are present in the `resources` array, this is an indication that any previously selected resource is now unselected. +Key | Cardinality | Type | Description +--------- | ----------- | --------- | -------------- +`report` | 1..1 | reference | Reference to the FHIR DiagnosticReport resource specifying the [`anchor context`](5_glossary.html) in which the selection is being made. +`select` | 1..* | reference | Contains zero or more references to selected resources. If a reference to a resource is present , there is an implicit unselect of any previously selected resource. If no resource references are present , this is an indication that any previously selected resource is now unselected. -The following profile provides guidance as to which resource attributes should be present and considerations as to how each attribute should be valued in a DiagnosticReport-select request: - -* [Diagnostic Report for Select Events](StructureDefinition-fhircast-diagnostic-report-select.html) ### Examples @@ -51,10 +48,9 @@ The following example shows the selection of a single Observation resource in an }, { "key": "select", - "resources": [ + "reference": [ { - "resourceType": "Observation", - "id": "40afe766-3628-4ded-b5bd-925727c013b3" + "reference": "Observation/40afe766-3628-4ded-b5bd-925727c013b3" } ] }