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.

Extension-UKCore-DiagnosticReportComposition

This extension allows a Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.

Tree View

id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueReferenceReference(Composition)

Table View

Extension..
Extension.url..
Extension.value[x]Reference(Composition)1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-DiagnosticReportComposition" />
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" />
<version value="1.1.0" />
<name value="ExtensionUKCoreDiagnosticReportComposition" />
<title value="Extension UK Core Diagnostic Report Composition" />
<status value="active" />
<date value="2023-12-12" />
<publisher value="HL7 UK" />
<contact>
<name value="HL7 UK" />
<telecom>
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="This extension allows a Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport." />
<purpose value="This is a use case from Genomics to backport R5 functionality and align with HL7 EU laboratory IG." />
<copyright value="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." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="DiagnosticReport" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<short value="A Composition reference for a DiagnosticReport." />
<definition value="A Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport." />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<short value="Reference to a Composition resource for the DiagnosticReport structure" />
<definition value="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." />
<min value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Composition" />
</type>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-DiagnosticReportComposition",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition",
"version": "1.1.0",
"name": "ExtensionUKCoreDiagnosticReportComposition",
"title": "Extension UK Core Diagnostic Report Composition",
"status": "active",
"date": "2023-12-12",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "This extension allows a Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.",
"purpose": "This is a use case from Genomics to backport R5 functionality and align with HL7 EU laboratory IG.",
"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.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "DiagnosticReport"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "A Composition reference for a DiagnosticReport.",
"definition": "A Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport."
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Reference to a Composition resource for the DiagnosticReport structure",
"definition": "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.",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Composition"
]
}
]
}
]
}
}

Extension-UKCore-DiagnosticReportNote

An extension to support adding comments about the DiagnosticReport.

Tree View

id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueAnnotationAnnotation

Table View

Extension..
Extension.url..
Extension.value[x]Annotation1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-DiagnosticReportNote" />
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" />
<version value="1.1.0" />
<name value="ExtensionUKCoreDiagnosticReportNote" />
<title value="Extension UK Core Diagnostic Report Note" />
<status value="active" />
<date value="2023-12-12" />
<publisher value="HL7 UK" />
<contact>
<name value="HL7 UK" />
<telecom>
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="An extension to support adding comments about the diagnostic report." />
<purpose value="This is a Genomics use case to support the backporting of R5 functionality to support adding 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." />
<copyright value="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." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="DiagnosticReport" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<short value="Comments about the diagnostic report." />
<definition value="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." />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<short value="Comments about the diagnostic report." />
<definition value="Need to be able to provide free text additional information." />
<min value="1" />
<type>
<code value="Annotation" />
</type>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-DiagnosticReportNote",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note",
"version": "1.1.0",
"name": "ExtensionUKCoreDiagnosticReportNote",
"title": "Extension UK Core Diagnostic Report Note",
"status": "active",
"date": "2023-12-12",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "An extension to support adding comments about the diagnostic report.",
"purpose": "This is a Genomics use case to support the backporting of R5 functionality to support adding 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.",
"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.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "DiagnosticReport"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Comments about the diagnostic report.",
"definition": "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."
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Comments about the diagnostic report.",
"definition": "Need to be able to provide free text additional information.",
"min": 1,
"type": [
{
"code": "Annotation"
}
]
}
]
}
}

Extension-UKCore-DiagnosticReportSupportingInfo

An extension to support adding additional information relating to the DiagnosticReport.

Tree View

id0..1string
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueCodeableConceptCodeableConcept
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueReferenceReference(Procedure | Observation | DiagnosticReport)
url1..1uriFixed Value

Table View

