Fhir 45719 advanced reference

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+    "blanks-around-tables": false
+}

FHIR-fhircast.xml

@@ -11,8 +11,8 @@
 <artifactPageExtension value="-mappings"/>
 <artifact id="StructureDefinition/fhircast-content-update-bundle" key="StructureDefinition-fhircast-content-update-bundle" name="FHIRcast Content Update Bundle"/>
 <artifact id="StructureDefinition/fhircast-diagnostic-report-open" key="StructureDefinition-fhircast-diagnostic-report-open" name="FHIRcast Diagnostic Report for Open Events"/>
-<artifact id="StructureDefinition/fhircast-diagnostic-report-select" key="StructureDefinition-fhircast-diagnostic-report-select" name="FHIRcast Diagnostic Report for Select Events"/>
-<artifact id="StructureDefinition/fhircast-diagnostic-report-update" key="StructureDefinition-fhircast-diagnostic-report-update" name="FHIRcast Diagnostic Report for Update Events"/>
+<artifact deprecated="true" id="StructureDefinition/fhircast-diagnostic-report-select" key="StructureDefinition-fhircast-diagnostic-report-select" name="FHIRcast Diagnostic Report for Select Events"/>
+<artifact deprecated="true" id="StructureDefinition/fhircast-diagnostic-report-update" key="StructureDefinition-fhircast-diagnostic-report-update" name="FHIRcast Diagnostic Report for Update Events"/>
 <artifact id="StructureDefinition/fhircast-diagnostic-report-close" key="StructureDefinition-fhircast-diagnostic-report-close" name="FHIRcast DiagnosticReport for Close Events"/>
 <artifact id="StructureDefinition/fhircast-encounter-close" key="StructureDefinition-fhircast-encounter-close" name="FHIRcast Encounter for Close Events"/>
 <artifact id="StructureDefinition/fhircast-encounter-open" key="StructureDefinition-fhircast-encounter-open" name="FHIRcast Encounter for Open Events"/>
@@ -31,8 +31,8 @@
 <artifact id="Bundle/FHIRcastContentUpdateBundle-Example" key="Bundle-FHIRcastContentUpdateBundle-Example" name="FHIRcastContentUpdateBundle-Example"/>
 <artifact id="DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327-close" key="DiagnosticReport-2402d3bd-e988-414b-b7f2-4322e86c9327-close" name="FHIRcastDiagnosticReportClose-Example"/>
 <artifact id="DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327" key="DiagnosticReport-2402d3bd-e988-414b-b7f2-4322e86c9327" name="FHIRcastDiagnosticReportOpen-Example"/>
-<artifact id="DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327-select" key="DiagnosticReport-2402d3bd-e988-414b-b7f2-4322e86c9327-select" name="FHIRcastDiagnosticReportSelect-Example"/>
-<artifact id="DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327-update" key="DiagnosticReport-2402d3bd-e988-414b-b7f2-4322e86c9327-update" name="FHIRcastDiagnosticReportUpdate-Example"/>
+<artifact deprecated="true" id="DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327-select" key="DiagnosticReport-2402d3bd-e988-414b-b7f2-4322e86c9327-select" name="FHIRcastDiagnosticReportSelect-Example"/>
+<artifact deprecated="true" id="DiagnosticReport/2402d3bd-e988-414b-b7f2-4322e86c9327-update" key="DiagnosticReport-2402d3bd-e988-414b-b7f2-4322e86c9327-update" name="FHIRcastDiagnosticReportUpdate-Example"/>
 <artifact id="Encounter/8cc652ba-770e-4ae1-b688-6e8e7c737438-close" key="Encounter-8cc652ba-770e-4ae1-b688-6e8e7c737438-close" name="FHIRcastEncounterClose-Example"/>
 <artifact id="Encounter/8cc652ba-770e-4ae1-b688-6e8e7c737438" key="Encounter-8cc652ba-770e-4ae1-b688-6e8e7c737438" name="FHIRcastEncounterOpen-Example"/>
 <artifact id="Bundle/8i7tbu6fby5fuuey7133eh" key="Bundle-8i7tbu6fby5fuuey7133eh" name="FHIRcastGetCurrentContentBundle-Example"/>

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)"

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)"