Extension Library
Extension library (draft)
Clinical and Technical Assurance Sprint 4 Extensions
This libruary contains the Extensions which are proposed to be included in the UK Core following sprint 4 of Clinical and Technical Assurance. These have a status of draft and a low maturity level. For more information on maturity levels see the section in the active Extensions libruary below. These are currently not hard-coded in the associated profiles and as part of the C&TA process may be rejected for inclusion in the UK Core active Extensions libruary.
The Extension Library(active) contains the extensions which have been previously been released in the UK Core 0.1.0 STU1 release.
StructureDefinition Extension-UKCoreAdmissionMethod
An extension to support the method by which an individual was admitted into hospital.
Purpose
This extension has been developed to demonstrate the representation of the method by which a patient was admitted to hospital.
| Context of Use | |
|---|---|
| Use on element | Encounter |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-AdmissionMethod" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod" /> <version value="2.1.0" /> <name value="ExtensionUKCoreAdmissionMethod" /> <title value="Extension UK Core Admission Method" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support the method by which an individual was admitted into hospital." /> <purpose value="This extension extends the Encounter Resource to support the exchange of information representating the method by which a patient was admitted to hospital, which is currently not supported by the FHIR standard." /> <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="Encounter" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An extension to record how a patient was admitted to hospital" /> <definition value="An extension to record how a patient was admitted to hospital." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The method by which a patient was admitted to hospital" /> <definition value="The method by which a patient was admitted to hospital." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="preferred" /> <description value="The method by which a patient was admitted to hospital" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AdmissionMethod" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-AdmissionMethod", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod", "version": "2.1.0", "name": "ExtensionUKCoreAdmissionMethod", "title": "Extension UK Core Admission Method", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the method by which an individual was admitted into hospital.", "purpose": "This extension extends the Encounter Resource to support the exchange of information representating the method by which a patient was admitted to hospital, which is currently not supported by the FHIR standard.", "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": "Encounter" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension to record how a patient was admitted to hospital", "definition": "An extension to record how a patient was admitted to hospital.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The method by which a patient was admitted to hospital", "definition": "The method by which a patient was admitted to hospital.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "description": "The method by which a patient was admitted to hospital", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AdmissionMethod" } } ] } }
Examples
No Example is currently available for this extensionStructureDefinition Extension-UKCoreAnaestheticIssues
An extension to support recording of details of any adverse reaction to any anaesthetic agents including local anaesthesia and problematic intubation, transfusion reaction, etc.
Purpose
TBA
| Context of Use | |
|---|---|
| Use on element | Procedure |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| valueReference | Reference(UK Core Condition) |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| valueReference | Reference(UK Core Condition) |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| valueReference | Reference(UK Core Condition) |
Table View
| Extension | .. | |
| Extension.url | .. | |
| Extension.value[x] | CodeableConcept, Reference(UK Core Condition) | 1.. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-AnaestheticIssues" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AnaestheticIssues" /> <version value="2.1.0" /> <name value="ExtensionUKCoreAnaestheticIssues" /> <title value="Extension UK Core Anaesthetic Issues" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support recording of details of any adverse reaction to any anaesthetic agents including local anaesthesia and problematic intubation, transfusion reaction, etc." /> <purpose value="This extension extends the Procedure Resource to support the exchange of information supporting the recording of details of any adverse reaction to any anaesthetic agents (including local anaesthesia and problematic intubation, transfusion reaction, etc.), which is currently not supported by the FHIR standard." /> <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="Procedure" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Details of any adverse reaction to any anaesthetic agents" /> <definition value="Details of any adverse reaction to any anaesthetic agents." /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AnaestheticIssues" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Snomed Concept or a link to the Condition resource" /> <definition value="Snomed Concept or a link to the Condition resource." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" /> </type> <binding> <strength value="extensible" /> <description value="A code from the SNOMED Clinical Terminology UK with the expression (<404684003 |Clinical finding| OR &lt; 413350009 |Finding with explicit context| OR <272379006 |Event|)" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ConditionCode" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-AnaestheticIssues", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AnaestheticIssues", "version": "2.1.0", "name": "ExtensionUKCoreAnaestheticIssues", "title": "Extension UK Core Anaesthetic Issues", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support recording of details of any adverse reaction to any anaesthetic agents including local anaesthesia and problematic intubation, transfusion reaction, etc.", "purpose": "This extension extends the Procedure Resource to support the exchange of information supporting the recording of details of any adverse reaction to any anaesthetic agents (including local anaesthesia and problematic intubation, transfusion reaction, etc.), which is currently not supported by the FHIR standard.", "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": "Procedure" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Details of any adverse reaction to any anaesthetic agents", "definition": "Details of any adverse reaction to any anaesthetic agents." }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AnaestheticIssues" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Snomed Concept or a link to the Condition resource", "definition": "Snomed Concept or a link to the Condition resource.", "min": 1, "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" ] } ], "binding": { "strength": "extensible", "description": "A code from the SNOMED Clinical Terminology UK with the expression (<404684003 |Clinical finding| OR < 413350009 |Finding with explicit context| OR <272379006 |Event|)", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ConditionCode" } } ] } }
Examples
No Example is currently available for this extensionStructureDefinition Extension-UKCoreCareSettingType
The care setting type provides the originating care setting for the document.
Purpose
This extension extends the Composition resource to support the exchange of information about the originating care setting for the document which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Composition |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-CareSettingType" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType" /> <version value="2.1.0" /> <name value="ExtensionUKCoreCareSettingType" /> <title value="Extension UK Core Care Setting Type" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support the type of care setting associated with a composition or a list." /> <purpose value="This extension extends the Composition and List resources to support the exchange of information about the type of care setting associated with the resource being extended, which is currently not supported by the FHIR standard." /> <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="Composition" /> </context> <context> <type value="element" /> <expression value="List" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="The type of care setting associated with a composition or a list." /> <definition value="The type of care setting associated with a composition or a list." /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The type of care setting." /> <definition value="The type of care setting expressed as a code and display value defined in the SNOMED CT UK Refset of the valueSet used." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <description value="Correspondence care setting type" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-CareSettingType", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType", "version": "2.1.0", "name": "ExtensionUKCoreCareSettingType", "title": "Extension UK Core Care Setting Type", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the type of care setting associated with a composition or a list.", "purpose": "This extension extends the Composition and List resources to support the exchange of information about the type of care setting associated with the resource being extended, which is currently not supported by the FHIR standard.", "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": "Composition" }, { "type": "element", "expression": "List" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The type of care setting associated with a composition or a list.", "definition": "The type of care setting associated with a composition or a list." }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The type of care setting.", "definition": "The type of care setting expressed as a code and display value defined in the SNOMED CT UK Refset of the valueSet used.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "description": "Correspondence care setting type", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType" } } ] } }
StructureDefinition Extension-UKCoreClinicalSetting
An extension to support the clinical setting associated with a list.
Purpose
This extension has been developed to represent the clinical setting of a List.
| Context of Use | |
|---|---|
| Use on element | List |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-ClinicalSetting" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ClinicalSetting" /> <version value="2.0.0" /> <name value="ExtensionUKCoreClinicalSetting" /> <title value="Extension UK Core Clinical Setting" /> <status value="retired" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support the clinical setting associated with a list." /> <purpose value="This extension has been developed to represent the clinical setting of a List." /> <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="List" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="To record the clinical setting of a list" /> <definition value="To record the clinical setting of a list." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ClinicalSetting" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The clinical setting of a list" /> <definition value="The clinical setting of a list." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <description value="A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-ClinicalSetting", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ClinicalSetting", "version": "2.0.0", "name": "ExtensionUKCoreClinicalSetting", "title": "Extension UK Core Clinical Setting", "status": "retired", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the clinical setting associated with a list.", "purpose": "This extension has been developed to represent the clinical setting of a List.", "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": "List" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "To record the clinical setting of a list", "definition": "To record the clinical setting of a list.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ClinicalSetting" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The clinical setting of a list", "definition": "The clinical setting of a list.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "description": "A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType" } } ] } }
Examples
No Example is currently available for this extensionStructureDefinition Extension-UKCoreConditionEpisode
This supports the episodicity status of a condition.
Purpose
This extension extends the Condition resource to support the exchange of information describing the episodicity status of a condition, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Condition |
Differential View
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-ConditionEpisode" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode" /> <version value="2.2.0" /> <name value="ExtensionUKCoreConditionEpisode" /> <title value="Extension UK Core Condition Episode" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="This supports the episodicity status of a condition." /> <purpose value="This extension extends the Condition resource to support the exchange of information describing the episodicity status of a condition, which is currently not supported by the FHIR standard." /> <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="Condition" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="The episodicity status of a condition" /> <definition value="The episodicity status of a condition." /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The episodicity value of the condition." /> <definition value="The episodicity value of the condition can be represented by one of the following codes: \nfirst | new | review | end" /> <min value="1" /> <type> <code value="code" /> </type> <binding> <strength value="extensible" /> <description value="A ValueSet to identify the episodicity of a condition." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ConditionEpisodicity" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-ConditionEpisode", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode", "version": "2.2.0", "name": "ExtensionUKCoreConditionEpisode", "title": "Extension UK Core Condition Episode", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "This supports the episodicity status of a condition.", "purpose": "This extension extends the Condition resource to support the exchange of information describing the episodicity status of a condition, which is currently not supported by the FHIR standard.", "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": "Condition" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The episodicity status of a condition", "definition": "The episodicity status of a condition." }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The episodicity value of the condition.", "definition": "The episodicity value of the condition can be represented by one of the following codes: \nfirst | new | review | end", "min": 1, "type": [ { "code": "code" } ], "binding": { "strength": "extensible", "description": "A ValueSet to identify the episodicity of a condition.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ConditionEpisodicity" } } ] } }
Examples
No Example is currently available for this extensionStructureDefinition Extension-UKCoreDischargeMethod
An extension to support the method of discharge from a hospital.
Purpose
This extension has been developed to demonstrate the representation of the method by which a patient was discharged from hospital.
| Context of Use | |
|---|---|
| Use on element | Encounter |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-DischargeMethod" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod" /> <version value="2.1.0" /> <name value="ExtensionUKCoreDischargeMethod" /> <title value="Extension UK Core Discharge Method" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support the method of discharge from a hospital." /> <purpose value="This extension extends the Encounter Resource to support the exchange of information representating the method by which a patient was discharged from hospital which is currently not supported by the FHIR standard." /> <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="Encounter" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An extension to record the method of discharge from hospital" /> <definition value="An extension to record the method of discharge from hospital." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The method by which a patient was discharged from hospital" /> <definition value="The method by which a patient was discharged from hospital." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="preferred" /> <description value="The method by which a patient was discharged from hospital" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-DischargeMethod" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-DischargeMethod", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod", "version": "2.1.0", "name": "ExtensionUKCoreDischargeMethod", "title": "Extension UK Core Discharge Method", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the method of discharge from a hospital.", "purpose": "This extension extends the Encounter Resource to support the exchange of information representating the method by which a patient was discharged from hospital which is currently not supported by the FHIR standard.", "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": "Encounter" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension to record the method of discharge from hospital", "definition": "An extension to record the method of discharge from hospital.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The method by which a patient was discharged from hospital", "definition": "The method by which a patient was discharged from hospital.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "description": "The method by which a patient was discharged from hospital", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-DischargeMethod" } } ] } }
Examples
No Example is currently available for this extensionStructureDefinition Extension-EmergencyCareDischargeStatus
An extension to support the status of an individual on discharge from an Emergency Care Department.
Purpose
This extension has been developed to demonstrate the representation of the status of a patient on discharge from an Emergency Care Department.
| Context of Use | |
|---|---|
| Use on element | Encounter |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-EmergencyCareDischargeStatus" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus" /> <version value="2.1.0" /> <name value="ExtensionUKCoreEmergencyCareDischargeStatus" /> <title value="Extension UK Core Emergency Care Discharge Status" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support the status of an individual on discharge from an Emergency Care Department." /> <purpose value="This extension extends the Encounter Resource to support the exchange of information representing the status of a patient on discharge from an Emergency Care Department, which is currently not supported by the FHIR standard." /> <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="Encounter" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An extension used indicate the status of a patient on discharge from an Emergency Care Department" /> <definition value="An extension used indicate the status of a patient on discharge from an Emergency Care Department" /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The status of a patient on discharge from an Emergency Care Department" /> <definition value="The status of a patient on discharge from an Emergency Care Department." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="preferred" /> <description value="The status of a patient on discharge from an Emergency Care Department" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-EmergencyCareDischargeStatus" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-EmergencyCareDischargeStatus", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus", "version": "2.1.0", "name": "ExtensionUKCoreEmergencyCareDischargeStatus", "title": "Extension UK Core Emergency Care Discharge Status", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the status of an individual on discharge from an Emergency Care Department.", "purpose": "This extension extends the Encounter Resource to support the exchange of information representing the status of a patient on discharge from an Emergency Care Department, which is currently not supported by the FHIR standard.", "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": "Encounter" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension used indicate the status of a patient on discharge from an Emergency Care Department", "definition": "An extension used indicate the status of a patient on discharge from an Emergency Care Department", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The status of a patient on discharge from an Emergency Care Department", "definition": "The status of a patient on discharge from an Emergency Care Department.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "description": "The status of a patient on discharge from an Emergency Care Department", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-EmergencyCareDischargeStatus" } } ] } }
Examples
No Example is currently available for this extensionStructureDefinition Extension-EncounterTransport
An extension to support the transport used by the individual who is the subject of an encounter.
Purpose
This extension has been developed to demonstrate the representation of the transport used by the subject for an encounter.
| Context of Use | |
|---|---|
| Use on element | Encounter |
Snapshot View
| Extension | I | Extension | |
| extension | I | 1..* | Extension |
| transportType | I | 1..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valueCodeableConcept | CodeableConcept | ||
| transportPeriod | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valuePeriod | Period | ||
| reasonForTransport | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Differential View
| Extension | I | Extension | |
| extension | I | 1..* | Extension |
| transportType | I | 1..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valueCodeableConcept | CodeableConcept | ||
| transportPeriod | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valuePeriod | Period | ||
| reasonForTransport | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Hybrid View
| Extension | I | Extension | |
| extension | I | 1..* | Extension |
| transportType | I | 1..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valueCodeableConcept | CodeableConcept | ||
| transportPeriod | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valuePeriod | Period | ||
| reasonForTransport | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Table View
| Extension | ..1 | |
| Extension.extension | 1.. | |
| Extension.extension | 1..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | CodeableConcept | .. |
| Extension.extension | 0..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | Period | .. |
| Extension.extension | 0..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | string | .. |
| Extension.url | .. | |
| Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-EncounterTransport" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EncounterTransport" /> <version value="2.0.0" /> <name value="ExtensionUKCoreEncounterTransport" /> <title value="Extension UK Core Encounter Transport" /> <status value="retired" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support the transport used by the individual who is the subject of an encounter." /> <purpose value="This extension has been developed to demonstrate the representation of the transport used by the subject for an encounter." /> <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="Encounter" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Encounter transport" /> <definition value="Encounter transport." /> <max value="1" /> </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:transportType"> <path value="Extension.extension" /> <sliceName value="transportType" /> <short value="The type of transport used" /> <definition value="The type of transport used." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:transportType.url"> <path value="Extension.extension.url" /> <fixedUri value="transportType" /> </element> <element id="Extension.extension:transportType.value[x]"> <path value="Extension.extension.value[x]" /> <short value="The type of transport used" /> <definition value="The type of transport used." /> <type> <code value="CodeableConcept" /> </type> </element> <element id="Extension.extension:transportPeriod"> <path value="Extension.extension" /> <sliceName value="transportPeriod" /> <short value="Period of time during which the transport was used" /> <definition value="Period of time during which the transport was used." /> <min value="0" /> <max value="1" /> </element> <element id="Extension.extension:transportPeriod.url"> <path value="Extension.extension.url" /> <fixedUri value="transportPeriod" /> </element> <element id="Extension.extension:transportPeriod.value[x]"> <path value="Extension.extension.value[x]" /> <short value="Period of time during which the transport was used" /> <definition value="Period of time during which the transport was used." /> <type> <code value="Period" /> </type> </element> <element id="Extension.extension:reasonForTransport"> <path value="Extension.extension" /> <sliceName value="reasonForTransport" /> <short value="The reason the transport was needed" /> <definition value="The reason the transport was needed." /> <min value="0" /> <max value="1" /> </element> <element id="Extension.extension:reasonForTransport.url"> <path value="Extension.extension.url" /> <fixedUri value="reasonForTransport" /> </element> <element id="Extension.extension:reasonForTransport.value[x]"> <path value="Extension.extension.value[x]" /> <short value="The reason the transport was needed" /> <definition value="The reason the transport was needed." /> <type> <code value="string" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EncounterTransport" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-EncounterTransport", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EncounterTransport", "version": "2.0.0", "name": "ExtensionUKCoreEncounterTransport", "title": "Extension UK Core Encounter Transport", "status": "retired", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the transport used by the individual who is the subject of an encounter.", "purpose": "This extension has been developed to demonstrate the representation of the transport used by the subject for an encounter.", "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": "Encounter" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Encounter transport", "definition": "Encounter transport.", "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 1 }, { "id": "Extension.extension:transportType", "path": "Extension.extension", "sliceName": "transportType", "short": "The type of transport used", "definition": "The type of transport used.", "min": 1, "max": "1" }, { "id": "Extension.extension:transportType.url", "path": "Extension.extension.url", "fixedUri": "transportType" }, { "id": "Extension.extension:transportType.value[x]", "path": "Extension.extension.value[x]", "short": "The type of transport used", "definition": "The type of transport used.", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Extension.extension:transportPeriod", "path": "Extension.extension", "sliceName": "transportPeriod", "short": "Period of time during which the transport was used", "definition": "Period of time during which the transport was used.", "min": 0, "max": "1" }, { "id": "Extension.extension:transportPeriod.url", "path": "Extension.extension.url", "fixedUri": "transportPeriod" }, { "id": "Extension.extension:transportPeriod.value[x]", "path": "Extension.extension.value[x]", "short": "Period of time during which the transport was used", "definition": "Period of time during which the transport was used.", "type": [ { "code": "Period" } ] }, { "id": "Extension.extension:reasonForTransport", "path": "Extension.extension", "sliceName": "reasonForTransport", "short": "The reason the transport was needed", "definition": "The reason the transport was needed.", "min": 0, "max": "1" }, { "id": "Extension.extension:reasonForTransport.url", "path": "Extension.extension.url", "fixedUri": "reasonForTransport" }, { "id": "Extension.extension:reasonForTransport.value[x]", "path": "Extension.extension.value[x]", "short": "The reason the transport was needed", "definition": "The reason the transport was needed.", "type": [ { "code": "string" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EncounterTransport" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Examples
No Example is currently available for this extensionStructureDefinition Extension-ListWarningCode
An extension to support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit.
Purpose
This extension has been developed to demonstrate the representation of warnings that the list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit.
| Context of Use | |
|---|---|
| Use on element | List |
Differential View
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-ListWarningCode" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode" /> <version value="2.1.0" /> <name value="ExtensionUKCoreListWarningCode" /> <title value="Extension UK Core List Warning Code" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit." /> <purpose value="This extension extends the List Resource to support the exchange of information representing warnings that the list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit, which is currently not supported by the FHIR standard." /> <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="List" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="To capture warnings that the list may be incomplete" /> <definition value="To capture warnings that the list may be incomplete." /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="To capture warnings that the list may be incomplete" /> <definition value="To capture warnings that the list may be incomplete." /> <min value="1" /> <type> <code value="code" /> </type> <binding> <strength value="extensible" /> <description value="To identify the reason a list may be incomplete." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ListWarningCode" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-ListWarningCode", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode", "version": "2.1.0", "name": "ExtensionUKCoreListWarningCode", "title": "Extension UK Core List Warning Code", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit.", "purpose": "This extension extends the List Resource to support the exchange of information representing warnings that the list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit, which is currently not supported by the FHIR standard.", "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": "List" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "To capture warnings that the list may be incomplete", "definition": "To capture warnings that the list may be incomplete." }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ListWarningCode" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "To capture warnings that the list may be incomplete", "definition": "To capture warnings that the list may be incomplete.", "min": 1, "type": [ { "code": "code" } ], "binding": { "strength": "extensible", "description": "To identify the reason a list may be incomplete.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ListWarningCode" } } ] } }
Examples
No Example is currently available for this extensionStructureDefinition Extension-OutcomeofAttendance
An extension to support the outcome of an Outpatient attendance.
Purpose
This extension has been developed to demonstrate the representation of the outcome of an Outpatient attendance.
| Context of Use | |
|---|---|
| Use on element | Encounter |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-OutcomeOfAttendance" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance" /> <version value="2.1.0" /> <name value="ExtensionUKCoreOutcomeOfAttendance" /> <title value="Extension UK Core Outcome of Attendance" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support the outcome of an Outpatient attendance." /> <purpose value="This extension extends the Encounter Resource to support the exchange of information representing the outcome of an Outpatient attendance, which is currently not supported by the FHIR standard." /> <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="Encounter" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An extension to record the outcome of an outpatient attendance" /> <definition value="An extension to record the outcome of an outpatient attendance." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The outcome of an outpatient attendance" /> <definition value="The outcome of an outpatient attendance." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="preferred" /> <description value="The outcome of an outpatient attendance" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-OutcomeOfAttendance" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-OutcomeOfAttendance", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance", "version": "2.1.0", "name": "ExtensionUKCoreOutcomeOfAttendance", "title": "Extension UK Core Outcome of Attendance", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the outcome of an Outpatient attendance.", "purpose": "This extension extends the Encounter Resource to support the exchange of information representing the outcome of an Outpatient attendance, which is currently not supported by the FHIR standard.", "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": "Encounter" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension to record the outcome of an outpatient attendance", "definition": "An extension to record the outcome of an outpatient attendance.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The outcome of an outpatient attendance", "definition": "The outcome of an outpatient attendance.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "description": "The outcome of an outpatient attendance", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-OutcomeOfAttendance" } } ] } }
Examples
No Example is currently available for this extensionExtension Library(active)
This extension library contains all the extensions Clinically and Technically Assuranced for use with UK Core. The profiles are found in the Profiles Index. The table below lists all the current extensions and the context of use. The context of use column indicates the profile and /or element where the extension may be applied. The type column indicates whether the extension is an modifierExtension or not. The general rule is extensions can be ignored by receivers*. When a modifierExtension is received it MUST NOT be ignored as it modifies the meaning of the element or elements that contains it. Typically, this means information that qualifies or negates the primary meaning of the element that contains it.
For more information from HL7 about FHIR extensions.
For more information from HL7 about FHIR modifierExtensions.
*There may be specific use cases where this is not the case and the Domain Implementation Guidance associated with the use case should be consulted.
All the extensions have been assured as suitable for inclusion in the UK Core, however all extensions have been assigned a maturity level similar to the maturity levels described in the FHIR standard. This is intended to indicate how stable the extension is deemed to be, this is in addition to the publication status of the profile HL7 FHIR statuses of draft, active, retired and unknown.
| Maturity level | Definition |
|---|---|
| 0 | The Extension has been published on the current build. This Extension has had no formal review and therefore may have quality issues. It is published only to allow the review process to start |
| 1 | The Extension produces no warnings during the build process and has had a formal internal review by the UK Core development team |
| 2 | The Extension has been released for review to the UK FHIR community, any feedback received has been addressed as far as possible |
| 3 | The Extension has been presented for inclusion in the Technical and Clinical Assurance process |
| 4 | The Extension has completed the Technical and Clinical Assurance process and the status has been changed to active |
| 5 | The Extension has been presented for inclusion in the HL7 UK Ballot Process |
| 6 | The Extension has completed the HL7 UK Ballot process and is now deemed to be Normative |
Important note:
This Release 1 implementation guide only contains Extensions with a maturity level of 4 or more. Extensions that are at a earlier stage of development (maturity level of 0-2) are available in the HL7 FHIR® UK Core Profile Implementation Guide R4 (Draft)
The Extensions are rendered in several formats:
Further information from HL7 relating to extensibility is available.
The Extensions are rendered in several formats:
- Snapshot: a fully calculated form of the structure that is not dependent on any other structure
- Differential: this describes only the differences that the Extension makes relative to the structure definition (FHIR resource) they constrain
- Hybrid: a hybrid view of the snapshot and differential views
- Table: a tabular view of the Extension elements
- XML: a rendering of a XML view of the Extension
- JSON: a rendering of a JSON view of the Extension
Further information from HL7 relating to extensibility is available.
Important note:The Extensions listed below have been defined as UK Core extensions. Also included in this library are some HL7 common extensions which have been added to the UK Core profiles because they have been deemed to be "core" to UK FHIR data exchanges. These will have a page with guidance on usage in the UK and examples to illustrate usage. Note: implementers of UK Core may use any HL7 common extension from the HL7 standard regardless of whether the extension is included in this implemention guide. The list of common extensions in FHIR R4 is available in the HL7 extension registry.
For the current list of UK Core extensions under development refer to HL7 FHIR® UK Core Profile Implementation Guide R4 (Draft) Extension Libruary.
Implementers of the UK Core profiles may also create their own Extensions where required, but are encouraged to engage with the UK Core development process to get their extensions adopted into the UK Core for wider use by the UK FHIR Community.
For the current list of UK Core extensions under development refer to HL7 FHIR® UK Core Profile Implementation Guide R4 (Draft) Extension Libruary.
Release 0.1.0 Extensions included in this release
HL7 Common Extensions
The following HL7 extensions have been agreed as suitable to be included for use with the UK Core Profiles Index because the use case for an Extension is fully met by a pre-existing HL7 common Extension. All other HL7 common extensions may be used to extend the UK Core if required by the local implementation.
| HL7 Common Extension | Context of Use | Related Profile | modifierExtension |
|---|---|---|---|
| Common Extension patient-birthPlace | Patient | Profile UKCore-Patient | NO |
| Common Extension patient-birthTime | Patient.birthDate | Profile UKCore-Patient | NO |
| Common Extension patient-cadavericDonor | Patient | Profile UKCore-Patient | NO |
| Common Extension patient-InterpreterRequired | Patient | Profile UKCore-Patient | NO |
| Common Extension patient-religion | Patient | Profile UKCore-Patient | NO |
| Common Extension organization-period | organization | Profile UKCore-Organization | NO |
StructureDefinition Extension-UKCoreAddressKey
This carries an address key which will be included in an address.
Purpose
This extension extends the Address datatype to support the exchange of the type of address key and the address key value, which are currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Address |
Snapshot View
Differential View
Hybrid View
Table View
| Extension | .. | |
| Extension.extension | .. | |
| Extension.extension | 1..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | Coding | 1.. |
| Extension.extension | 1..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | string | 1.. |
| Extension.url | .. | |
| Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-AddressKey" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" /> <version value="2.1.0" /> <name value="ExtensionUKCoreAddressKey" /> <title value="Extension UK Core Address Key" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="This carries an address identifier which will be included in an address." /> <purpose value="This extension extends the Address datatype to support the exchange of the type of address identifier and the address identifier value, which are currently not supported by the FHIR standard." /> <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="Address" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An extension carrying the address key and type" /> <definition value="An extension carrying the address key and type." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Extension.extension:type"> <path value="Extension.extension" /> <sliceName value="type" /> <short value="Address Key Type" /> <definition value="To identify the type of Address Key recorded." /> <min value="1" /> <max value="1" /> </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]" /> <short value="Address Key Type" /> <definition value="To identify the type of Address Key recorded." /> <min value="1" /> <type> <code value="Coding" /> </type> <binding> <strength value="extensible" /> <description value="To identify the type of Address Key recorded" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AddressKeyType" /> </binding> </element> <element id="Extension.extension:value"> <path value="Extension.extension" /> <sliceName value="value" /> <short value="Address key value" /> <definition value="To record the value for the address key." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:value.url"> <path value="Extension.extension.url" /> <fixedUri value="value" /> </element> <element id="Extension.extension:value.value[x]"> <path value="Extension.extension.value[x]" /> <short value="Address key value" /> <definition value="To record the value for the address key." /> <min value="1" /> <type> <code value="string" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-AddressKey", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey", "version": "2.1.0", "name": "ExtensionUKCoreAddressKey", "title": "Extension UK Core Address Key", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "This carries an address identifier which will be included in an address.", "purpose": "This extension extends the Address datatype to support the exchange of the type of address identifier and the address identifier value, which are currently not supported by the FHIR standard.", "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": "Address" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension carrying the address key and type", "definition": "An extension carrying the address key and type." }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Extension.extension:type", "path": "Extension.extension", "sliceName": "type", "short": "Address Key Type", "definition": "To identify the type of Address Key recorded.", "min": 1, "max": "1" }, { "id": "Extension.extension:type.url", "path": "Extension.extension.url", "fixedUri": "type" }, { "id": "Extension.extension:type.value[x]", "path": "Extension.extension.value[x]", "short": "Address Key Type", "definition": "To identify the type of Address Key recorded.", "min": 1, "type": [ { "code": "Coding" } ], "binding": { "strength": "extensible", "description": "To identify the type of Address Key recorded", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AddressKeyType" } }, { "id": "Extension.extension:value", "path": "Extension.extension", "sliceName": "value", "short": "Address key value", "definition": "To record the value for the address key.", "min": 1, "max": "1" }, { "id": "Extension.extension:value.url", "path": "Extension.extension.url", "fixedUri": "value" }, { "id": "Extension.extension:value.value[x]", "path": "Extension.extension.value[x]", "short": "Address key value", "definition": "To record the value for the address key.", "min": 1, "type": [ { "code": "string" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Examples
Richard Smith - An example to illustrate how the address key information is carried in a patient example. Example UKCore-Patient-AddressKeyStructureDefinition Extension-UKCore-AllergyIntoleranceEnd
Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.
Purpose
This extension extends the AllergyIntolerance resource to support the exchange of information describing the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid, which is currently not supported by the FHIR standard.
Guidance
An optional extension to record the date and reason when the allergy was no longer clinically active.
If the clinicalStatus is active then this extension MUST be omitted.
If the clinicalStatus is inactive or resolved then the date and reason when the allergy was identified as no longer active should be populated.
| Context of Use | |
|---|---|
| Use on element | AllergyIntolerance |
Snapshot View
Differential View
Hybrid View
Table View
| Extension | ..1 | |
| Extension.extension | .. | |
| Extension.extension | ..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | dateTime | 1.. |
| Extension.extension | ..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | string | 1.. |
| Extension.url | .. | |
| Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-AllergyIntoleranceEnd" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" /> <version value="2.1.0" /> <name value="ExtensionUKCoreAllergyIntoleranceEnd" /> <title value="Extension UK Core Allergy Intolerance End" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid." /> <purpose value="This extension extends the AllergyIntolerance resource to support the exchange of information describing the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid, which is currently not supported by the FHIR standard." /> <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="AllergyIntolerance" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid." /> <definition value="Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid." /> <max value="1" /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Extension.extension:endDate"> <path value="Extension.extension" /> <sliceName value="endDate" /> <short value="The date the allergy or intolerance was recorded as no longer valid" /> <definition value="The date the allergy or intolerance was recorded as no longer valid." /> <max value="1" /> </element> <element id="Extension.extension:endDate.url"> <path value="Extension.extension.url" /> <fixedUri value="endDate" /> </element> <element id="Extension.extension:endDate.value[x]"> <path value="Extension.extension.value[x]" /> <short value="The date the allergy was recorded as no longer valid" /> <definition value="The date the allergy was recorded as no longer valid." /> <min value="1" /> <type> <code value="dateTime" /> </type> </element> <element id="Extension.extension:reasonEnded"> <path value="Extension.extension" /> <sliceName value="reasonEnded" /> <short value="The reason why the allergy or intolerance has been resolved" /> <definition value="The reason why the allergy or intolerance has been resolved." /> <max value="1" /> </element> <element id="Extension.extension:reasonEnded.url"> <path value="Extension.extension.url" /> <fixedUri value="reasonEnded" /> </element> <element id="Extension.extension:reasonEnded.value[x]"> <path value="Extension.extension.value[x]" /> <short value="The reason why the allergy or intolerance has been resolved" /> <definition value="The reason why the allergy or intolerance has been resolved." /> <min value="1" /> <type> <code value="string" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-AllergyIntoleranceEnd", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd", "version": "2.1.0", "name": "ExtensionUKCoreAllergyIntoleranceEnd", "title": "Extension UK Core Allergy Intolerance End", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.", "purpose": "This extension extends the AllergyIntolerance resource to support the exchange of information describing the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid, which is currently not supported by the FHIR standard.", "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": "AllergyIntolerance" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.", "definition": "Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.", "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Extension.extension:endDate", "path": "Extension.extension", "sliceName": "endDate", "short": "The date the allergy or intolerance was recorded as no longer valid", "definition": "The date the allergy or intolerance was recorded as no longer valid.", "max": "1" }, { "id": "Extension.extension:endDate.url", "path": "Extension.extension.url", "fixedUri": "endDate" }, { "id": "Extension.extension:endDate.value[x]", "path": "Extension.extension.value[x]", "short": "The date the allergy was recorded as no longer valid", "definition": "The date the allergy was recorded as no longer valid.", "min": 1, "type": [ { "code": "dateTime" } ] }, { "id": "Extension.extension:reasonEnded", "path": "Extension.extension", "sliceName": "reasonEnded", "short": "The reason why the allergy or intolerance has been resolved", "definition": "The reason why the allergy or intolerance has been resolved.", "max": "1" }, { "id": "Extension.extension:reasonEnded.url", "path": "Extension.extension.url", "fixedUri": "reasonEnded" }, { "id": "Extension.extension:reasonEnded.value[x]", "path": "Extension.extension.value[x]", "short": "The reason why the allergy or intolerance has been resolved", "definition": "The reason why the allergy or intolerance has been resolved.", "min": 1, "type": [ { "code": "string" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
StructureDefinition Extension-UKCore-BirthSex
An extension to support the patient's phenotypic sex at birth.
Purpose
This extension extends the Patient resource to support the exchange of the patient's phenotypic sex at birth information as a Code, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Patient |
Differential View
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-BirthSex" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" /> <version value="1.0.0" /> <name value="ExtensionUKCoreBirthSex" /> <title value="Extension UK Core Birth Sex" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="An extension to support the patient's phenotypic sex at birth." /> <purpose value="This extension extends the Patient resource to support the exchange of the patient's phenotypic sex at birth information, as a Codeable Concept, which is currently not supported by the FHIR standard." /> <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="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An extension to support the patient's phenotypic sex at birth." /> <definition value="An extension to support the patient's phenotypic sex at birth." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="A code that defines a patient's phenotypic sex at birth." /> <definition value="A code that defines a patient's phenotypic sex at birth." /> <min value="1" /> <type> <code value="code" /> </type> <binding> <strength value="required" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-BirthSex", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex", "version": "1.0.0", "name": "ExtensionUKCoreBirthSex", "title": "Extension UK Core Birth Sex", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the patient's phenotypic sex at birth.", "purpose": "This extension extends the Patient resource to support the exchange of the patient's phenotypic sex at birth information, as a Codeable Concept, which is currently not supported by the FHIR standard.", "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": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension to support the patient's phenotypic sex at birth.", "definition": "An extension to support the patient's phenotypic sex at birth.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "A code that defines a patient's phenotypic sex at birth.", "definition": "A code that defines a patient's phenotypic sex at birth.", "min": 1, "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex" } } ] } }
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-BirthSex", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex", "version": "1.0.0", "name": "ExtensionUKCoreBirthSex", "title": "Extension UK Core Birth Sex", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "An extension to support the patient's phenotypic sex at birth.", "purpose": "This extension extends the Patient resource to support the exchange of the patient's phenotypic sex at birth information, as a Codeable Concept, which is currently not supported by the FHIR standard.", "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": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension to support the patient's phenotypic sex at birth.", "definition": "An extension to support the patient's phenotypic sex at birth.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "A code that defines a patient's phenotypic sex at birth.", "definition": "A code that defines a patient's phenotypic sex at birth.", "min": 1, "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex" } } ] } }
Examples
Example UKCore-Patient-BirthSexStructureDefinition Extension-UKCore-CodingSCTDescId
The description ID and display term for a SNOMED CT concept. The descriptionId and its associated display term are important to enable the representation of the exact term that was entered by the clinician that recorded the data, or the exact term that a legacy code e.g. a Read v2 code has been translated to using an assured mapping table.
Purpose
This extension extends the Coding datatype to support the exchange of the selected description ID and display term for a SNOMED CT concept, which is currently not supported by the FHIR standard.
Guidance
This extension is NOT hardcoded in any UK Core profiles due to technical issues as this extension is only used when the terminology used is SNOMED CT. This makes the hardcoding in the profiles as not desirable and liable to cause confusion on Extensible coded data elements without adding multiple slices and therefore was deemed as not a good technical solution.
| Context of Use | |
|---|---|
| Use on data type | CodeableConcept |
Snapshot View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| descriptionId | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueIdentifier | Identifier | ||
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| descriptionDisplay | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueString | string | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Differential View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| descriptionId | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueIdentifier | Identifier | ||
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| descriptionDisplay | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueString | string | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Hybrid View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| descriptionId | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueIdentifier | Identifier | ||
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| descriptionDisplay | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueString | string | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Table View
| Extension | .. | |
| Extension.extension | .. | |
| Extension.extension | ..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | Identifier | 1.. |
| Extension.extension.value[x].assigner | Reference(UK Core Organization) | .. |
| Extension.extension | ..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | string | 1.. |
| Extension.url | .. | |
| Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-CodingSCTDescId" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId" /> <version value="2.1.0" /> <name value="ExtensionUKCoreCodingSCTDescId" /> <title value="Extension UK Core Coding SCT DescId" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="The description ID and display term for a SNOMED CT concept. The descriptionId and its associated display term are important to enable the representation of the exact term that was entered by the clinician that recorded the data, or the exact term that a legacy code e.g. a Read v2 code has been translated to using an assured mapping table." /> <purpose value="This extension extends the Coding datatype to support the exchange of the selected description ID and display term for a SNOMED CT concept, which is currently not supported by the FHIR standard." /> <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="Coding" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="SNOMED CT description ID and display term" /> <definition value="The SNOMED CT description ID and display term" /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Extension.extension:descriptionId"> <path value="Extension.extension" /> <sliceName value="descriptionId" /> <short value="SNOMED CT description ID" /> <definition value="The SNOMED CT description ID" /> <max value="1" /> </element> <element id="Extension.extension:descriptionId.url"> <path value="Extension.extension.url" /> <fixedUri value="descriptionId" /> </element> <element id="Extension.extension:descriptionId.value[x]"> <path value="Extension.extension.value[x]" /> <short value="SNOMED CT description ID" /> <definition value="The SNOMED CT description ID" /> <min value="1" /> <type> <code value="Identifier" /> </type> </element> <element id="Extension.extension:descriptionId.value[x].assigner"> <path value="Extension.extension.value[x].assigner" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> </type> </element> <element id="Extension.extension:descriptionDisplay"> <path value="Extension.extension" /> <sliceName value="descriptionDisplay" /> <short value="SNOMED CT display term" /> <definition value="The SNOMED CT display term" /> <max value="1" /> </element> <element id="Extension.extension:descriptionDisplay.url"> <path value="Extension.extension.url" /> <fixedUri value="descriptionDisplay" /> </element> <element id="Extension.extension:descriptionDisplay.value[x]"> <path value="Extension.extension.value[x]" /> <short value="SNOMED CT display term" /> <definition value="The SNOMED CT display term" /> <min value="1" /> <type> <code value="string" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-CodingSCTDescId", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId", "version": "2.1.0", "name": "ExtensionUKCoreCodingSCTDescId", "title": "Extension UK Core Coding SCT DescId", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "The description ID and display term for a SNOMED CT concept. The descriptionId and its associated display term are important to enable the representation of the exact term that was entered by the clinician that recorded the data, or the exact term that a legacy code e.g. a Read v2 code has been translated to using an assured mapping table.", "purpose": "This extension extends the Coding datatype to support the exchange of the selected description ID and display term for a SNOMED CT concept, which is currently not supported by the FHIR standard.", "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": "Coding" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "SNOMED CT description ID and display term", "definition": "The SNOMED CT description ID and display term" }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Extension.extension:descriptionId", "path": "Extension.extension", "sliceName": "descriptionId", "short": "SNOMED CT description ID", "definition": "The SNOMED CT description ID", "max": "1" }, { "id": "Extension.extension:descriptionId.url", "path": "Extension.extension.url", "fixedUri": "descriptionId" }, { "id": "Extension.extension:descriptionId.value[x]", "path": "Extension.extension.value[x]", "short": "SNOMED CT description ID", "definition": "The SNOMED CT description ID", "min": 1, "type": [ { "code": "Identifier" } ] }, { "id": "Extension.extension:descriptionId.value[x].assigner", "path": "Extension.extension.value[x].assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" ] } ] }, { "id": "Extension.extension:descriptionDisplay", "path": "Extension.extension", "sliceName": "descriptionDisplay", "short": "SNOMED CT display term", "definition": "The SNOMED CT display term", "max": "1" }, { "id": "Extension.extension:descriptionDisplay.url", "path": "Extension.extension.url", "fixedUri": "descriptionDisplay" }, { "id": "Extension.extension:descriptionDisplay.value[x]", "path": "Extension.extension.value[x]", "short": "SNOMED CT display term", "definition": "The SNOMED CT display term", "min": 1, "type": [ { "code": "string" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Examples
An example to illustrate the extension of adding a SNOMED CT description Id. Example UKCore-Condition-CodingSCTDescIdExtension Additional Guidance
This extension to the base CodeableConcept data type has been introduced to carry information chosen by the end user (or held in the end user’s system) that originated from the SNOMED CT terminology and cannot be expressed using just the SNOMED CT preferred term and concept id.
Aimed at FHIR developers, this guidance will show how to process the CodeableConcept, including:
- How to populate the code
- How to receive the code
- How to render the code to a user
- How to deal with multiple codes
- What to do if the coded data is not understood by receiving systems
The extent of the CodeableConcept data type (including the Extension-coding-sctdescid extension) is as follows:
XML
<code> <coding> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId"> <extension url="descriptionId"> <valueId value=""/> </extension> <extension url="descriptionDisplay"> <valueString value=""/> </extension> </extension> <code value=""/> <display value=""/> <system value=""/> <version value=""/> <userSelected value=""/> </coding> <text/> </code
Description of elements (in terms of SNOMED CT)
| Element | Description |
|---|---|
code |
The wrapper element for the CodeableConcept. |
coding |
The wrapper element for the coded part of the CodeableConcept. |
extension |
The wrapper element for the SNOMED description extension. |
extension url="descriptionId" |
The wrapper for the SNOMED CT description identifier. |
valueId |
Holds the SNOMED CT description identifier. |
extension url="descriptionDisplay" |
The wrapper for the SNOMED CT description display. |
valueString |
Holds the SNOMED CT description display. |
code |
Holds the SNOMED CT concept identifier. |
display |
Holds the SNOMED CT concept display. |
system |
Holds the SNOMED CT system identifier http://snomed.info/sct |
version |
Is not used for SNOMED CT. |
userSelected |
Indicates that this concept was chosen by the user. |
text |
Represents the text that was originally displayed to the user when the code was recorded. |
Populating the CodeableConcept
This section shows you how to populate each field where the code carried is a SNOMED CT code and where it’s not a SNOMED CT code. It also includes population scenarios with examples.
Field by field population guidance
| Level | Element | Directions |
|---|---|---|
| 1 | coding (SNOMED CT) |
Populate this group if a SNOMED CT concept id is stored for the item. |
| 2 | system |
Set to http://snomed.info/sct. |
| 2 | code |
The SNOMED CT concept id stored for the item. |
| 2 | display |
The text of the current preferred term of the SNOMED CT concept id according to the current NHS Realm Language Reference Sets. The text of the preferred term of the SNOMED CT concept id. The preferred term is the description specified for the concept in the NHS realm description subset. The preferred term for a concept may change over time. The sending system should determine the current preferred term for the concept. |
| 2 | extension url="descriptionId" |
The SNOMED CT descriptionId recorded with the item. Only populated if a descriptionId exists. |
| 2 | extension url="descriptionDisplay" |
The text of the description id. Only populated if a descriptionId exists and there is no need to populate this field if the text is lexically identical to the text in coding.display. |
| 2 | userSelected |
Set to true if a user selected the SNOMED CT Code when creating/updating this item. If this is false then this element MUST not be populated by the supplying system. For consuming systems the absence of this element therefore indicates that it is false. |
| 1 | coding (other) |
Populate this group if a clinical code other than SNOMED CT is stored for the item. If there are multiple codes (that is,. the item has been translated multiple times) there is a group entry per code. |
| 2 | system |
The identification of the code system that defines the meaning of the symbol in the code. |
| 2 | code |
The clinical code associated with the item. |
| 2 | display |
The longest character length variant text associated with the current preferred term for the clinical code. |
| 2 | extension url="descriptionId" |
Do not populate (SNOMED CT only). |
| 2 | extension url="descriptionDisplay" |
Do not populate (SNOMED CT only). |
| 2 | userSelected |
Set to true if a user selected this code when creating/updating this item. If this is false then this element MUST not be populated by the supplying system. For consuming systems the absence of this element therefore indicates that it is false. |
| 1 | text |
The original text selected/manually entered by the user for the item. Only populate when there is no user selected translation set with a display or descriptionDisplay recorded. If the text displayed to the user when they entered the code on the system is not lexically identical to the term of the code then the displayed text must be populated here. Note: This occurs when either the original entry was not coded or the original coding has been lost. |
Sending dm+d codes
Where a supplier is using the dm+d codes which does not contain any data at the descriptionId level, then we would not expect the descriptionId extension to be populated. Where the descriptionId is available then this SHALL be included.
The example below demonstrates how a dm+d code should be sent where there is no descriptionId available.
XML
<code> <coding> <code value="323509004"/> <display value="Amoxicillin 250mg capsules"/> <system value="https://dmd.nhs.uk/"/> <userSelected value="true"/> </coding> </code>
JSON
{
"code": {
"coding": [{
"code": "323509004",
"display": "Amoxicillin 250mg capsules",
"system": "https://dmd.nhs.uk/",
"userSelected": true
}]
}
}
Sending a SNOMED CT concept with its associated preferred term
When sending a SNOMED CT concept id with its preferred term and the descriptionId is known, then code.coding.code, code.coding.system and code.coding.extension.descriptionId SHALL be populated. Where the descriptionId is not known then the codeable concept MAY be sent without the descriptionId.
In the example below, the descriptionId is populated with the descriptionId for the preferred term, but there is no descriptionDisplay as the concept id was entered by the user and the preferred term was displayed to them when it was added.
XML
<code> <coding> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId"> <extension url="descriptionId"> <valueId value="37436014"/> </extension> </extension> <code value="22298006"/> <display value="Myocardial infarction"/> <system value="http://snomed.info/sct"/> <userSelected value="true"/> </coding> </code>
JSON
{
"code": {
"coding": [{
"extension": [{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId",
"extension": [{
"url": "descriptionId",
"valueId": "37436014"
}]
}],
"code": "22298006",
"display": "Myocardial infarction",
"system": "http://snomed.info/sct",
"userSelected": true
}]
}
}
Sending a concept where the coding system and code is unknown
In the exceptional case that the code is not known, then the code.text element can be populated without the need to populate a coding element.
XML
<code> <text>Myocardial infarction</text> </code>
JSON
{
"code": {
"text": "Myocardial infarction"
}
}
Sending a description id that is not the preferred term
In this case, the description id represents a term that is different from the preferred term and therefore the description will be different from that used to populate the code.coding.display element. Therefore the extension for descriptionDisplay shall be populated with the term corresponding to the descriptionId.
XML
<code> <coding> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId"> <extension url="descriptionId"> <valueId value="37443015"/> </extension> <extension url="descriptionDisplay"> <valueString value="Heart attack"/> </extension> </extension> <code value="22298006"/> <display value="Myocardial infarction"/> <system value="http://snomed.info/sct"/> <userSelected value="true"/> </coding> </code>
JSON
{
"code": {
"coding": [{
"extension": {
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId",
"extension": [{
"url": "descriptionId",
"valueId": "37443015"
},
{
"url": "descriptionDisplay",
"valueString": "Heart attack"
}
]
},
"code": "22298006",
"display": "Myocardial infarction",
"system": "http://snomed.info/sct",
"userSelected": true
}]
}
}
Sending a translation set
In the case where the code was entered into the clinical system using a legacy coding system, the code will have been mapped to a SNOMED CT translation.
However, in SNOMED CT, all concept ids always have more than one associated description: all have at least one fully specified name and at least one additional associated synonym. Of these, exactly one fully specified name and one synonym will be declared to be “preferred” at any point in time within a Realm Language Reference Set, but which terms are designated “preferred” can and does change over time.
Therefore, in most cases where such mappings have been created, they will have been mapped to an explicit pairing of one SNOMED CT concept id and one of its legitimate description ids. The particular descriptionId selected may also correspond to the preferred term but often does not.
Exceptionally, mappings may correspond to a SNOMED CT concept id only and so no particular description is declared in the map. In these cases the description originally entered by the clinician in the legacy coding system is considered to be the clinically relevant text.
XML
<code> <coding> <code value="44I4.00"/> <display value="Serum potassium"/> <system value="http://read.info/readv2"/> <userSelected value="true"/> <!--flags the coding originally actually selected by the user --> </coding> <coding> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId"> <extension url="descriptionId"> <valueId value="2573011000000117"/> </extension> </extension> <system value="http://snomed.info/sct"/> <code value="1000651000000109”/> <display value="Serum potassium level"/> </coding> <text>Serum potassium</text> <!-- what the user saw on screen, from a data entry template --> </code>
JSON
{
"code": {
"coding": [{
"extension": [{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId",
"extension": [{
"url": "descriptionId",
"valueId": "2573011000000117"
}]
}],
}
],
"code": "44I4.00",
"display": "Serum potassium",
"system": "http://read.info/readv2",
"userSelected": true
},
{
"system": "http://snomed.info/sct",
"code": "1000651000000109"
"display": "Serum potassium level",
"text": "Serum potassium"
}
}
XML
<code> <coding> <code value="B76..14"/> <!— term code = 14 ie not V2 Preferred term --> <display value="Mole of skin"/> <!— text for V2 term code = 14 --> <system value="http://read.info/readv2"/> <userSelected value="true"/> <!-- coding actually selected by user --> </coding> <coding> <code value="X78Uv"/> <!— no term code, so CTV3 PT is implied? --> <display value="Benign melanocytic naevus of skin"/> <!— text of V3 PT --> <system value="http://read.info/ctv3"/> </coding> <coding> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId"> <extension url="descriptionId"> <valueId value="1787065011"/> <!— not the SNOMED PT --> </extension> <extension url="descriptionDisplay"> <valueString value="Mole of skin"/> <!— text for id = 1787065011 --> </extension> </extension> <system value="http://snomed.info/sct"/> <code value="400010006”/> <!— SNOMED conceptId --> <display value="Melanocytic naevus of skin"/> <!— text of SNOMED PT --> </coding> <text>Moles</text> <!-- what user saw on screen, from data entry template --> </code>
JSON
{
"code": {
"coding": [{
"code": "B76..14",
"display": "Mole of skin",
"system": "http://read.info/readv2",
"userSelected": true
},
{
"code": "X78Uv",
"display": "Benign melanocytic naevus of skin",
"system": "http://read.info/ctv3",
},
{
"system": "http://snomed.info/sct",
"code": "400010006"
"display": " Melanocytic naevus of skin",
"extension": [{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId",
"extension": [{
"url": "descriptionId",
"valueId": "1787065011" },
{
"url": "descriptionDisplay",
"valueString": "Mole of skin"
}]
}],
}
],
"text": "Moles"
}
}
Rules for populating legacy coding
Read Code
All Read Codes should be represented using a full five characters.
- Where 4-byte codes are used these must be preceded by a full-stop as in the NHS Clinical Terms superset (e.g. 4-byte code "6521" is represented as ".6521").
- Trailing full-stops are significant and must be included (e.g. "H43" is not a valid Read Code and must be represented in full as "H43..").
- Care should be taken in any environment where a Read Code may have been subjected to auto-correction because:
- Upper/lower case is significant
- Conversion of a sequence of three full-stops "..." to a single "…" (ASCII Hex "85" Unicode Hex "2026") special character occurs in some environments and creates invalid Read Codes.
- Care should be taken in any environment where a Read Code may have been subjected to auto-correction because:
Read Code version 2 term code
Read Codes Version 2 uses a "Term Code" to distinguish between some alternative terms associated with the same Read Code. A Term Code is represented as a two digit string and is only unique within the context of a single Read Code.
It is now widely recognised that many of the terms associated with a Read Code are not true synonyms. This issue was partially resolved in NHS Clinical Terms Version 3 and further disambiguation has occurred in development of SNOMED Clinical Terms. However, in the meantime where Term Codes are stored these should be communicated with the Read Code.
A Read Code + Term Code combination is communicated as a single seven character code. Thus the code "7001200" represents the Term Code "00" associated with the Read Code "70012".
Note that this specification requires the term to be conveyed in the message in addition to any coded representation. Therefore, safe communication is not dependent on use of the Term Code in all systems. Therefore, a sending system that does not support Term Codes for a particular item of information should not send a Term Code. Similarly a receiving system that does not support Term Code storage may ignore the Term Code when constructing a record entry. However, where a sending system stores the Term Code this should be included in the message and where a receiving system stores the Term Code this should be retrieved from the message.
NHS Clinical Terms Version 3 – Term Id
In NHS Clinical Terms Version 3 the TermId is a five character string that uniquely identifies an associated term (or set of two or three terms of alternative lengths). Although it is globally unique it says nothing about the associated concept and thus must be combined with the Read Code. There are no plans to use the TermID in NHS Clinical Terms Version 3 and thus inclusion of TermId is not permitted.
Sending a description id NOT in the UK Edition, but for a concept id that IS in the UK Edition
Includes the case where the description id is locally declared to be the preferred term.
XML
<code> <coding> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId"> <extension url="descriptionId”> <valueId value="787121000006116"/> <!-- descriptionId from EMIS namespace --> </extension> <extension url="descriptionDisplay"> <valueString value="Ideal weight"/> </extension> </extension> <code value="170804003"/> <!-- conceptId from SNOMED International CORE --> <display value="Ideal body weight"/> <system value="http://snomed.info/sct"/> <userSelected value="true"/> </coding> </code>
JSON
{
"code": {
"coding": {
"extension": [{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId",
"extension": [{
"url": "descriptionId",
"valueId": "787121000006116"
}, {
"url": "descriptionDisplay",
"valueString": "Ideal weight"
}]
}],
"code": "170804003",
"display": "Ideal body weight",
"system": "http://snomed.info/sct",
"userSelected": true
}
}
}
Sending a description id and concept id where NEITHER is in the UK Edition
XML
<code> <coding> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId"> <extension url="descriptionId"> <valueId value="253790221000087110"/> <!— from Canadian extension --> </extension> <extension url="descriptionDisplay”> <valueString value="Use of illicit drugs unknown"/> <!-- synonym from Canadian extension --> </extension> </extension> <code value="186782131000087106"/> <!-- conceptId from Canadian extension --> <display value="Use of illicit type drug unknown"/> <!-- preferred term from Canadian extension --> <system value="http://snomed.info/sct"/> <userSelected value="true"/> </coding> <text> Not known whether uses illicit drugs</text> <!-- what the user saw on screen, from a data entry template --> </code>
JSON
{
"code": {
"coding": {
"extension": {
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId",
"extension": [
{
"url": "descriptionId",
"valueId": "253790221000087110"
},
{
"url": "descriptionDisplay",
"valueString": "Use of illicit drugs unknown"
}
]
},
"code": "186782131000087106",
"display": "Use of illicit type drug unknown",
"system": "http://snomed.info/sct",
"userSelected": "true"
},
"text": " Not known whether uses illicit drugs"
}
}
Processing data from a CodeableConcept
Degradation
Degradation is a process used in clinical systems' interoperability for dealing with codes that are not understood by receiving systems. When codes are degraded the original text entered by a user is then associated with an appropriate degrade code. For example, a drug allergy code that is not understood will be associated with a code for ‘Degraded drug allergy’.
Why and how does it happen?
When clinical codes move between systems, sometimes the receiving system may not understand all the clinical codes that it was sent. This can be for a number of reasons:
The receiving system may use a different terminology than the sending system. An example of a place in which this happens is in primary care where TPP SystmOne uses Clinical Terms Version 3 and EMIS Web uses Read version 2.
Clinical systems may be using different releases of the same terminology. In the UK, terminologies are updated regularly, usually 6 monthly. When they are updated new codes are added and old codes deprecated. If one system updates before another then for a period it may contain new codes that systems using an older version do not understand.
SNOMED CT has an extension mechanism that allows SNOMED CT to be customized usually be adding additional concepts and descriptions. So sending systems may have added content that is not available on the receiving system. See examples 6 and 7 on how messages are populated with extension data.
There may be many other reasons that codes are not understood between systems but the above are some of the most common reasons. Here they are intended to illustrate that degrades happen but are not intended to be an exhaustive list.
Why do we need a process to deal with it?
Where codes are not understood by clinical systems, having a degrade process enables us to improve interoperability and related functionality. Having appropriate degrade codes enables us to retain the structure and semantics. For example, degraded allergies appear in allergies view, medication degrades appear in medication module.
Some examples of how this can work are:
Where allergies are degraded, associating the item that was not understood with an allergy degrade code that the clinical system understands can enable it to trigger (for example) additional prescribing safety decision support systems and workflows.
Where medication codes are not understood and the data item is associated with a medication degrade code, the information can be displayed alongside all other medications in the clinical system.
What do degrades look like?
Where items are degraded, how they appear can vary depending on how a clinical system chooses to display them to a user. In many cases, depending on whether the actual code is displayed to the user, the degrade may appear to be similar to any code natively added in a system.
When they are then exported into a FHIR resource they will be exported as a degrade code with the text originally entered by the user in the code.text element.
FHIR message examples
Example of a degraded medication:
XML
<code> <coding> <display>Transfer-degraded medication entry</display> <code>196421000000109</code> <system>http://snomed.info/sct</system> </coding> <text>Aspirin 75mg dispersible tablet</text> </code>
JSON
{
"code": {
"coding": [{
"display": "Transfer-degraded medication entry",
"code": "196421000000109",
"system": "http://snomed.info/sct"
}],
"text": "Aspirin 75mg dispersible tablet"
}
}
Example of a degraded drug allergy:
XML
<code> <coding> <display>Transfer-degraded drug allergy</display> <code>196461000000101</code> <system>http://snomed.info/sct</system> </coding> <text>Amoxicillin 250mg capsules</text> </code>
JSON
{
"code": {
"coding": [{
"display": "Transfer-degraded drug allergy",
"code": "196461000000101",
"system": "http://snomed.info/sct"
}],
"text": "Amoxicillin 250mg capsules"
}
}
Clinical codes
Storage
When storing the item, the receiving system may choose to store any or all of the clinical codes associated with the item.
However, where the system supports SNOMED CT codes it MUST store any SNOMED CT codes associated with the item.
Where the receiving system does not understand any of the supplied coding.systems which a coding has been associated with the item (or no clinical codes were supplied), it may choose to record the item under a degraded code. The appropriate SNOMED degrade code should be used within the system to store the code.
| The following codes are available in SNOMED to represent degraded items and can be used when populating FHIR resources. | |
|---|---|
| Degraded Drug Allergies | 196461000000101 - Transfer-degraded drug allergy |
| Degraded Non-Drug Allergies | 196471000000108 - Transfer-degraded non-drug allergy |
| Degraded Medications | 196421000000109 - Transfer-degraded medication entry |
| Degraded Plan | 196451000000104 - Transfer-degraded plan |
| Degraded Referral | 196431000000106 - Transfer-degraded referral |
| Degraded Request | 196441000000102 - Transfer-degraded request |
| Other degrade | 196411000000103 - Transfer-degraded record entry |
Where an item that is being degraded is contained within a resource that infers a particular type of degrade then the appropriate code shall be used e.g. a code in a FHIR medication resource shall use the ‘Degraded medication’ code.
Clinical systems MUST NOT attempt to infer a particular type of degrade code where there is no clear indication that a specific type of data has been degraded. In these scenarios the ‘Transfer degraded record entry’ code shall be used.
Display
When displaying the item to end users, it is the choice of the receiving system to design their system and user experience in a safe manner that best suits their users.
Propagation
When propagating coded data to another system, the system which received the item may choose which clinical codes to include when sending the item.
If a receiving system receives a SNOMED code that it does not understand it COULD store this code and propagate it onwards if the data is exported. If systems decide to do this they should consider what would happen if the data item is changed/edited.
Note: Whilst it is the receiving system’s decision which clinical codes are appropriate for it to store, NHS England requires that SNOMED CT is supported across the entire NHS estate by April 2020.
Original term text
Storage
When processing an item, the receiving system MUST always store the original term text of the item. That is, the text chosen/manually entered by the clinician/user to describe the item they are recording. Failure to do this could result in the intended meaning of the item being altered.
The original term text will be available in one of the following fields in order of descending priority:
- text
- coding.descriptionDisplay where userSelected = TRUE (or is unpopulated, and only one coding element is present)
- coding.display where userSelected = TRUE (or is unpopulated, and only one coding element is present)
Where the receiving system can derive the original term text from the clinical code and the derived text is lexically identical to the original term text, then the receiving system is not required to store the text separately.
However, where the system supports SNOMED CT codes it MUST store any SNOMED CT codes associated with the item where the userSelected is set to ‘TRUE’ and propagate these onward in any future export of the data. As noted in section 3.1, some SNOMED CT codes received may be from a release or extension of SNOMED not available on the receiving system.
Display
When displaying an item to end users, the receiving system MUST always display the original term text of the item.
Propagation
When propagating an item to another system, the receiving system MUST always include the original term text of the item.
StructureDefinition Extension-UKCore-ContactPreference
The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
Purpose
This extension extends the Patient and RelatedPerson resources to support the exchange of their preferred method of contact, contact times and written communication format, which are currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | RelatedPerson Patient.contact |
Snapshot View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| PreferredContactMethod | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| PreferredContactTimes | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueString | string | ||
| valueTiming | Timing | ||
| PreferredWrittenCommunicationFormat | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Differential View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| PreferredContactMethod | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| PreferredContactTimes | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueString | string | ||
| valueTiming | Timing | ||
| PreferredWrittenCommunicationFormat | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Hybrid View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| PreferredContactMethod | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| PreferredContactTimes | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueString | string | ||
| valueTiming | Timing | ||
| PreferredWrittenCommunicationFormat | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Table View
| Extension | ..1 | |
| Extension.extension | 0.. | |
| Extension.extension | 0..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | CodeableConcept | 1.. |
| Extension.extension | 0..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | string, Timing | 1.. |
| Extension.extension | 0..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | CodeableConcept | 1.. |
| Extension.url | .. | |
| Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-ContactPreference" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" /> <version value="2.2.0" /> <name value="ExtensionUKCoreContactPreference" /> <title value="Extension UK Core Contact Preference" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="The preferred method of contact, contact times and written communication format given by a Patient or Related Person." /> <purpose value="This extension extends the Patient and RelatedPerson resources to support the exchange of their preferred method of contact, contact times and written communication format, which are currently not supported by the FHIR standard." /> <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="Patient" /> </context> <context> <type value="element" /> <expression value="RelatedPerson" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="The preferred method of contact, contact times and written communication format given by a Patient or Related Person." /> <definition value="The preferred method of contact, contact times and written communication format given by a Patient or Related Person." /> <max value="1" /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> <min value="0" /> </element> <element id="Extension.extension:PreferredContactMethod"> <path value="Extension.extension" /> <sliceName value="PreferredContactMethod" /> <short value="Preferred Contact Method" /> <definition value="The preferred method of contact given by a Patient or Related Person." /> <min value="0" /> <max value="1" /> </element> <element id="Extension.extension:PreferredContactMethod.url"> <path value="Extension.extension.url" /> <fixedUri value="PreferredContactMethod" /> </element> <element id="Extension.extension:PreferredContactMethod.value[x]"> <path value="Extension.extension.value[x]" /> <short value="Preferred Contact Method" /> <definition value="The preferred method of contact given by a Patient or Related Person." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredContactMethod" /> </binding> </element> <element id="Extension.extension:PreferredContactTimes"> <path value="Extension.extension" /> <sliceName value="PreferredContactTimes" /> <short value="Preferred Contact Times" /> <definition value="The preferred contact times given by a Patient or Related Person." /> <min value="0" /> <max value="1" /> </element> <element id="Extension.extension:PreferredContactTimes.url"> <path value="Extension.extension.url" /> <fixedUri value="PreferredContactTimes" /> </element> <element id="Extension.extension:PreferredContactTimes.value[x]"> <path value="Extension.extension.value[x]" /> <short value="Preferred Contact Times" /> <definition value="The preferred contact time period given by a Patient or Related Person." /> <min value="1" /> <type> <code value="string" /> </type> <type> <code value="Timing" /> </type> </element> <element id="Extension.extension:PreferredWrittenCommunicationFormat"> <path value="Extension.extension" /> <sliceName value="PreferredWrittenCommunicationFormat" /> <short value="Preferred Written Communication Format" /> <definition value="The preferred written communication format given by a Patient or Related Person." /> <min value="0" /> <max value="1" /> </element> <element id="Extension.extension:PreferredWrittenCommunicationFormat.url"> <path value="Extension.extension.url" /> <fixedUri value="PreferredWrittenCommunicationFormat" /> </element> <element id="Extension.extension:PreferredWrittenCommunicationFormat.value[x]"> <path value="Extension.extension.value[x]" /> <short value="Preferred Written Communication Format" /> <definition value="The preferred written communication format given by a Patient or Related Person." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredWrittenCommunicationFormat" /> </binding> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-ContactPreference", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference", "version": "2.2.0", "name": "ExtensionUKCoreContactPreference", "title": "Extension UK Core Contact Preference", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "The preferred method of contact, contact times and written communication format given by a Patient or Related Person.", "purpose": "This extension extends the Patient and RelatedPerson resources to support the exchange of their preferred method of contact, contact times and written communication format, which are currently not supported by the FHIR standard.", "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": "Patient" }, { "type": "element", "expression": "RelatedPerson" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The preferred method of contact, contact times and written communication format given by a Patient or Related Person.", "definition": "The preferred method of contact, contact times and written communication format given by a Patient or Related Person.", "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Extension.extension:PreferredContactMethod", "path": "Extension.extension", "sliceName": "PreferredContactMethod", "short": "Preferred Contact Method", "definition": "The preferred method of contact given by a Patient or Related Person.", "min": 0, "max": "1" }, { "id": "Extension.extension:PreferredContactMethod.url", "path": "Extension.extension.url", "fixedUri": "PreferredContactMethod" }, { "id": "Extension.extension:PreferredContactMethod.value[x]", "path": "Extension.extension.value[x]", "short": "Preferred Contact Method", "definition": "The preferred method of contact given by a Patient or Related Person.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredContactMethod" } }, { "id": "Extension.extension:PreferredContactTimes", "path": "Extension.extension", "sliceName": "PreferredContactTimes", "short": "Preferred Contact Times", "definition": "The preferred contact times given by a Patient or Related Person.", "min": 0, "max": "1" }, { "id": "Extension.extension:PreferredContactTimes.url", "path": "Extension.extension.url", "fixedUri": "PreferredContactTimes" }, { "id": "Extension.extension:PreferredContactTimes.value[x]", "path": "Extension.extension.value[x]", "short": "Preferred Contact Times", "definition": "The preferred contact time period given by a Patient or Related Person.", "min": 1, "type": [ { "code": "string" }, { "code": "Timing" } ] }, { "id": "Extension.extension:PreferredWrittenCommunicationFormat", "path": "Extension.extension", "sliceName": "PreferredWrittenCommunicationFormat", "short": "Preferred Written Communication Format", "definition": "The preferred written communication format given by a Patient or Related Person.", "min": 0, "max": "1" }, { "id": "Extension.extension:PreferredWrittenCommunicationFormat.url", "path": "Extension.extension.url", "fixedUri": "PreferredWrittenCommunicationFormat" }, { "id": "Extension.extension:PreferredWrittenCommunicationFormat.value[x]", "path": "Extension.extension.value[x]", "short": "Preferred Written Communication Format", "definition": "The preferred written communication format given by a Patient or Related Person.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredWrittenCommunicationFormat" } }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Examples
Example UKCore-ContactPreferenceStructureDefinition Extension-UKCore-ContactRank
The preferred ranking or order of contact applied to a contact on a Patient's contact list.
Purpose
This extension extends the Patient and RelatedPerson resources to support the exchange of the preferred ranking or order of contact applied to a contact on a Patient's contact list, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | RelatedPerson Patient.contact |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valuePositiveInt | positiveInt |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valuePositiveInt | positiveInt |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valuePositiveInt | positiveInt |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-ContactRank" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" /> <version value="2.1.0" /> <name value="ExtensionUKCoreContactRank" /> <title value="Extension UK Core Contact Rank" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="The preferred ranking or order of contact applied to a contact on a Patient's contact list." /> <purpose value="This extension extends the Patient and RelatedPerson resources to support the exchange of the preferred ranking or order of contact applied to a contact on a Patient's contact list, which is currently not supported by the FHIR standard." /> <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="Patient.contact" /> </context> <context> <type value="element" /> <expression value="RelatedPerson" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Preferred ranking or order of contact applied to a contact on a patient's contact list" /> <definition value="The preferred ranking or order of contact applied to a contact on a patient's contact list." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The preferred ranking or order of contact applied to a contact on a patient's contact list" /> <definition value="The preferred ranking or order of contact applied to a contact on a patient's contact list." /> <min value="1" /> <type> <code value="positiveInt" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-ContactRank", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank", "version": "2.1.0", "name": "ExtensionUKCoreContactRank", "title": "Extension UK Core Contact Rank", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "The preferred ranking or order of contact applied to a contact on a Patient's contact list.", "purpose": "This extension extends the Patient and RelatedPerson resources to support the exchange of the preferred ranking or order of contact applied to a contact on a Patient's contact list, which is currently not supported by the FHIR standard.", "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": "Patient.contact" }, { "type": "element", "expression": "RelatedPerson" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Preferred ranking or order of contact applied to a contact on a patient's contact list", "definition": "The preferred ranking or order of contact applied to a contact on a patient's contact list.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The preferred ranking or order of contact applied to a contact on a patient's contact list", "definition": "The preferred ranking or order of contact applied to a contact on a patient's contact list.", "min": 1, "type": [ { "code": "positiveInt" } ] } ] } }
Examples
Example UKCore-Patient-ContactRankStructureDefinition Extension-UKCore-CopyCorrespondenceIndicator
Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.
Purpose
This extension extends the Patient and RelatedPerson resources, to support the exchange of information to indicate that a Patient contact or RelatedPerson must be copied in to Patient correspondence. This is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | RelatedPerson Patient.contact |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-CopyCorrespondenceIndicator" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" /> <version value="2.1.0" /> <name value="ExtensionUKCoreCopyCorrespondenceIndicator" /> <title value="Extension UK Core Copy Correspondence Indicator" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence." /> <purpose value="This extension extends the Patient and RelatedPerson resources, to support the exchange of information to indicate that a Patient contact or RelatedPerson must be copied in to Patient correspondence. This is currently not supported by the FHIR standard." /> <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="Patient.contact" /> </context> <context> <type value="element" /> <expression value="RelatedPerson" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Indicator showing that a patient's contact or related person must be copied in to patient correspondence" /> <definition value="Extension carrying a boolean indicator showing that a patient's contact or related person must be copied in to patient correspondence." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Copy Correspondence Indicator" /> <definition value="Boolean element representing Copy Correspondence Indicator." /> <min value="1" /> <type> <code value="boolean" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-CopyCorrespondenceIndicator", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator", "version": "2.1.0", "name": "ExtensionUKCoreCopyCorrespondenceIndicator", "title": "Extension UK Core Copy Correspondence Indicator", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.", "purpose": "This extension extends the Patient and RelatedPerson resources, to support the exchange of information to indicate that a Patient contact or RelatedPerson must be copied in to Patient correspondence. This is currently not supported by the FHIR standard.", "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": "Patient.contact" }, { "type": "element", "expression": "RelatedPerson" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Indicator showing that a patient's contact or related person must be copied in to patient correspondence", "definition": "Extension carrying a boolean indicator showing that a patient's contact or related person must be copied in to patient correspondence.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Copy Correspondence Indicator", "definition": "Boolean element representing Copy Correspondence Indicator.", "min": 1, "type": [ { "code": "boolean" } ] } ] } }
StructureDefinition Extension-UKCore-DeathNotificationStatus
The patient's death notification status.
Purpose
This extension extends the Patient resource to support the exchange of the patient's death notification status, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Patient |
Snapshot View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| deathNotificationStatus | I | 1..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| systemEffectiveDate | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueDateTime | dateTime | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Differential View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| deathNotificationStatus | I | 1..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| systemEffectiveDate | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueDateTime | dateTime | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Hybrid View
| Extension | I | Extension | |
| extension | I | 0..* | Extension |
| deathNotificationStatus | I | 1..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| systemEffectiveDate | I | 0..1 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| valueDateTime | dateTime | ||
| url | 1..1 | System.StringFixed Value | |
| value[x] | 0..0 |
Table View
| Extension | ..1 | |
| Extension.extension | .. | |
| Extension.extension | 1..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | CodeableConcept | 1.. |
| Extension.extension | ..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | dateTime | 1.. |
| Extension.url | .. | |
| Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-DeathNotificationStatus" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" /> <version value="2.1.0" /> <name value="ExtensionUKCoreDeathNotificationStatus" /> <title value="Extension UK Core Death Notification Status" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="The patient's death notification status." /> <purpose value="This extension extends the Patient resource to support the exchange of the patient's death notification status, which is currently not supported by the FHIR standard." /> <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="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="The patient's death notification status." /> <definition value="The patient's death notification status." /> <max value="1" /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Extension.extension:deathNotificationStatus"> <path value="Extension.extension" /> <sliceName value="deathNotificationStatus" /> <short value="The patient's death notification status." /> <definition value="The patient's death notification status." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:deathNotificationStatus.url"> <path value="Extension.extension.url" /> <fixedUri value="deathNotificationStatus" /> </element> <element id="Extension.extension:deathNotificationStatus.value[x]"> <path value="Extension.extension.value[x]" /> <short value="The patient's death notification status." /> <definition value="The patient's death notification status." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-DeathNotificationStatus" /> </binding> </element> <element id="Extension.extension:systemEffectiveDate"> <path value="Extension.extension" /> <sliceName value="systemEffectiveDate" /> <short value="System effective date for patient's death notification status." /> <definition value="System effective date for patient's death notification status." /> <max value="1" /> </element> <element id="Extension.extension:systemEffectiveDate.url"> <path value="Extension.extension.url" /> <fixedUri value="systemEffectiveDate" /> </element> <element id="Extension.extension:systemEffectiveDate.value[x]"> <path value="Extension.extension.value[x]" /> <short value="System effective date for patient's death notification status." /> <definition value="System effective date for patient's death notification status." /> <min value="1" /> <type> <code value="dateTime" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-DeathNotificationStatus", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus", "version": "2.1.0", "name": "ExtensionUKCoreDeathNotificationStatus", "title": "Extension UK Core Death Notification Status", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "The patient's death notification status.", "purpose": "This extension extends the Patient resource to support the exchange of the patient's death notification status, which is currently not supported by the FHIR standard.", "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": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The patient's death notification status.", "definition": "The patient's death notification status.", "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Extension.extension:deathNotificationStatus", "path": "Extension.extension", "sliceName": "deathNotificationStatus", "short": "The patient's death notification status.", "definition": "The patient's death notification status.", "min": 1, "max": "1" }, { "id": "Extension.extension:deathNotificationStatus.url", "path": "Extension.extension.url", "fixedUri": "deathNotificationStatus" }, { "id": "Extension.extension:deathNotificationStatus.value[x]", "path": "Extension.extension.value[x]", "short": "The patient's death notification status.", "definition": "The patient's death notification status.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-DeathNotificationStatus" } }, { "id": "Extension.extension:systemEffectiveDate", "path": "Extension.extension", "sliceName": "systemEffectiveDate", "short": "System effective date for patient's death notification status.", "definition": "System effective date for patient's death notification status.", "max": "1" }, { "id": "Extension.extension:systemEffectiveDate.url", "path": "Extension.extension.url", "fixedUri": "systemEffectiveDate" }, { "id": "Extension.extension:systemEffectiveDate.value[x]", "path": "Extension.extension.value[x]", "short": "System effective date for patient's death notification status.", "definition": "System effective date for patient's death notification status.", "min": 1, "type": [ { "code": "dateTime" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
StructureDefinition Extension-UKCore-EthnicCategory
Information that describes the patient's ethnic category.
Purpose
This extension extends the Patient resource to support the exchange of ethnic category information, as a Codeable Concept, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Patient |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-EthnicCategory" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory" /> <version value="2.2.0" /> <name value="ExtensionUKCoreEthnicCategory" /> <title value="Extension UK Core Ethnic Category" /> <status value="active" /> <date value="2022-01-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="Information that describes the patient's ethnic category." /> <purpose value="This extension extends the Patient resource to support the exchange of ethnic category information, as a Codeable Concept, which is currently not supported by the FHIR standard." /> <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="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Ethnic category" /> <definition value="The ethnicity of the subject." /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="A code classifying the person's ethnicity" /> <definition value="A code classifying the person's ethnicity." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="preferred" /> <description value="A set of codes that define the ethnicity of a person, as specified by the person." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-EthnicCategory" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-EthnicCategory", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory", "version": "2.2.0", "name": "ExtensionUKCoreEthnicCategory", "title": "Extension UK Core Ethnic Category", "status": "active", "date": "2022-01-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "Information that describes the patient's ethnic category.", "purpose": "This extension extends the Patient resource to support the exchange of ethnic category information, as a Codeable Concept, which is currently not supported by the FHIR standard.", "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": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Ethnic category", "definition": "The ethnicity of the subject." }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "A code classifying the person's ethnicity", "definition": "A code classifying the person's ethnicity.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "description": "A set of codes that define the ethnicity of a person, as specified by the person.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-EthnicCategory" } } ] } }
Examples
Richard Smith - An example to illustrate patient Ethnic Category information. Example UKCore-Patient-EthnicCategoryStructureDefinition Extension-UKCore-Evidence
A reference to results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.
Purpose
This extension extends the AllergyIntolerance resource to support the exchange of information describing the reference to results of investigations that confirmed the certainty of the diagnosis, which is currently not supported by the FHIR standard.
Guidance
An optional extension for a reference to a UKCore-DiagnosticReport resource to share the results of investigations that confirmed the certainty of the allergy or intolerance diagnosis.
| Context of Use | |
|---|---|
| Use on element | AllergyIntolerance |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| reference | Σ I | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| display | Σ | 0..1 | string |
| valueReference | Reference(UK Core DiagnosticReport) |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| reference | Σ I | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| display | Σ | 0..1 | string |
| valueReference | Reference(UK Core DiagnosticReport) |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| reference | Σ I | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| display | Σ | 0..1 | string |
| valueReference | Reference(UK Core DiagnosticReport) |
Table View
| Extension | .. | |
| Extension.url | .. | |
| Extension.value[x] | Reference(UK Core DiagnosticReport) | 1.. |
| Extension.value[x].identifier | .. | |
| Extension.value[x].identifier.assigner | Reference(UK Core Organization) | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-Evidence" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence" /> <version value="2.1.0" /> <name value="ExtensionUKCoreEvidence" /> <title value="Extension UK Core Evidence" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="A reference to results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests." /> <purpose value="This extension extends the AllergyIntolerance resource to support the exchange of information describing the reference to results of investigations that confirmed the certainty of the diagnosis, which is currently not supported by the FHIR standard." /> <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="AllergyIntolerance" /> </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 reference to results of investigations that confirmed the certainty of the diagnosis" /> <definition value="A reference to results of investigations that confirmed the certainty of the diagnosis." /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="A reference to results of investigations that confirmed the certainty of the diagnosis" /> <definition value="A reference to results of investigations that confirmed the certainty of the diagnosis." /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport" /> </type> </element> <element id="Extension.value[x].identifier.assigner"> <path value="Extension.value[x].identifier.assigner" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-Evidence", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence", "version": "2.1.0", "name": "ExtensionUKCoreEvidence", "title": "Extension UK Core Evidence", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "A reference to results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.", "purpose": "This extension extends the AllergyIntolerance resource to support the exchange of information describing the reference to results of investigations that confirmed the certainty of the diagnosis, which is currently not supported by the FHIR standard.", "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": "AllergyIntolerance" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "A reference to results of investigations that confirmed the certainty of the diagnosis", "definition": "A reference to results of investigations that confirmed the certainty of the diagnosis." }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "A reference to results of investigations that confirmed the certainty of the diagnosis", "definition": "A reference to results of investigations that confirmed the certainty of the diagnosis.", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport" ] } ] }, { "id": "Extension.value[x].identifier.assigner", "path": "Extension.value[x].identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" ] } ] } ] } }
StructureDefinition Extension-UKCore-MainLocation
Information describing the main location of the organisation.
Purpose
This extension extends the Organization resource to support the exchange of information on the Organization's main location, as a reference to a Location resource, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Organization |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| reference | Σ I | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| display | Σ | 0..1 | string |
| valueReference | Reference(UK Core Location) |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| reference | Σ I | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| display | Σ | 0..1 | string |
| valueReference | Reference(UK Core Location) |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | ||
| reference | Σ I | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ I | 0..1 | Period |
| assigner | Σ I | 0..1 | Reference(UK Core Organization) |
| display | Σ | 0..1 | string |
| valueReference | Reference(UK Core Location) |
Table View
| Extension | .. | |
| Extension.url | .. | |
| Extension.value[x] | Reference(UK Core Location) | 1.. |
| Extension.value[x].identifier | .. | |
| Extension.value[x].identifier.assigner | Reference(UK Core Organization) | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-MainLocation" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation" /> <version value="2.1.0" /> <name value="ExtensionUKCoreMainLocation" /> <title value="Extension UK Core Main Location" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="Information describing the main location of the organisation." /> <purpose value="This extension extends the Organization resource to support the exchange of information on the Organization's main location, as a reference to a Location resource, which is currently not supported by the FHIR standard." /> <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="Organization" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="The main location of the organisation" /> <definition value="An extension which references the main location of the organisation." /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Reference to the main location of an organization" /> <definition value="Reference to the main location of an organization." /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" /> </type> </element> <element id="Extension.value[x].identifier.assigner"> <path value="Extension.value[x].identifier.assigner" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-MainLocation", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation", "version": "2.1.0", "name": "ExtensionUKCoreMainLocation", "title": "Extension UK Core Main Location", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "Information describing the main location of the organisation.", "purpose": "This extension extends the Organization resource to support the exchange of information on the Organization's main location, as a reference to a Location resource, which is currently not supported by the FHIR standard.", "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": "Organization" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The main location of the organisation", "definition": "An extension which references the main location of the organisation." }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Reference to the main location of an organization", "definition": "Reference to the main location of an organization.", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" ] } ] }, { "id": "Extension.value[x].identifier.assigner", "path": "Extension.value[x].identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" ] } ] } ] } }
Examples
Organization - An example to illustrate the extension of an organization to carry the main location of that organisation.StructureDefinition Extension-UKCore-MedicationRepeatInformation
The specific repeat information of a medication item.
Purpose
This extension extends the MedicationRequest resource to support the exchange of repeat medications, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | MedicationRequest |
Snapshot View
Differential View
Hybrid View
Table View
| Extension | ..1 | |
| Extension.extension | .. | |
| Extension.extension | ..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | unsignedInt | 1.. |
| Extension.extension | ..1 | |
| Extension.extension.url | .. | |
| Extension.extension.value[x] | dateTime | 1.. |
| Extension.url | .. | |
| Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-MedicationRepeatInformation" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation" /> <version value="2.1.0" /> <name value="ExtensionUKCoreMedicationRepeatInformation" /> <title value="Extension UK Core Medication Repeat Information" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="The specific repeat information of a medication item." /> <purpose value="This extension extends the MedicationRequest resource to support the exchange of repeat medications, which is currently not supported by the FHIR standard." /> <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="MedicationRequest" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Medication repeat information" /> <definition value="Medication repeat information." /> <max value="1" /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Extension.extension:numberOfPrescriptionsIssued"> <path value="Extension.extension" /> <sliceName value="numberOfPrescriptionsIssued" /> <short value="Number of prescriptions issued" /> <definition value="Number of prescriptions issued." /> <max value="1" /> </element> <element id="Extension.extension:numberOfPrescriptionsIssued.url"> <path value="Extension.extension.url" /> <fixedUri value="numberOfPrescriptionsIssued" /> </element> <element id="Extension.extension:numberOfPrescriptionsIssued.value[x]"> <path value="Extension.extension.value[x]" /> <short value="Number of prescriptions issued" /> <definition value="Number of prescriptions issued." /> <min value="1" /> <type> <code value="unsignedInt" /> </type> </element> <element id="Extension.extension:authorisationExpiryDate"> <path value="Extension.extension" /> <sliceName value="authorisationExpiryDate" /> <short value="Repeat prescription review date" /> <definition value="Repeat prescription review date." /> <max value="1" /> </element> <element id="Extension.extension:authorisationExpiryDate.url"> <path value="Extension.extension.url" /> <fixedUri value="authorisationExpiryDate" /> </element> <element id="Extension.extension:authorisationExpiryDate.value[x]"> <path value="Extension.extension.value[x]" /> <short value="Repeat prescription review date" /> <definition value="Repeat prescription review date." /> <min value="1" /> <type> <code value="dateTime" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-MedicationRepeatInformation", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation", "version": "2.1.0", "name": "ExtensionUKCoreMedicationRepeatInformation", "title": "Extension UK Core Medication Repeat Information", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "The specific repeat information of a medication item.", "purpose": "This extension extends the MedicationRequest resource to support the exchange of repeat medications, which is currently not supported by the FHIR standard.", "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": "MedicationRequest" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Medication repeat information", "definition": "Medication repeat information.", "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Extension.extension:numberOfPrescriptionsIssued", "path": "Extension.extension", "sliceName": "numberOfPrescriptionsIssued", "short": "Number of prescriptions issued", "definition": "Number of prescriptions issued.", "max": "1" }, { "id": "Extension.extension:numberOfPrescriptionsIssued.url", "path": "Extension.extension.url", "fixedUri": "numberOfPrescriptionsIssued" }, { "id": "Extension.extension:numberOfPrescriptionsIssued.value[x]", "path": "Extension.extension.value[x]", "short": "Number of prescriptions issued", "definition": "Number of prescriptions issued.", "min": 1, "type": [ { "code": "unsignedInt" } ] }, { "id": "Extension.extension:authorisationExpiryDate", "path": "Extension.extension", "sliceName": "authorisationExpiryDate", "short": "Repeat prescription review date", "definition": "Repeat prescription review date.", "max": "1" }, { "id": "Extension.extension:authorisationExpiryDate.url", "path": "Extension.extension.url", "fixedUri": "authorisationExpiryDate" }, { "id": "Extension.extension:authorisationExpiryDate.value[x]", "path": "Extension.extension.value[x]", "short": "Repeat prescription review date", "definition": "Repeat prescription review date.", "min": 1, "type": [ { "code": "dateTime" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
StructureDefinition Extension-UKCore-MedicationPrescribing Organization
This describes the type of organisation or setting responsible for authorising and issuing a medication, but not the organisation or setting delivering the patient care.
Purpose
This extension extends the MedicationStatement resource to hold the type of organisation or setting responsible for authorising and issuing a medication, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | MedicationStatement |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-MedicationPrescribingOrganization" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganization" /> <version value="1.0.0" /> <name value="ExtensionUKCoreMedicationPrescribingOrganization" /> <title value="Extension UK Core Medication Prescribing Organization" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="This describes the type of organisation or setting responsible for authorising and issuing a medication, but not the organisation or setting delivering the patient care." /> <purpose value="This extension extends the MedicationStatement resource to hold the type of organisation or setting responsible for authorising and issuing a medication, which is currently not supported by the FHIR standard." /> <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="MedicationStatement" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="The type of organisation or setting responsible for authorising and issuing a medication" /> <definition value="This extension carries the type of organisation or setting responsible for authorising and issuing a medication." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganization" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The type of organisation or setting responsible for authorising and issuing a medication" /> <definition value="A value for the type of organisation or setting responsible for authorising and issuing a medication." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationPrescribingOrganization" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-MedicationPrescribingOrganization", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganization", "version": "1.0.0", "name": "ExtensionUKCoreMedicationPrescribingOrganization", "title": "Extension UK Core Medication Prescribing Organization", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "This describes the type of organisation or setting responsible for authorising and issuing a medication, but not the organisation or setting delivering the patient care.", "purpose": "This extension extends the MedicationStatement resource to hold the type of organisation or setting responsible for authorising and issuing a medication, which is currently not supported by the FHIR standard.", "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": "MedicationStatement" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The type of organisation or setting responsible for authorising and issuing a medication", "definition": "This extension carries the type of organisation or setting responsible for authorising and issuing a medication.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganization" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The type of organisation or setting responsible for authorising and issuing a medication", "definition": "A value for the type of organisation or setting responsible for authorising and issuing a medication.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationPrescribingOrganization" } } ] } }
StructureDefinition Extension-UKCore-MedicationStatementLastIssueDate
This describes the date when a prescription was last issued.
Purpose
This extension extends the MedicationStatement resource to support the exchange of the date information when a prescription was last issued, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | MedicationStatement |
Differential View
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-MedicationStatementLastIssueDate" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate" /> <version value="2.1.0" /> <name value="ExtensionUKCoreMedicationStatementLastIssueDate" /> <title value="Extension UKCore Medication Statement Last Issue Date" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="This describes the date when a prescription was last issued." /> <purpose value="This extension extends the MedicationStatement resource to support the exchange of the date information when a prescription was last issued, which is currently not supported by the FHIR standard." /> <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="MedicationStatement" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="The date when a prescription was last issued" /> <definition value="This extension supports the exchange of the date information when a prescription was last issued." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The date when a prescription was last issued" /> <definition value="This carries the date when a prescription was last issued." /> <min value="1" /> <type> <code value="dateTime" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-MedicationStatementLastIssueDate", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate", "version": "2.1.0", "name": "ExtensionUKCoreMedicationStatementLastIssueDate", "title": "Extension UKCore Medication Statement Last Issue Date", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "This describes the date when a prescription was last issued.", "purpose": "This extension extends the MedicationStatement resource to support the exchange of the date information when a prescription was last issued, which is currently not supported by the FHIR standard.", "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": "MedicationStatement" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The date when a prescription was last issued", "definition": "This extension supports the exchange of the date information when a prescription was last issued.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The date when a prescription was last issued", "definition": "This carries the date when a prescription was last issued.", "min": 1, "type": [ { "code": "dateTime" } ] } ] } }
StructureDefinition Extension-UKCore-MedicationTradeFamily
This Extension is used to identify a Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM).
Purpose
This Extension extends the Medication resource to allow the exchange of data to indicate a Trade Family or brand associated with a medication which is note currently support by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Medication |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-MedicationTradeFamily" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily" /> <version value="1.0.0" /> <name value="ExtensionUKCoreMedicationTradeFamily" /> <title value="Extension UK Core Medication Trade Family" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="This Extension is used to identify a Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM)." /> <purpose value="This Extension extends the Medication resource to allow the exchange of data to indicate a Trade Family or brand associated with a medication." /> <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="Medication" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An extension used to identify a Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM)." /> <definition value="An extension used to identify a Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM).." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="A code from the SNOMED Clinical Terminology UK coding system to record a Trade Family associated with a Medication" /> <definition value="A code from the SNOMED Clinical Terminology UK coding system to record a Trade Family associated with a Medication." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationTradeFamily" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-MedicationTradeFamily", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily", "version": "1.0.0", "name": "ExtensionUKCoreMedicationTradeFamily", "title": "Extension UK Core Medication Trade Family", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "This Extension is used to identify a Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM).", "purpose": "This Extension extends the Medication resource to allow the exchange of data to indicate a Trade Family or brand associated with a medication.", "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": "Medication" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension used to identify a Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM).", "definition": "An extension used to identify a Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM)..", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "A code from the SNOMED Clinical Terminology UK coding system to record a Trade Family associated with a Medication", "definition": "A code from the SNOMED Clinical Terminology UK coding system to record a Trade Family associated with a Medication.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationTradeFamily" } } ] } }
StructureDefinition Extension-UKCore-NHSNumberVerificationStatus
Information describing the verification and tracing status of a patient's NHS Number.
Purpose
This extension extends the identifier element of the Patient resource to support the exchange of information on the verification and tracing status of a Patient's NHS Number, as a Codeable Concept. This is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Patient.identifier |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-NHSNumberVerificationStatus" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus" /> <version value="2.1.0" /> <name value="ExtensionUKCoreNHSNumberVerificationStatus" /> <title value="Extension UK Core NHS Number Verification Status" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="Information describing the verification and tracing status of a patient's NHS Number." /> <purpose value="This extension extends the identifier element of the Patient resource to support the exchange of information on the verification of a Patient's NHS number. This is currently not supported by the FHIR standard." /> <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="Patient.identifier" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="NHS number verification status" /> <definition value="The verification/tracing status of the NHS number." /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Verification status of the NHS number" /> <definition value="Verification status of the NHS number." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-NHSNumberVerificationStatus", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus", "version": "2.1.0", "name": "ExtensionUKCoreNHSNumberVerificationStatus", "title": "Extension UK Core NHS Number Verification Status", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "Information describing the verification and tracing status of a patient's NHS Number.", "purpose": "This extension extends the identifier element of the Patient resource to support the exchange of information on the verification of a Patient's NHS number. This is currently not supported by the FHIR standard.", "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": "Patient.identifier" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "NHS number verification status", "definition": "The verification/tracing status of the NHS number." }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Verification status of the NHS number", "definition": "Verification status of the NHS number.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus" } } ] } }
StructureDefinition Extension-UKCore-OtherContactSystem
Information about other contact methods which could be used in addition to those listed in ContactPoint.system.
Purpose
This extension extends the ContactPoint datatype to support the exchange of other contact system information, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | ContactPoint.system |
Snapshot View
Differential View
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-OtherContactSystem" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" /> <version value="2.1.0" /> <name value="ExtensionUKCoreOtherContactSystem" /> <title value="Extension UK Core Other Contact System" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="Information about other contact methods." /> <purpose value="This extension extends the ContactPoint datatype to support the exchange of other contact system information, which is currently not supported by the FHIR standard." /> <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="ContactPoint.system" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Other contact system" /> <definition value="Other contact system value which extends the system element in the ContactPoint datatype." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Value for other contact system" /> <definition value="A value to extend the system element in the ContactPoint datatype." /> <min value="1" /> <type> <code value="Coding" /> </type> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-OtherContactSystem" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-OtherContactSystem", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem", "version": "2.1.0", "name": "ExtensionUKCoreOtherContactSystem", "title": "Extension UK Core Other Contact System", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "Information about other contact methods.", "purpose": "This extension extends the ContactPoint datatype to support the exchange of other contact system information, which is currently not supported by the FHIR standard.", "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": "ContactPoint.system" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Other contact system", "definition": "Other contact system value which extends the system element in the ContactPoint datatype.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Value for other contact system", "definition": "A value to extend the system element in the ContactPoint datatype.", "min": 1, "type": [ { "code": "Coding" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-OtherContactSystem" } } ] } }
Examples
Richard Smith - An example to illustrate other contact methods for a patient. Example UKCore-Patient-OtherContactSystemStructureDefinition Extension-UKCore-ParentPresent
This describes whether a parent was present at the immunisation of a child.
Purpose
This extension extends the Immunization resource to support the exchange of data to indicate whether the child's parent was present at the time of the immunisation, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Immunization |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-ParentPresent" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent" /> <version value="2.1.0" /> <name value="ExtensionUKCoreParentPresent" /> <title value="Extension UK Core Parent Present" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="This describes whether a parent was present at the immunisation of a child." /> <purpose value="This extension extends the Immunization resource to support the exchange of data to indicate whether the child's parent was present at the time of the immunisation, which is currently not supported by the FHIR standard." /> <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="Immunization" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Was a parent present at an immunisation?" /> <definition value="Was a parent present at an immunisation?" /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Was a parent present at an immunisation?" /> <definition value="Was a parent present at an immunisation?" /> <min value="1" /> <type> <code value="boolean" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-ParentPresent", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent", "version": "2.1.0", "name": "ExtensionUKCoreParentPresent", "title": "Extension UK Core Parent Present", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "This describes whether a parent was present at the immunisation of a child.", "purpose": "This extension extends the Immunization resource to support the exchange of data to indicate whether the child's parent was present at the time of the immunisation, which is currently not supported by the FHIR standard.", "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": "Immunization" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Was a parent present at an immunisation?", "definition": "Was a parent present at an immunisation?", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Was a parent present at an immunisation?", "definition": "Was a parent present at an immunisation?", "min": 1, "type": [ { "code": "boolean" } ] } ] } }
StructureDefinition Extension-UKCore-PharmacistVerifiedIndicator
This Extension is used to indicate whether a pharmacist verified a medication.
Purpose
This Extension extends the MedicationStatement resource to allow the exchange of data to indicate whether a pharmacist verified the medication specified within or referenced by the medication statement, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | MedicationStatement |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-PharmacistVerifiedIndicator" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator" /> <version value="1.0.0" /> <name value="ExtensionUKCorePharmacistVerifiedIndicator" /> <title value="Extension UK Core Pharmacist Verified Indicator" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="This Extension is used to indicate whether a pharmacist verified a medication." /> <purpose value="This Extension extends the MedicationStatement resource to allow the exchange of data to indicate whether a pharmacist verified the medication specified within or referenced by the medication statement, which is currently not supported by the FHIR standard." /> <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="MedicationStatement" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Indicates whether a pharmacist verified a medication." /> <definition value="This extension is used to indicate whether a pharmacist verified a medication." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Pharmacist Verified Indicator." /> <definition value="Boolean element representing the Pharmacist Verified Indicator." /> <min value="1" /> <type> <code value="boolean" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-PharmacistVerifiedIndicator", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator", "version": "1.0.0", "name": "ExtensionUKCorePharmacistVerifiedIndicator", "title": "Extension UK Core Pharmacist Verified Indicator", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "This Extension is used to indicate whether a pharmacist verified a medication.", "purpose": "This Extension extends the MedicationStatement resource to allow the exchange of data to indicate whether a pharmacist verified the medication specified within or referenced by the medication statement, which is currently not supported by the FHIR standard.", "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": "MedicationStatement" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Indicates whether a pharmacist verified a medication.", "definition": "This extension is used to indicate whether a pharmacist verified a medication.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Pharmacist Verified Indicator.", "definition": "Boolean element representing the Pharmacist Verified Indicator.", "min": 1, "type": [ { "code": "boolean" } ] } ] } }
StructureDefinition Extension-UKCore-ResidentialStatus
Information about a patient's residential status.
Purpose
This extension extends the Patient resource to support the exchange of information about a patient's residential status, which is currently not supported by the FHIR standard.
| Context of Use | |
|---|---|
| Use on element | Patient |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-ResidentialStatus" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus" /> <version value="2.1.0" /> <name value="ExtensionUKCoreResidentialStatus" /> <title value="Extension UK Core Residential Status" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="Information about a patient's residential status." /> <purpose value="This extension extends the Patient resource to support the exchange of information about a patient's residential status, which is currently not supported by the FHIR standard." /> <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="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="The residential status of the patient" /> <definition value="The residential status of the patient. For example if this patient is a UK resident." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="The residential status of the patient" /> <definition value="The residential status of the patient. For example if this patient is a UK resident." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ResidentialStatus" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-ResidentialStatus", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus", "version": "2.1.0", "name": "ExtensionUKCoreResidentialStatus", "title": "Extension UK Core Residential Status", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "Information about a patient's residential status.", "purpose": "This extension extends the Patient resource to support the exchange of information about a patient's residential status, which is currently not supported by the FHIR standard.", "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": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The residential status of the patient", "definition": "The residential status of the patient. For example if this patient is a UK resident.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "The residential status of the patient", "definition": "The residential status of the patient. For example if this patient is a UK resident.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ResidentialStatus" } } ] } }
StructureDefinition Extension-UKCore-VaccinationProcedure
This describes the immunization procedure code.
Purpose
This extension extends the Immunization resource to support the exchange of an immunization procedure code, which is currently not supported by the FHIR standard.
Usage
Whilst there is a binding within this extension to a UKCoreVaccinationProcedure ValueSet, an additional ValueSet UKCoreVaccinationProcedureSupplementary is available that essentially extends the UKCoreVaccinationProcedure ValueSet with SNOMED concepts that some systems may have used in the past on record entries that may also be relevant to the population of the UKCoreVaccinationProcedure extension within Immunization profile instances.
| Context of Use | |
|---|---|
| Use on element | Immunization |
Snapshot View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-VaccinationProcedure" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" /> <version value="2.1.0" /> <name value="ExtensionUKCoreVaccinationProcedure" /> <title value="Extension UK Core Vaccination Procedure" /> <status value="active" /> <date value="2021-09-10" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="secretariat@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="NHS Digital" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="2" /> </telecom> </contact> <description value="This describes the immunization procedure code." /> <purpose value="This extension extends the Immunization resource to support the exchange of an immunization procedure code, which is currently not supported by the FHIR standard." /> <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="Immunization" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An extension to hold an immunization procedure code" /> <definition value="An extension to hold an immunization procedure code." /> <max value="1" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure" /> <definition value="A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-VaccinationProcedure", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure", "version": "2.1.0", "name": "ExtensionUKCoreVaccinationProcedure", "title": "Extension UK Core Vaccination Procedure", "status": "active", "date": "2021-09-10", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "secretariat@hl7.org.uk", "use": "work", "rank": 1 } ] }, { "name": "NHS Digital", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 2 } ] } ], "description": "This describes the immunization procedure code.", "purpose": "This extension extends the Immunization resource to support the exchange of an immunization procedure code, which is currently not supported by the FHIR standard.", "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": "Immunization" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An extension to hold an immunization procedure code", "definition": "An extension to hold an immunization procedure code.", "max": "1" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure", "definition": "A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure" } } ] } }
StructureDefinition Common Extension-organization-period
The date range that this organization should be considered available.
Status: draft. Extension maintained by: HL7.
This FHIR common extension is included to allow UK specific guidance and a UK relevant example.
| Context of Use | |
|---|---|
| Use on element | Organization |
Snapshot View
Differential View
Hybrid View
Table View
| Extension | 0..1 | |
| Extension.id | System.String | 0..1 |
| Extension.extension | Extension | 0..0 |
| Extension.url | System.String | 1..1 |
| Extension.value[x] | Period | 1..1 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="organization-period" /> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="pa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1" /> </extension> <url value="http://hl7.org/fhir/StructureDefinition/organization-period" /> <version value="4.0.1" /> <name value="period" /> <title value="Period" /> <status value="draft" /> <date value="2015-02-21" /> <publisher value="Health Level Seven, Inc. - FHIR WG" /> <contact> <telecom> <system value="url" /> <value value="HL7" /> </telecom> </contact> <description value="The date range that this organization should be considered available." /> <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="Organization" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <snapshot> <element id="Extension"> <path value="Extension" /> <short value="Extension" /> <definition value="The date range that this organization should be considered available." /> <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" /> </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/organization-period" /> <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="Period" /> </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" /> <definition value="The date range that this organization should be considered available." /> <min value="0" /> <max value="1" /> </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/organization-period" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <min value="1" /> <type> <code value="Period" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "organization-period", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/organization-period", "version": "4.0.1", "name": "period", "title": "Period", "status": "draft", "date": "2015-02-21", "publisher": "Health Level Seven, Inc. - FHIR WG", "contact": [ { "telecom": [ { "system": "url", "value": "HL7" } ] } ], "description": "The date range that this organization should be considered available.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Organization" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Extension", "definition": "The date range that this organization should be considered available.", "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 }, { "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/organization-period", "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": "Period" } ], "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", "definition": "The date range that this organization should be considered available.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/organization-period" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "Period" } ] } ] } }
JSON View
{ "resourceType": "StructureDefinition", "id": "organization-period", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/organization-period", "version": "4.0.1", "name": "period", "title": "Period", "status": "draft", "date": "2015-02-21", "publisher": "Health Level Seven, Inc. - FHIR WG", "contact": [ { "telecom": [ { "system": "url", "value": "HL7" } ] } ], "description": "The date range that this organization should be considered available.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Organization" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Extension", "definition": "The date range that this organization should be considered available.", "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 }, { "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/organization-period", "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": "Period" } ], "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", "definition": "The date range that this organization should be considered available.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/organization-period" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "Period" } ] } ] } }
Examples
Example OrganizationPeriodStructureDefinition Common Extension-patient-birthPlace
The registered place of birth of the patient. A system may use the address.text if they don't store the birthPlace address in discrete elements.
Status: draft. Extension maintained by: HL7.
This FHIR common extension is included to allow UK specific guidance and a UK relevant example.
| Context of Use | |
|---|---|
| Use on element | Patient |
Snapshot View
Differential View
Hybrid View
Table View
| Extension | 0..1 | |
| Extension.id | System.String | 0..1 |
| Extension.extension | Extension | 0..0 |
| Extension.url | System.String | 1..1 |
| Extension.value[x] | Address | 1..1 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="patient-birthPlace" /> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="pa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1" /> </extension> <url value="http://hl7.org/fhir/StructureDefinition/patient-birthPlace" /> <version value="4.0.1" /> <name value="birthPlace" /> <title value="Birth Place" /> <status value="draft" /> <date value="2019-11-01T09:29:23+11:00" /> <publisher value="HL7" /> <description value="The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements." /> <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="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <snapshot> <element id="Extension"> <path value="Extension" /> <short value="Place of Birth for patient" /> <definition value="The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements." /> <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" /> </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/patient-birthPlace" /> <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="Address" /> </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="Place of Birth for patient" /> <definition value="The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements." /> <min value="0" /> <max value="1" /> </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/patient-birthPlace" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <min value="1" /> <type> <code value="Address" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-birthPlace", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace", "version": "4.0.1", "name": "birthPlace", "title": "Birth Place", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Place of Birth for patient", "definition": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.", "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 }, { "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/patient-birthPlace", "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": "Address" } ], "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": "Place of Birth for patient", "definition": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "Address" } ] } ] } }
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-birthPlace", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace", "version": "4.0.1", "name": "birthPlace", "title": "Birth Place", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Place of Birth for patient", "definition": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.", "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 }, { "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/patient-birthPlace", "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": "Address" } ], "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": "Place of Birth for patient", "definition": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "Address" } ] } ] } }
Examples
Example patientBirthPlaceStructureDefinition Common Extension-patient-birtTime
The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Status: draft. Extension maintained by: HL7.
This FHIR common extension is included to allow UK specific guidance and a UK relevant example.
| Context of Use | |
|---|---|
| Use on element | Patient.birthDate |
Snapshot View
Differential View
Hybrid View
Table View
| Extension | 0..1 | |
| Extension.id | System.String | 0..1 |
| Extension.extension | Extension | 0..0 |
| Extension.url | System.String | 1..1 |
| Extension.value[x] | dateTime | 1..1 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="patient-birthTime" /> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="pa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1" /> </extension> <url value="http://hl7.org/fhir/StructureDefinition/patient-birthTime" /> <version value="4.0.1" /> <name value="birthTime" /> <title value="Birth Time" /> <status value="draft" /> <date value="2019-11-01T09:29:23+11:00" /> <publisher value="HL7" /> <description value="The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively." /> <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="Patient.birthDate" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <snapshot> <element id="Extension"> <path value="Extension" /> <short value="Time of day of birth" /> <definition value="The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively." /> <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" /> </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/patient-birthTime" /> <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="dateTime" /> </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="Time of day of birth" /> <definition value="The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively." /> <min value="0" /> <max value="1" /> </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/patient-birthTime" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <min value="1" /> <type> <code value="dateTime" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-birthTime", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime", "version": "4.0.1", "name": "birthTime", "title": "Birth Time", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient.birthDate" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Time of day of birth", "definition": "The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.", "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 }, { "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/patient-birthTime", "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": "dateTime" } ], "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": "Time of day of birth", "definition": "The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-birthTime" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "dateTime" } ] } ] } }
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-birthTime", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime", "version": "4.0.1", "name": "birthTime", "title": "Birth Time", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient.birthDate" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Time of day of birth", "definition": "The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.", "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 }, { "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/patient-birthTime", "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": "dateTime" } ], "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": "Time of day of birth", "definition": "The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-birthTime" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "dateTime" } ] } ] } }
Examples
Example patientBirthTimeStructureDefinition Common Extension-patient-cadavericDonor
Flag indicating whether the patient authorized the donation of body parts after death.
Status: draft. Extension maintained by: HL7.
This FHIR common extension is included to allow UK specific guidance and a UK relevant example.
| Context of Use | |
|---|---|
| Use on element | Patient |
Snapshot View
Differential View
Hybrid View
Table View
| Extension | 0..1 | |
| Extension.id | System.String | 0..1 |
| Extension.extension | Extension | 0..0 |
| Extension.url | System.String | 1..1 |
| Extension.value[x] | boolean | 1..1 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="patient-cadavericDonor" /> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="pa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1" /> </extension> <url value="http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" /> <version value="4.0.1" /> <name value="cadavericDonor" /> <title value="cadavericDonor" /> <status value="draft" /> <date value="2019-11-01T09:29:23+11:00" /> <publisher value="HL7" /> <description value="Flag indicating whether the patient authorized the donation of body parts after death." /> <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="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <snapshot> <element id="Extension"> <path value="Extension" /> <short value="Post-mortem donor status" /> <definition value="Flag indicating whether the patient authorized the donation of body parts after death." /> <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" /> </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/patient-cadavericDonor" /> <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="boolean" /> </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="Post-mortem donor status" /> <definition value="Flag indicating whether the patient authorized the donation of body parts after death." /> <min value="0" /> <max value="1" /> </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/patient-cadavericDonor" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <min value="1" /> <type> <code value="boolean" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-cadavericDonor", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor", "version": "4.0.1", "name": "cadavericDonor", "title": "cadavericDonor", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "Flag indicating whether the patient authorized the donation of body parts after death.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Post-mortem donor status", "definition": "Flag indicating whether the patient authorized the donation of body parts after death.", "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 }, { "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/patient-cadavericDonor", "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": "boolean" } ], "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": "Post-mortem donor status", "definition": "Flag indicating whether the patient authorized the donation of body parts after death.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "boolean" } ] } ] } }
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-cadavericDonor", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor", "version": "4.0.1", "name": "cadavericDonor", "title": "cadavericDonor", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "Flag indicating whether the patient authorized the donation of body parts after death.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Post-mortem donor status", "definition": "Flag indicating whether the patient authorized the donation of body parts after death.", "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 }, { "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/patient-cadavericDonor", "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": "boolean" } ], "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": "Post-mortem donor status", "definition": "Flag indicating whether the patient authorized the donation of body parts after death.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "boolean" } ] } ] } }
Examples
Example patientCadavericDonorStructureDefinition Common Extension-patient-InterpreterRequired
This Patient requires an interpreter to communicate healthcare information to the practitioner.
The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.
Status: draft. Extension maintained by: HL7.
This FHIR common extension is included to allow UK specific guidance and a UK relevant example.
| Context of Use | |
|---|---|
| Use on element | Patient |
Snapshot View
Differential View
Hybrid View
Table View
| Extension | 0..1 | |
| Extension.id | System.String | 0..1 |
| Extension.extension | Extension | 0..0 |
| Extension.url | System.String | 1..1 |
| Extension.value[x] | boolean | 1..1 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="patient-interpreterRequired" /> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="pa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1" /> </extension> <url value="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" /> <version value="4.0.1" /> <name value="interpreterRequired" /> <title value="interpreterRequired" /> <status value="draft" /> <date value="2019-11-01T09:29:23+11:00" /> <publisher value="HL7" /> <description value="This Patient requires an interpreter to communicate healthcare information to the practitioner." /> <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="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <snapshot> <element id="Extension"> <path value="Extension" /> <short value="Whether the patient needs an interpreter" /> <definition value="This Patient requires an interpreter to communicate healthcare information to the practitioner." /> <comment value="The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required." /> <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" /> </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/patient-interpreterRequired" /> <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="boolean" /> </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="Whether the patient needs an interpreter" /> <definition value="This Patient requires an interpreter to communicate healthcare information to the practitioner." /> <comment value="The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required." /> <min value="0" /> <max value="1" /> </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/patient-interpreterRequired" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <min value="1" /> <type> <code value="boolean" /> </type> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-interpreterRequired", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired", "version": "4.0.1", "name": "interpreterRequired", "title": "interpreterRequired", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "This Patient requires an interpreter to communicate healthcare information to the practitioner.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Whether the patient needs an interpreter", "definition": "This Patient requires an interpreter to communicate healthcare information to the practitioner.", "comment": "The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.", "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 }, { "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/patient-interpreterRequired", "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": "boolean" } ], "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": "Whether the patient needs an interpreter", "definition": "This Patient requires an interpreter to communicate healthcare information to the practitioner.", "comment": "The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "boolean" } ] } ] } }
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-interpreterRequired", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired", "version": "4.0.1", "name": "interpreterRequired", "title": "interpreterRequired", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "This Patient requires an interpreter to communicate healthcare information to the practitioner.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "Whether the patient needs an interpreter", "definition": "This Patient requires an interpreter to communicate healthcare information to the practitioner.", "comment": "The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.", "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 }, { "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/patient-interpreterRequired", "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": "boolean" } ], "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": "Whether the patient needs an interpreter", "definition": "This Patient requires an interpreter to communicate healthcare information to the practitioner.", "comment": "The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.", "min": 0, "max": "1" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "boolean" } ] } ] } }
Examples
Example UKCore-InterpreterRequiredStructureDefinition Common Extension-patient-religion
The patient's professed religious affiliations.
Status: draft. Extension maintained by: HL7.
This FHIR common extension is included to allow UK specific guidance and a UK relevant example.
| Context of Use | |
|---|---|
| Use on element | Patient |
Snapshot View
| Extension | I | Extension | |
| extension | I | 0..0 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Differential View
| Extension | I | Extension | |
| extension | I | 0..0 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Hybrid View
| Extension | I | Extension | |
| extension | I | 0..0 | Extension |
| url | 1..1 | System.StringFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept |
Table View
| Extension | 0..* | |
| Extension.id | System.String | 0..1 |
| Extension.extension | Extension | 0..0 |
| Extension.url | System.String | 1..1 |
| Extension.value[x] | CodeableConcept | 1..1 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="patient-religion" /> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="pa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1" /> </extension> <url value="http://hl7.org/fhir/StructureDefinition/patient-religion" /> <version value="4.0.1" /> <name value="religion" /> <title value="religion" /> <status value="draft" /> <date value="2019-11-01T09:29:23+11:00" /> <publisher value="HL7" /> <description value="The patient's professed religious affiliations." /> <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="Patient" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <snapshot> <element id="Extension"> <path value="Extension" /> <short value="The patient's professed religious affiliations" /> <definition value="The patient's professed religious affiliations." /> <min value="0" /> <max value="*" /> <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" /> </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/patient-religion" /> <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="CodeableConcept" /> </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" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Religion" /> </extension> <strength value="extensible" /> <valueSet value="http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation" /> </binding> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> </snapshot> <differential> <element id="Extension"> <path value="Extension" /> <short value="The patient's professed religious affiliations" /> <definition value="The patient's professed religious affiliations." /> <min value="0" /> <max value="*" /> </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/patient-religion" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Religion" /> </extension> <strength value="extensible" /> <valueSet value="http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-religion", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-religion", "version": "4.0.1", "name": "religion", "title": "religion", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "The patient's professed religious affiliations.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "The patient's professed religious affiliations", "definition": "The patient's professed religious affiliations.", "min": 0, "max": "*", "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 }, { "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/patient-religion", "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": "CodeableConcept" } ], "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, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Religion" } ], "strength": "extensible", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation" }, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The patient's professed religious affiliations", "definition": "The patient's professed religious affiliations.", "min": 0, "max": "*" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-religion" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Religion" } ], "strength": "extensible", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation" } } ] } }
JSON View
{ "resourceType": "StructureDefinition", "id": "patient-religion", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/patient-religion", "version": "4.0.1", "name": "religion", "title": "religion", "status": "draft", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7", "description": "The patient's professed religious affiliations.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Patient" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "id": "Extension", "path": "Extension", "short": "The patient's professed religious affiliations", "definition": "The patient's professed religious affiliations.", "min": 0, "max": "*", "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 }, { "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/patient-religion", "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": "CodeableConcept" } ], "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, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Religion" } ], "strength": "extensible", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation" }, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "The patient's professed religious affiliations", "definition": "The patient's professed religious affiliations.", "min": 0, "max": "*" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-religion" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Religion" } ], "strength": "extensible", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation" } } ] } }