UK Core Implementation Guide 0.3.0 STU1

StructureDefinition-UKCore-MessageHeader

Defines the UK Core constraints and extensions on the MessageHeader resource for the minimal set of data to be present in a message header.

Profile Purpose

This profile carries the header data for a message exchange that is either requesting or responding to an action.

More information on FHIR messaging is available in the FHIR Standard.

Extending the MessageHeader Resource

There are two extensions to UK Core currently recommended for the UKCore-MessageHeader Profile.

  • One is a extension which acts as a placeholder to allow the MessageHeader to be extended in the short term as required by local use cases. This will use a code value pair approach without any coded values defined. This extension, if deemed useful will then be made into a more defined extension (with a tighter binding to an agreed ValueSet) when the use cases become clearer. One potential use of this extension is for a replacement for the approach used for ITK3 FHIR documents.
  • The other is a HL7 common extension Common Extension messageheader-response-request that is used to indicate the response required to a message.

Snapshot View

messageHeaderInstructionI0..*Extension(Coding)
eventCodingCoding
eventUriuri
nameΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
endpointΣ1..1url
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
nameΣ0..1string
softwareΣ0..1string
versionΣ0..1string
contactΣ I0..1ContactPoint
endpointΣ1..1url
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reasonΣ0..1CodeableConcept
identifierΣ1..1id
codeΣ1..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
definitionΣ0..1canonical(MessageDefinition)

Differential View

messageHeaderInstructionI0..*Extension(Coding)
eventCodingCoding
eventUriuri
nameΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
endpointΣ1..1url
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
nameΣ0..1string
softwareΣ0..1string
versionΣ0..1string
contactΣ I0..1ContactPoint
endpointΣ1..1url
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reasonΣ0..1CodeableConcept
identifierΣ1..1id
codeΣ1..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
definitionΣ0..1canonical(MessageDefinition)

Hybrid View

messageHeaderInstructionI0..*Extension(Coding)
eventCodingCoding
eventUriuri
nameΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
endpointΣ1..1url
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
nameΣ0..1string
softwareΣ0..1string
versionΣ0..1string
contactΣ I0..1ContactPoint
endpointΣ1..1url
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reasonΣ0..1CodeableConcept
identifierΣ1..1id
codeΣ1..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
definitionΣ0..1canonical(MessageDefinition)

Table View