Extension..
Extension.extension1..
Extension.extension:type1..1
Extension.extension:type.url..
Extension.extension:type.value[x]CodeableConcept1..
Extension.extension:reference1..1
Extension.extension:reference.url..
Extension.extension:reference.value[x]Reference(Procedure | Observation | DiagnosticReport)1..1
Extension.url..
Extension.value[x]..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-DiagnosticReportSupportingInfo" />
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo" />
<version value="1.0.1" />
<name value="ExtensionUKCoreDiagnosticReportSupportingInfo" />
<title value="Extension UK Core Diagnostic Report Supporting Info" />
<status value="active" />
<date value="2025-02-11" />
<publisher value="HL7 UK" />
<contact>
<name value="HL7 UK" />
<telecom>
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="An extension to support adding additional info supporting the diagnostic report." />
<purpose value="This is a Pathology use case to support the backporting of R5 functionality to support adding additional supporting information that was used in the creation of the diagnostic report." />
<copyright value="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." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="DiagnosticReport" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<short value="Additional information supporting the diagnostic report." />
<definition value="This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report." />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<rules value="open" />
</slicing>
<min value="1" />
</element>
<element id="Extension.extension:type">
<path value="Extension.extension" />
<sliceName value="type" />
<short value="Supporting information role code." />
<definition value="The code value for the role of the supporting information in the diagnostic report." />
<min value="1" />
<max value="1" />
<binding>
<strength value="example" />
<valueSet value="http://terminology.hl7.org/ValueSet/v2-0936" />
</binding>
</element>
<element id="Extension.extension:type.url">
<path value="Extension.extension.url" />
<fixedUri value="type" />
</element>
<element id="Extension.extension:type.value[x]">
<path value="Extension.extension.value[x]" />
<min value="1" />
<type>
<code value="CodeableConcept" />
</type>
</element>
<element id="Extension.extension:reference">
<path value="Extension.extension" />
<sliceName value="reference" />
<short value="Who or what participated in the activities related to the family member history." />
<definition value="The reference for the supporting information in the diagnostic report." />
<min value="1" />
<max value="1" />
</element>
<element id="Extension.extension:reference.url">
<path value="Extension.extension.url" />
<fixedUri value="reference" />
</element>
<element id="Extension.extension:reference.value[x]">
<path value="Extension.extension.value[x]" />
<min value="1" />
<max value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Procedure" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport" />
</type>
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<max value="0" />
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-DiagnosticReportSupportingInfo",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo",
"version": "1.0.1",
"name": "ExtensionUKCoreDiagnosticReportSupportingInfo",
"title": "Extension UK Core Diagnostic Report Supporting Info",
"status": "active",
"date": "2025-02-11",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "An extension to support adding additional info supporting the diagnostic report.",
"purpose": "This is a Pathology use case to support the backporting of R5 functionality to support adding additional supporting information that was used in the creation of the diagnostic report.",
"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.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "DiagnosticReport"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Additional information supporting the diagnostic report.",
"definition": "This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report."
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"rules": "open"
},
"min": 1
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "Supporting information role code.",
"definition": "The code value for the role of the supporting information in the diagnostic report.",
"min": 1,
"max": "1",
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0936"
}
},
{
"id": "Extension.extension:type.url",
"path": "Extension.extension.url",
"fixedUri": "type"
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Extension.extension:reference",
"path": "Extension.extension",
"sliceName": "reference",
"short": "Who or what participated in the activities related to the family member history.",
"definition": "The reference for the supporting information in the diagnostic report.",
"min": 1,
"max": "1"
},
{
"id": "Extension.extension:reference.url",
"path": "Extension.extension.url",
"fixedUri": "reference"
},
{
"id": "Extension.extension:reference.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
]
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"max": "0"
}
]
}
}

Extension-UKCore-ObservationBodyStructure

An extension to support adding a BodyStructure on an Observation.

Tree View

id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueReferenceReference(BodyStructure)

Table View

Extension..1
Extension.url..
Extension.value[x]Reference(BodyStructure)1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-ObservationBodyStructure" />
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure" />
<version value="1.0.0" />
<name value="ExtensionUKCoreObservationBodyStructure" />
<title value="Extension UK Core Observation Body Structure" />
<status value="active" />
<date value="2023-12-12" />
<publisher value="HL7 UK" />
<contact>
<name value="HL7 UK" />
<telecom>
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="An extension to support adding a BodyStructure on an Observation." />
<purpose value="This is a Pathology use case to support the backporting of R5 functionality to support adding a BodyStructure to an Observation." />
<copyright value="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." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="Observation" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<short value="Observed body structure." />
<definition value="Indicates the body structure on the subject's body where the observation was made (i.e. the target site)." />
<max value="1" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<min value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/BodyStructure" />
</type>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-ObservationBodyStructure",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure",
"version": "1.0.0",
"name": "ExtensionUKCoreObservationBodyStructure",
"title": "Extension UK Core Observation Body Structure",
"status": "active",
"date": "2023-12-12",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "An extension to support adding a BodyStructure on an Observation.",
"purpose": "This is a Pathology use case to support the backporting of R5 functionality to support adding a BodyStructure to an Observation.",
"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.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Observation"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Observed body structure.",
"definition": "Indicates the body structure on the subject's body where the observation was made (i.e. the target site).",
"max": "1"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/BodyStructure"
]
}
]
}
]
}
}

