Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
Extensions
The UK Core extensions that are particularly relevant to pathology are listed below.
For a detailed description of all of the UK Core extensions (including examples) refer to UK Core Implementation Guide (STU3 Sequence) - Profiles and Extensions - Extensions Index.
It should be noted most of the pathology related extensions are linked to pre-adopted FHIR R5/R6 elements. For further information refer to UK Core Implementation Guide (STU3 Sequence) - Profiles and Extensions - Extensions Index - Pre-adopted R5/R6 Elements.
ext-R5-DiagnosticReport.composition
This extension allows a Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.
Table View
| Extension | 0..1 | |
| Extension.id | string | 0..1 |
| Extension.extension | Extension | 0..* |
| Extension.url | uri | 1..1 |
| Extension.value[x] | Reference(Profile_R5_Composition_R4 | Composition) | 0..1 |
JSON View
{
--- We have skipped the narrative for better readability of the resource ---
},
{
},
{
{
},
{
},
{
}
],
},
{
],
},
{
{
}
]
}
},
{
{
}
]
}
}
],
{
]
}
],
{
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\nelement `DiagnosticReport.composition` as defined in FHIR R5\nin FHIR R4.\n\nThe source element is defined as:\n`DiagnosticReport.composition` 0..1 `Reference(http://hl7.org/fhir/StructureDefinition/Composition)`\n\nAcross FHIR versions, the element set has been mapped as:\n* R5: `DiagnosticReport.composition` 0..1 `Reference(http://hl7.org/fhir/StructureDefinition/Composition)`\n\nFollowing are the generation technical comments:\nElement `DiagnosticReport.composition` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.composition` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
],
],
{
}
],
{
"comment": "Element `DiagnosticReport.composition` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.composition` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThe Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.",
},
"ele-1"
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
"definition": "Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.",
"comment": "The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.",
},
{
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Composition|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Composition|4.0.1"
]
}
],
{
}
],
]
}
]
},
{
"comment": "Element `DiagnosticReport.composition` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.composition` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThe Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.",
},
},
{
},
},
{
"definition": "Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.",
"comment": "The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.",
},
{
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Composition|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Composition|4.0.1"
]
}
]
}
]
}
}
Example Usage
"extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition", "valueReference": { "reference": "urn:uuid:604765c4-0e8a-4cd6-96a0-a2651fb5ab19" } } ],
ext-R5-DiagnosticReport.note
An extension to support adding comments about the DiagnosticReport.
Table View
| Extension | 0..* | |
| Extension.id | string | 0..1 |
| Extension.extension | Extension | 0..* |
| Extension.url | uri | 1..1 |
| Extension.value[x] | Annotation | 0..1 |
JSON View
{
--- We have skipped the narrative for better readability of the resource ---
},
{
},
{
{
},
{
},
{
}
],
},
{
],
},
{
{
}
]
}
},
{
{
}
]
}
}
],
{
]
}
],
{
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\nelement `DiagnosticReport.note` as defined in FHIR R5\nin FHIR R4.\n\nThe source element is defined as:\n`DiagnosticReport.note` 0..* `Annotation`\n\nAcross FHIR versions, the element set has been mapped as:\n* R5: `DiagnosticReport.note` 0..* `Annotation`\n\nFollowing are the generation technical comments:\nElement `DiagnosticReport.note` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.note` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
],
],
{
}
],
{
"comment": "Element `DiagnosticReport.note` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.note` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nMay include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation.",
},
"ele-1"
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
"comment": "May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation.",
},
],
{
}
],
]
}
]
},
{
"comment": "Element `DiagnosticReport.note` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.note` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nMay include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation.",
},
},
{
},
},
{
"comment": "May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation.",
},
]
}
]
}
}
ext-R5-DiagnosticReport.supportingInfo
An extension to support adding additional information relating to the DiagnosticReport.
Table View
JSON View
{
--- We have skipped the narrative for better readability of the resource ---
},
{
},
{
{
},
{
},
{
}
],
},
{
],
},
{
{
}
]
}
},
{
{
}
]
}
}
],
{
]
}
],
{
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\nelement `DiagnosticReport.supportingInfo` as defined in FHIR R5\nin FHIR R4.\n\nThe source element is defined as:\n`DiagnosticReport.supportingInfo` 0..* `BackboneElement`\n\nAcross FHIR versions, the element set has been mapped as:\n* R5: `DiagnosticReport.supportingInfo` 0..* `BackboneElement`\n\nFollowing are the generation technical comments:\nElement `DiagnosticReport.supportingInfo` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
],
],
{
}
],
{
"comment": "Element `DiagnosticReport.supportingInfo` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
"ele-1"
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
},
],
{
},
{
}
],
},
{
"comment": "Element `DiagnosticReport.supportingInfo.type` is part of an existing definition because parent element `DiagnosticReport.supportingInfo` requires a cross-version extension.\nElement `DiagnosticReport.supportingInfo.type` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo.type` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `DiagnosticReport.supportingInfo.type` is part of an existing definition because parent element `DiagnosticReport.supportingInfo` requires a cross-version extension.\nElement `DiagnosticReport.supportingInfo.type` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo.type` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
"definition": "The code value for the role of the supporting information in the diagnostic report.",
},
],
{
}
],
"description": "The code value for the role of the supporting information in the diagnostic report.",
},
]
},
{
"definition": "R5: `DiagnosticReport.supportingInfo.reference` (new:Reference(Procedure,Observation,DiagnosticReport,Citation))",
"comment": "Element `DiagnosticReport.supportingInfo.reference` is part of an existing definition because parent element `DiagnosticReport.supportingInfo` requires a cross-version extension.\nElement `DiagnosticReport.supportingInfo.reference` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo.reference` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `DiagnosticReport.supportingInfo.reference` is part of an existing definition because parent element `DiagnosticReport.supportingInfo` requires a cross-version extension.\nElement `DiagnosticReport.supportingInfo.reference` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo.reference` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
},
{
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Procedure|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Procedure|4.0.1",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Observation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Observation|4.0.1",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-DiagnosticReport|0.1.0",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport|4.0.1",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Citation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Basic|4.0.1"
]
}
],
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo",
]
},
{
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
}
],
{
}
],
]
}
]
},
{
"comment": "Element `DiagnosticReport.supportingInfo` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
},
{
},
}
},
{
"comment": "Element `DiagnosticReport.supportingInfo.type` is part of an existing definition because parent element `DiagnosticReport.supportingInfo` requires a cross-version extension.\nElement `DiagnosticReport.supportingInfo.type` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo.type` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `DiagnosticReport.supportingInfo.type` is part of an existing definition because parent element `DiagnosticReport.supportingInfo` requires a cross-version extension.\nElement `DiagnosticReport.supportingInfo.type` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo.type` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
}
},
{
},
},
{
"definition": "The code value for the role of the supporting information in the diagnostic report.",
},
],
"description": "The code value for the role of the supporting information in the diagnostic report.",
}
},
{
"definition": "R5: `DiagnosticReport.supportingInfo.reference` (new:Reference(Procedure,Observation,DiagnosticReport,Citation))",
"comment": "Element `DiagnosticReport.supportingInfo.reference` is part of an existing definition because parent element `DiagnosticReport.supportingInfo` requires a cross-version extension.\nElement `DiagnosticReport.supportingInfo.reference` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo.reference` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `DiagnosticReport.supportingInfo.reference` is part of an existing definition because parent element `DiagnosticReport.supportingInfo` requires a cross-version extension.\nElement `DiagnosticReport.supportingInfo.reference` has a context of DiagnosticReport based on following the parent source element upwards and mapping to `DiagnosticReport`.\nElement `DiagnosticReport.supportingInfo.reference` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
}
},
{
},
},
{
},
{
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Procedure|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Procedure|4.0.1",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Observation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Observation|4.0.1",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-DiagnosticReport|0.1.0",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport|4.0.1",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Citation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Basic|4.0.1"
]
}
]
},
{
},
},
{
}
}
]
}
}
ext-R5-Observation.bodyStructure
An extension to support adding a BodyStructure on an Observation.
Table View
| Extension | 0..1 | |
| Extension.id | string | 0..1 |
| Extension.extension | Extension | 0..* |
| Extension.url | uri | 1..1 |
| Extension.value[x] | Reference(Profile_R5_BodyStructure_R4 | BodyStructure) | 0..1 |
JSON View
{
--- We have skipped the narrative for better readability of the resource ---
},
{
},
{
{
},
{
},
{
}
],
},
{
],
},
{
{
}
]
}
},
{
{
}
]
}
}
],
{
]
}
],
{
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\nelement `Observation.bodyStructure` as defined in FHIR R5\nin FHIR R4.\n\nThe source element is defined as:\n`Observation.bodyStructure` 0..1 `Reference(http://hl7.org/fhir/StructureDefinition/BodyStructure)`\n\nAcross FHIR versions, the element set has been mapped as:\n* R5: `Observation.bodyStructure` 0..1 `Reference(http://hl7.org/fhir/StructureDefinition/BodyStructure)`\n\nFollowing are the generation technical comments:\nElement `Observation.bodyStructure` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.bodyStructure` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
],
],
{
}
],
{
"comment": "Element `Observation.bodyStructure` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.bodyStructure` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nOnly used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.",
},
"ele-1"
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
"definition": "Indicates the body structure on the subject's body where the observation was made (i.e. the target site).",
"comment": "Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.",
},
{
"http://hl7.org/fhir/5.0/StructureDefinition/profile-BodyStructure|0.1.0",
"http://hl7.org/fhir/StructureDefinition/BodyStructure|4.0.1"
]
}
],
{
}
],
]
}
]
},
{
"comment": "Element `Observation.bodyStructure` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.bodyStructure` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nOnly used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.",
},
},
{
},
},
{
"definition": "Indicates the body structure on the subject's body where the observation was made (i.e. the target site).",
"comment": "Only used if not implicit in code found in Observation.code or bodySite is used. In many systems, this may be represented as a related observation instead of an inline component.",
},
{
"http://hl7.org/fhir/5.0/StructureDefinition/profile-BodyStructure|0.1.0",
"http://hl7.org/fhir/StructureDefinition/BodyStructure|4.0.1"
]
}
]
}
]
}
}
Extension-UKCore-ObservationOrganizer
This extension indicates that an Observation is functioning as an organizer or grouper, referencing one or more subordinate Observations through hasMember element links. Within this implementation guide, the extension signifies that the Observation represents a test group — for example, a test battery, panel, or profile.
The extension is based on the organizer element introduced in FHIR R6. Refer to the description of Observation.organizer in the base FHIR R6 Specification (Ballot - 3rd Draft) for more details.
Table View
| Extension | 0..1 | |
| Extension.id | string | 0..1 |
| Extension.extension | Extension | 0..* |
| Extension.url | uri | 1..1 |
| Extension.value[x] | boolean | 1..1 |
JSON View
{
{
]
}
],
"description": "An extension to replicate the changes within R6 to support adding the organizer element to denote if the Observation instance is an organizer (other names are grouper / panel).",
"copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.",
],
],
{
{
},
{
}
],
},
"ele-1"
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
},
],
{
}
],
]
}
]
},
{
},
{
},
{
]
}
]
}
}
Example Usage
"extension": [ { "url": "http://hl7.org/fhir/6.0/StructureDefinition/extension-Observation.organizer", "valueBoolean": true } ],
ext-R5-Observation.triggeredBy
This extension supports the sharing of the Observation(s) that triggered the performance of the main observation.
Table View
| Extension | 0..* | |
| Extension.id | string | 0..1 |
| Extension.extension | Extension | 2..* |
| Extension.extension:observation | Extension | 1..1 |
| Extension.extension:observation.id | string | 0..1 |
| Extension.extension:observation.extension | Extension | 0..* |
| Extension.extension:observation.url | uri | 1..1 |
| Extension.extension:observation.value[x] | Reference(Profile_R5_Observation_R4 | Observation) | 1..1 |
| Extension.extension:type | Extension | 1..1 |
| Extension.extension:type.id | string | 0..1 |
| Extension.extension:type.extension | Extension | 0..* |
| Extension.extension:type.url | uri | 1..1 |
| Extension.extension:type.value[x] | code | 1..1 |
| Extension.extension:reason | Extension | 0..1 |
| Extension.extension:reason.id | string | 0..1 |
| Extension.extension:reason.extension | Extension | 0..* |
| Extension.extension:reason.url | uri | 1..1 |
| Extension.extension:reason.value[x] | string | 0..1 |
| Extension.url | uri | 1..1 |
| Extension.value[x] | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | 0..0 |
JSON View
{
--- We have skipped the narrative for better readability of the resource ---
},
{
},
{
{
},
{
},
{
}
],
},
{
],
},
{
{
}
]
}
},
{
{
}
]
}
}
],
{
]
}
],
{
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\nelement `Observation.triggeredBy` as defined in FHIR R5\nin FHIR R4.\n\nThe source element is defined as:\n`Observation.triggeredBy` 0..* `BackboneElement`\n\nAcross FHIR versions, the element set has been mapped as:\n* R5: `Observation.triggeredBy` 0..* `BackboneElement`\n\nFollowing are the generation technical comments:\nElement `Observation.triggeredBy` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
],
],
{
}
],
{
"comment": "Element `Observation.triggeredBy` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
"ele-1"
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
},
],
{
},
{
}
],
},
{
"comment": "Element `Observation.triggeredBy.observation` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.observation` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.observation` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `Observation.triggeredBy.observation` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.observation` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.observation` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
},
{
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Observation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Observation|4.0.1"
]
}
],
{
}
],
]
},
{
"comment": "Element `Observation.triggeredBy.type` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.type` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.type` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `Observation.triggeredBy.type` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.type` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.type` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
},
],
{
}
],
},
]
},
{
"comment": "Element `Observation.triggeredBy.reason` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.reason` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.reason` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `Observation.triggeredBy.reason` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.reason` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.reason` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
],
{
},
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
"definition": "Provides the reason why this observation was performed as a result of the observation(s) referenced.",
},
],
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
}
],
{
}
],
]
}
]
},
{
"comment": "Element `Observation.triggeredBy` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
},
},
{
},
}
},
{
"comment": "Element `Observation.triggeredBy.observation` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.observation` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.observation` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `Observation.triggeredBy.observation` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.observation` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.observation` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
}
},
{
},
},
{
},
{
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Observation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Observation|4.0.1"
]
}
]
},
{
"comment": "Element `Observation.triggeredBy.type` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.type` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.type` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `Observation.triggeredBy.type` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.type` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.type` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
}
},
{
},
},
{
},
],
}
},
{
"comment": "Element `Observation.triggeredBy.reason` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.reason` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.reason` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"requirements": "Element `Observation.triggeredBy.reason` is part of an existing definition because parent element `Observation.triggeredBy` requires a cross-version extension.\nElement `Observation.triggeredBy.reason` has a context of Observation based on following the parent source element upwards and mapping to `Observation`.\nElement `Observation.triggeredBy.reason` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
}
},
{
},
},
{
"definition": "Provides the reason why this observation was performed as a result of the observation(s) referenced.",
},
]
},
{
},
},
{
}
}
]
}
}
Extension-UKCore-SpecimenCollectionCollector
This extension allows the referencing of Patient and RelatedPerson within Specimen.collection.
Table View
| Extension | 0..* | |
| Extension.id | string | 0..1 |
| Extension.extension | Extension | 0..* |
| Extension.url | uri | 1..1 |
| Extension.value[x] | Reference(Patient | RelatedPerson) | 1..1 |
JSON View
{
{
]
}
],
"purpose": "This is a use case from Genomics to backport R5 functionality extending the referencing of Specimen.collection.collector to include Patient and RelatedPerson",
"copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.",
],
{
{
},
{
}
],
},
"ele-1"
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
{
},
{
}
],
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
{
},
{
}
],
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
},
{
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"ele-1"
],
{
}
],
]
}
]
},
{
},
{
},
{
{
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
]
}
]
}
}
Extension-valueset-reference
This extension allows the referencing of codes to a specific valueset. Within this implementation guide it is used to differentiate the SNOMED CT reference sets in the Observation.code element slicing.
Table View
| Extension | 0..1 | |
| Extension.id | id | 0..1 |
| Extension.extension | Extension | 0..0 |
| Extension.url | uri | 1..1 |
| Extension.value[x] | uri | 1..1 |
JSON View
{
--- We have skipped the narrative for better readability of the resource ---
},
{
},
{
},
{
},
{
}
],
],
],
"description": "A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.",
],
{
},
{
}
],
],
{
}
],
{
"definition": "A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.",
"comment": "If this extension is used with an [extensible binding](terminologies.html#extensible), and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.",
},
{
},
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
"ele-1"
],
]
},
{
],
},
},
],
{
},
{
}
],
},
{
"xmlAttr"
],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
},
{
{
}
],
}
],
]
},
{
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
},
],
"ext-1"
],
{
}
],
]
}
]
},
{
"definition": "A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.",
"comment": "If this extension is used with an [extensible binding](terminologies.html#extensible), and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.",
]
},
{
},
{
},
{
}
]
}
}
Example Usage
The following shows the code 1000821000000103 | Serum albumin level | which is from the SNOMED CT PBCL Observables reference set. This code is equivalent to 1105861000000106 | Albumin mass concentration in serum | from the SNOMED CT PaLM Observables reference set.
"code": { "coding": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/valueset-reference", "valueUri": "https://fhir.nhs.uk/England/ValueSet/England-PathologyBoundedCodeListObservables" } ], "system": "http://snomed.info/sct", "code": "1000821000000103", "display": "Serum albumin level" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/valueset-reference", "valueUri": "https://fhir.nhs.uk/England/ValueSet/England-PathologyAndLaboratoryMedicineObservables" } ], "system": "http://snomed.info/sct", "code": "1105861000000106", "display": "Albumin mass concentration in serum" } ] }