UK Core Implementation Guide 0.5.0 - STU1

StructureDefinition Extension-UKCoreMessageHeaderInstruction

A specific instruction for receivers of a message.

Purpose

This extension extends the MessageHeader Resource to carry a specific instruction for receivers of a message, which is currently not supported by the FHIR standard.

Context of Use
Use on element MessageHeader

Snapshot View

url1..1System.StringFixed Value
valueCodingCoding

Differential View

url1..1System.StringFixed Value
valueCodingCoding

Hybrid View

url1..1System.StringFixed Value
valueCodingCoding

Table View

Extension..
Extension.url..
Extension.value[x]Coding1..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-MessageHeaderInstruction" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction" />
    <version value="1.0.0" />
    <name value="ExtensionUKCoreMessageHeaderInstruction" />
    <title value="Extension UKCore Message Header Instruction" />
    <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 Message Header Instruction extension is provided to carry a specific instruction for receivers of the message." />
    <purpose value="This extension extends the Message Header resource to support the exchange of a specific instruction to specify additional receiver behaviour - this could be locally or nationally defined - which is currently not supported by the FHIR standard." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; 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="MessageHeader" />
    </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 carry a specific instruction for receivers of the message." />
            <definition value="An extension to carry a specific instruction for receivers of the message." />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="The Instruction for receivers of the message." />
            <definition value="The Instruction for receivers of the message expressed as a code and display value of the valueSet used." />
            <min value="1" />
            <type>
                <code value="Coding" />
            </type>
            <binding>
                <strength value="extensible" />
                <description value="Message Header Instruction" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MessageHeaderInstruction" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-MessageHeaderInstruction",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction",
    "version": "1.0.0",
    "name": "ExtensionUKCoreMessageHeaderInstruction",
    "title": "Extension UKCore Message Header Instruction",
    "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 Message Header Instruction extension is provided to carry a specific instruction for receivers of the message.",
    "purpose": "This extension extends the Message Header resource to support the exchange of a specific instruction to specify additional receiver behaviour - this could be locally or nationally defined - 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": "MessageHeader"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "An extension to carry a specific instruction for receivers of the message.",
                "definition": "An extension to carry a specific instruction for receivers of the message."
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "The Instruction for receivers of the message.",
                "definition": "The Instruction for receivers of the message expressed as a code and display value of the valueSet used.",
                "min": 1,
                "type":  [
                    {
                        "code": "Coding"
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "description": "Message Header Instruction",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MessageHeaderInstruction"
                }
            }
        ]
    }
}

back to top