Extension-UKCore-ObservationOrganizer

An extenstion to indicate whether an Observation is being used to represent a test group i.e. a test battery, panel or profile. This extension mirrors the organizer data element introduced in FHIR R6. Refer to the description of Observation.organizer in the base FHIR R6 Specification (Ballot - 3rd Draft) for more details.

Tree View

id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueBooleanboolean

Table View

Extension..1
Extension.url..
Extension.value[x]boolean1..1

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-ObservationOrganizer" />
<url value="http://hl7.org/fhir/6.0/StructureDefinition/extension-Observation.organizer" />
<version value="0.0.1" />
<name value="ExtensionUKCoreObservationOrganizer" />
<title value="Extension UK Core Observation Organizer" />
<status value="draft" />
<date value="2025-08-05" />
<publisher value="HL7 UK" />
<contact>
<name value="HL7 UK" />
<telecom>
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="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)." />
<purpose value="This is a Pathology use case to support the backporting of R6 functionality." />
<copyright value="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." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="Observation" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<max value="1" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/6.0/StructureDefinition/extension-Observation.organizer" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<min value="1" />
<max value="1" />
<type>
<code value="boolean" />
</type>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-ObservationOrganizer",
"url": "http://hl7.org/fhir/6.0/StructureDefinition/extension-Observation.organizer",
"version": "0.0.1",
"name": "ExtensionUKCoreObservationOrganizer",
"title": "Extension UK Core Observation Organizer",
"status": "draft",
"date": "2025-08-05",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"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).",
"purpose": "This is a Pathology use case to support the backporting of R6 functionality.",
"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.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Observation"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"max": "1"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/6.0/StructureDefinition/extension-Observation.organizer"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
}
]
}
}

Extension-UKCore-ObservationTriggeredBy

This extension supports the sharing of the Observation(s) that triggered the performance of the main observation.

Tree View

id0..1string
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueReferenceReference(Observation)
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueCodecode
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueStringstring
url1..1uriFixed Value

Table View