MessageHeader..
MessageHeader.extension0..
MessageHeader.extensionExtension0..
MessageHeader.event[x]..
MessageHeader.destination..
MessageHeader.destination.targetReference(UK Core Device)..
MessageHeader.destination.target.identifier..
MessageHeader.destination.target.identifier.assignerReference(UK Core Organization)..
MessageHeader.destination.receiverReference(UK Core Organization | UK Core Practitioner | UK Core PractitionerRole)..
MessageHeader.destination.receiver.identifier..
MessageHeader.destination.receiver.identifier.assignerReference(UK Core Organization)..
MessageHeader.senderReference(UK Core PractitionerRole | UK Core Organization | UK Core Practitioner)..
MessageHeader.sender.identifier..
MessageHeader.sender.identifier.assignerReference(UK Core Organization)..
MessageHeader.entererReference(UK Core Practitioner | UK Core PractitionerRole)..
MessageHeader.enterer.identifier..
MessageHeader.enterer.identifier.assignerReference(UK Core Organization)..
MessageHeader.authorReference(UK Core Practitioner | UK Core PractitionerRole)..
MessageHeader.author.identifier..
MessageHeader.author.identifier.assignerReference(UK Core Organization)..
MessageHeader.responsibleReference(UK Core Organization | UK Core PractitionerRole | UK Core Practitioner)..
MessageHeader.responsible.identifier..
MessageHeader.responsible.identifier.assignerReference(UK Core Organization)..
MessageHeader.response..
MessageHeader.response.detailsReference(UK Core OperationOutcome)..
MessageHeader.response.details.identifier..
MessageHeader.response.details.identifier.assignerReference(UK Core Organization)..
MessageHeader.focus..
MessageHeader.focus.identifier..
MessageHeader.focus.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-MessageHeader" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MessageHeader" />
    <version value="2.1.0" />
    <name value="UKCoreMessageHeader" />
    <title value="UK Core MessageHeader" />
    <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="Defines the UK Core constraints and extensions on the MessageHeader resource for the minimal set of data to be present in a message header." />
    <purpose value="This profile carries the header data for a message exchange that is either requesting or responding to an action." />
    <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="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="MessageHeader" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/MessageHeader" />
    <derivation value="constraint" />
    <differential>
        <element id="MessageHeader.extension">
            <path value="MessageHeader.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="MessageHeader.extension:messageHeaderInstruction">
            <path value="MessageHeader.extension" />
            <sliceName value="messageHeaderInstruction" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction" />
            </type>
        </element>
        <element id="MessageHeader.event[x]">
            <path value="MessageHeader.event[x]" />
            <binding>
                <strength value="extensible" />
                <description value="Message event" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MessageEvent" />
            </binding>
        </element>
        <element id="MessageHeader.destination.target">
            <path value="MessageHeader.destination.target" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
            </type>
        </element>
        <element id="MessageHeader.destination.target.identifier.assigner">
            <path value="MessageHeader.destination.target.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MessageHeader.destination.receiver">
            <path value="MessageHeader.destination.receiver" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
            </type>
        </element>
        <element id="MessageHeader.destination.receiver.identifier.assigner">
            <path value="MessageHeader.destination.receiver.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MessageHeader.sender">
            <path value="MessageHeader.sender" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
            </type>
        </element>
        <element id="MessageHeader.sender.identifier.assigner">
            <path value="MessageHeader.sender.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MessageHeader.enterer">
            <path value="MessageHeader.enterer" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
            </type>
        </element>
        <element id="MessageHeader.enterer.identifier.assigner">
            <path value="MessageHeader.enterer.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MessageHeader.author">
            <path value="MessageHeader.author" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
            </type>
        </element>
        <element id="MessageHeader.author.identifier.assigner">
            <path value="MessageHeader.author.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MessageHeader.responsible">
            <path value="MessageHeader.responsible" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
            </type>
        </element>
        <element id="MessageHeader.responsible.identifier.assigner">
            <path value="MessageHeader.responsible.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MessageHeader.response.details">
            <path value="MessageHeader.response.details" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome" />
            </type>
        </element>
        <element id="MessageHeader.response.details.identifier.assigner">
            <path value="MessageHeader.response.details.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MessageHeader.focus.identifier.assigner">
            <path value="MessageHeader.focus.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": "UKCore-MessageHeader",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MessageHeader",
    "version": "2.1.0",
    "name": "UKCoreMessageHeader",
    "title": "UK Core MessageHeader",
    "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": "Defines the UK Core constraints and extensions on the MessageHeader resource for the minimal set of data to be present in a message header.",
    "purpose": "This profile carries the header data for a message exchange that is either requesting or responding to an action.",
    "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": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "MessageHeader",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "MessageHeader.extension",
                "path": "MessageHeader.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "MessageHeader.extension:messageHeaderInstruction",
                "path": "MessageHeader.extension",
                "sliceName": "messageHeaderInstruction",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MessageHeaderInstruction"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.event[x]",
                "path": "MessageHeader.event[x]",
                "binding": {
                    "strength": "extensible",
                    "description": "Message event",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MessageEvent"
                }
            },
            {
                "id": "MessageHeader.destination.target",
                "path": "MessageHeader.destination.target",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.destination.target.identifier.assigner",
                "path": "MessageHeader.destination.target.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.destination.receiver",
                "path": "MessageHeader.destination.receiver",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.destination.receiver.identifier.assigner",
                "path": "MessageHeader.destination.receiver.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.sender",
                "path": "MessageHeader.sender",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.sender.identifier.assigner",
                "path": "MessageHeader.sender.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.enterer",
                "path": "MessageHeader.enterer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.enterer.identifier.assigner",
                "path": "MessageHeader.enterer.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.author",
                "path": "MessageHeader.author",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.author.identifier.assigner",
                "path": "MessageHeader.author.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.responsible",
                "path": "MessageHeader.responsible",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.responsible.identifier.assigner",
                "path": "MessageHeader.responsible.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.response.details",
                "path": "MessageHeader.response.details",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.response.details.identifier.assigner",
                "path": "MessageHeader.response.details.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.focus.identifier.assigner",
                "path": "MessageHeader.focus.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Profile Minimum Viable Content

Each MessageHeader resource must have:

  • An event

Each MessageHeader resource should support:

  • A sender
  • An author
  • A destination

Profile specific implementation guidance:

extension:messageheaderinstruction

More information about this extension can be found using the link below.

Extension UKCore-MessageHeaderInstruction

There is currently no UK Core set of codes specified within this extension to allow consistent message header instructions to be exchanged. However, the extension contains a code/value pair which can carry whatever is required for local implementation.


event[x]

Code for the event this message represents or link to event definition.

There is currently no UK Core set of codes to allow consistent event types to be exchanged.


destination

Message destination application(s).

destination.target Particular delivery destination within the destination which should conform to the following:

destination.endpoint Mandatory - Actual destination address or id

destination.receiver Intended "real-world" recipient for the data. The referenced resource should conform to one of the following:


sender

Real world sender of the message. The referenced resource should conform to one of the following:


enterer

The source of the data entry. The referenced resource should conform to one of the following:


author

The source of the decision. The referenced resource should conform to one of the following:


source

Message source application. Mandatory

  • source.name Optional name of system
  • source.software Optional name of software running the system
  • source.version Optional version of software running
  • source.contact Optional human contact for problems
  • source.endpoint Mandatory actual message source address or id

responsible

Final responsibility for event. The resource being referenced should conform to one of the following:


reason

Cause of event.


response

If this is a reply to prior message.


focus

The actual content of the message. Reference to any FHIR resource where a UK Core profile exists the resource being referenced should conform to the profile.


definition

Link to the definition for this message. The referenced resource must conform to the MessageDefinition Resource.


back to top