Extension..
Extension.extension2..
Extension.extension:observation1..1
Extension.extension:observation.extension..0
Extension.extension:observation.url..
Extension.extension:observation.value[x]Reference(Observation)1..
Extension.extension:type1..1
Extension.extension:type.extension..0
Extension.extension:type.url..
Extension.extension:type.value[x]code1..
Extension.extension:reason..1
Extension.extension:reason.extension..0
Extension.extension:reason.url..
Extension.extension:reason.value[x]string1..
Extension.url..
Extension.value[x]..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-ObservationTriggeredBy" />
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" />
<version value="1.1.0" />
<name value="ExtensionUKCoreObservationTriggeredBy" />
<title value="Extension UK Core Observation Triggered By" />
<status value="active" />
<date value="2023-12-12" />
<publisher value="HL7 UK" />
<contact>
<name value="HL7 UK" />
<telecom>
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="This extension supports the sharing of the observation(s) that triggered the performance of the main observation." />
<purpose value="This is a Pathology use case to backport R5 functionality to identify the observation(s) that triggered the performance of this observation." />
<copyright value="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." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="Observation" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<short value="Triggering observation(s)" />
<definition value="Identifies the observation(s) that triggered the performance of this observation." />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<min value="2" />
</element>
<element id="Extension.extension:observation">
<path value="Extension.extension" />
<sliceName value="observation" />
<short value="Triggering observation" />
<definition value="Reference to the triggering observation." />
<min value="1" />
<max value="1" />
</element>
<element id="Extension.extension:observation.extension">
<path value="Extension.extension.extension" />
<max value="0" />
</element>
<element id="Extension.extension:observation.url">
<path value="Extension.extension.url" />
<fixedUri value="observation" />
</element>
<element id="Extension.extension:observation.value[x]">
<path value="Extension.extension.value[x]" />
<min value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" />
</type>
</element>
<element id="Extension.extension:type">
<path value="Extension.extension" />
<sliceName value="type" />
<short value="reflex | repeat | re-run" />
<definition value="The type of trigger. Reflex | Repeat | Re-run." />
<min value="1" />
<max value="1" />
<binding>
<strength value="required" />
<valueSet value="http://hl7.org/fhir/ValueSet/observation-triggeredbytype" />
</binding>
</element>
<element id="Extension.extension:type.extension">
<path value="Extension.extension.extension" />
<max value="0" />
</element>
<element id="Extension.extension:type.url">
<path value="Extension.extension.url" />
<fixedUri value="type" />
</element>
<element id="Extension.extension:type.value[x]">
<path value="Extension.extension.value[x]" />
<min value="1" />
<type>
<code value="code" />
</type>
</element>
<element id="Extension.extension:reason">
<path value="Extension.extension" />
<sliceName value="reason" />
<short value="Reason that the observation was triggered" />
<definition value="Provides the reason why this observation was performed as a result of the observation(s) referenced." />
<max value="1" />
</element>
<element id="Extension.extension:reason.extension">
<path value="Extension.extension.extension" />
<max value="0" />
</element>
<element id="Extension.extension:reason.url">
<path value="Extension.extension.url" />
<fixedUri value="reason" />
</element>
<element id="Extension.extension:reason.value[x]">
<path value="Extension.extension.value[x]" />
<min value="1" />
<type>
<code value="string" />
</type>
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<max value="0" />
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-ObservationTriggeredBy",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy",
"version": "1.1.0",
"name": "ExtensionUKCoreObservationTriggeredBy",
"title": "Extension UK Core Observation Triggered By",
"status": "active",
"date": "2023-12-12",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "This extension supports the sharing of the observation(s) that triggered the performance of the main observation.",
"purpose": "This is a Pathology use case to backport R5 functionality to identify the observation(s) that triggered the performance of this observation.",
"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.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Observation"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Triggering observation(s)",
"definition": "Identifies the observation(s) that triggered the performance of this observation."
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"min": 2
},
{
"id": "Extension.extension:observation",
"path": "Extension.extension",
"sliceName": "observation",
"short": "Triggering observation",
"definition": "Reference to the triggering observation.",
"min": 1,
"max": "1"
},
{
"id": "Extension.extension:observation.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:observation.url",
"path": "Extension.extension.url",
"fixedUri": "observation"
},
{
"id": "Extension.extension:observation.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Observation"
]
}
]
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "reflex | repeat | re-run",
"definition": "The type of trigger. Reflex | Repeat | Re-run.",
"min": 1,
"max": "1",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/observation-triggeredbytype"
}
},
{
"id": "Extension.extension:type.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:type.url",
"path": "Extension.extension.url",
"fixedUri": "type"
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "code"
}
]
},
{
"id": "Extension.extension:reason",
"path": "Extension.extension",
"sliceName": "reason",
"short": "Reason that the observation was triggered",
"definition": "Provides the reason why this observation was performed as a result of the observation(s) referenced.",
"max": "1"
},
{
"id": "Extension.extension:reason.extension",
"path": "Extension.extension.extension",
"max": "0"
},
{
"id": "Extension.extension:reason.url",
"path": "Extension.extension.url",
"fixedUri": "reason"
},
{
"id": "Extension.extension:reason.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"max": "0"
}
]
}
}

Extension-UKCore-SpecimenCollectionCollector

This extension allows the referencing of Patient and RelatedPerson within Specimen.collection.

Tree View

id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueReferenceReference(Patient | RelatedPerson)

Table View

Extension..
Extension.url..
Extension.value[x]Reference(Patient | RelatedPerson)1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-SpecimenCollectionCollector" />
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector" />
<version value="1.2.0" />
<name value="ExtensionUKCoreSpecimenCollectionCollector" />
<title value="Extension UK Core Specimen Collection Collector" />
<status value="active" />
<date value="2023-12-12" />
<publisher value="HL7 UK" />
<contact>
<name value="HL7 UK" />
<telecom>
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="Allows the referencing of Patient and RelatedPerson within Specimen.collection." />
<purpose value="This is a use case from Genomics to backport R5 functionality extending the referencing of Specimen.collection.collector to include Patient and RelatedPerson" />
<copyright value="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." />
<fhirVersion value="4.0.1" />
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="Specimen.collection" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<short value="Person who collected the specimen." />
<definition value="Person who collected the specimen." />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<short value="Person who collected the specimen." />
<min value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
</type>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-SpecimenCollectionCollector",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector",
"version": "1.2.0",
"name": "ExtensionUKCoreSpecimenCollectionCollector",
"title": "Extension UK Core Specimen Collection Collector",
"status": "active",
"date": "2023-12-12",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "Allows the referencing of Patient and RelatedPerson within Specimen.collection.",
"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.",
"fhirVersion": "4.0.1",
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Specimen.collection"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Person who collected the specimen.",
"definition": "Person who collected the specimen."
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Person who collected the specimen.",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"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 refsets in the UKCore-Observation-Lab.code element slicing.

Tree View

id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueUriuri

Table View

Extension0..1
Extension.idstring0..1
Extension.extensionExtension0..0
Extension.urluri1..1
Extension.value[x]uri1..1

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="valueset-reference" />
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="vocab" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="1" />
</extension>
<url value="http://hl7.org/fhir/StructureDefinition/valueset-reference" />
<version value="4.0.1" />
<name value="reference" />
<status value="draft" />
<date value="2019-11-01T09:29:23+11:00" />
<publisher value="HL7" />
<description value="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." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="v2" />
<uri value="http://hl7.org/v2" />
<name value="HL7 v2 Mapping" />
</mapping>
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="Coding" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<snapshot>
<element id="Extension">
<path value="Extension" />
<short value="Url of Value set the code was chosen from" />
<definition value="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 value="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." />
<min value="0" />
<max value="1" />
<base>
<path value="Extension" />
<min value="0" />
<max value="*" />
</base>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<mapping>
<identity value="v2" />
<map value="CWE." />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD.valueSet/CD.valueSetVersion" />
</mapping>
</element>
<element id="Extension.id">
<path value="Extension.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Extension" />
<definition value="An Extension" />
<min value="0" />
<max value="0" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<representation value="xmlAttr" />
<short value="identifies the meaning of the extension" />
<definition value="Source of the definition for the extension code - a logical name or a URL." />
<comment value="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." />
<min value="1" />
<max value="1" />
<base>
<path value="Extension.url" />
<min value="1" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<fixedUri value="http://hl7.org/fhir/StructureDefinition/valueset-reference" />
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<short value="Value of extension" />
<definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list)." />
<min value="1" />
<max value="1" />
<base>
<path value="Extension.value[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
</snapshot>
<differential>
<element id="Extension">
<path value="Extension" />
<short value="Url of Value set the code was chosen from" />
<definition value="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 value="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." />
<min value="0" />
<max value="1" />
<isModifier value="false" />
<mapping>
<identity value="v2" />
<map value="CWE." />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD.valueSet/CD.valueSetVersion" />
</mapping>
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<max value="0" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://hl7.org/fhir/StructureDefinition/valueset-reference" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<min value="1" />
<type>
<code value="uri" />
</type>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "valueset-reference",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "vocab"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/valueset-reference",
"version": "4.0.1",
"name": "reference",
"status": "draft",
"date": "2019-11-01T09:29:23+11:00",
"publisher": "HL7",
"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.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Coding"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Url of Value set the code was chosen from",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "v2",
"map": "CWE."
},
{
"identity": "rim",
"map": "CD.valueSet/CD.valueSetVersion"
}
]
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-reference",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Url of Value set the code was chosen from",
"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.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "v2",
"map": "CWE."
},
{
"identity": "rim",
"map": "CD.valueSet/CD.valueSetVersion"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-reference"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 1,
"type": [
{
"code": "uri"
}
]
}
]
}
}

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.hl7.org.uk/ValueSet/UKCore-PathologyBoundedCodeListObservables"
            }
        ],
        "system": "http://snomed.info/sct",
        "code": "1000821000000103",
        "display": "Serum albumin level"
        },
        {
        "extension": [
            {
            "url": "http://hl7.org/fhir/StructureDefinition/valueset-reference",
            "valueUri": "https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineObservables"
            }
        ],
        "system": "http://snomed.info/sct",
        "code": "1105861000000106",
        "display": "Albumin mass concentration in serum"
        }
        ]
    }


<code>
    <coding>
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-reference">
            <valueUri value="https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyBoundedCodeListObservables" />
        </extension>
        <system value="http://snomed.info/sct" />
        <code value="1000821000000103" />
        <display value="Serum albumin level" />
    </coding>
    <coding>
        <extension url="http://hl7.org/fhir/StructureDefinition/valueset-reference">
            <valueUri value="https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineObservables" />
        </extension>
        <system value="http://snomed.info/sct" />
        <code value="1105861000000106" />
        <display value="Albumin mass concentration in serum" />
    </coding>
</code>