NHS North West Genomics
2.2.5 - ci-build United Kingdom flag

NHS North West Genomics - Local Development build (v2.2.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Event Notification (MessageHeader)

Official URL: https://fhir.nwgenomics.nhs.uk/StructureDefinition/EventNotification Version: 2.2.5
Draft as of 2026-11-05 Computable Name: EventNotification

Messaging Event Messsage

Reference:

Events Types

Patient

(For illustrative purposes only)

MNS Event Type Description HL7/IHE Event Trigger Description
    A28 Add person information
pds-change-of-gp-2   A31 Update person information
pds-death-notification-2   A31  
gpreg-change-gp-req-1   A31  
nhs-number-change-2   A40? Merge patient - patient identifier list

DiagnosticReport

MNS Event Type Description HL7/IHE Event Trigger Description
    R01 Unsolicited Observation Message

DocumentReference

MNS Event Type Description HL7/IHE Event Trigger Description
    T01 Original document notification

ServiceRequest

MNS Event Type Description HL7/IHE Event Trigger Description
    O01  
    O21 Laboratory order

Specimen

MNS Event Type Description HL7/IHE Event Trigger Description
    Events are defined in IHE Specimen Event Tracking  

Task

NHS England Multicase Notification Mapping

This mapping is based on this example from MNS for pds-change-of-gp2

{
"specversion": "1.0",
"id": "56e9d7db-d70a-48bf-95f8-e779a741382a",
"source": "https://fhir.nhs.uk/Id/nhsSpineASID/477121000324",
"type": "pds-change-of-gp-2",
"time": "2020-06-01T13:00:00Z",
"dataref": "https://api.service.nhs.uk/personal-demographics/FHIR/R4/Patient/9912003888",
"subject": "9912003888"
}
MNS Element FHIR Event (MessageHeader) FHIR Bundle (message)
id   Bundle.identifier
source MessageHeader.source.endpoint  
type MessageHeader.eventCoding.code  
time   Bundle.timestamp
subject MessageHeader.focus[patient].reference.identifier.value  
dataref MessageHeader.focus[resource].reference  

The MNS example above is for a pds-change-of-gp-2 event and is mapped to FHIR as

{
  "resourceType": "Bundle",
  "identifier": {
    "value": "56e9d7db-d70a-48bf-95f8-e779a741382a"
  },
  "type": "message",
  "timestamp": "2020-06-01T13:00:00Z",
  "entry": [
    {
      "fullUrl": "urn:uuid:9a7e9fd9-d774-42ef-bd23-4397a1ba1b63",
      "resource": {
        "resourceType": "MessageHeader",
        "eventCoding": {
          "code": "pds-change-of-gp-2"
        },
        "source": {
          "endpoint": "https://fhir.nhs.uk/Id/nhsSpineASID/477121000324"
        },
        "focus": [{
          "reference": "https://api.service.nhs.uk/personal-demographics/FHIR/R4/Patient/9912003888",
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9912003888"
          }
        }]
      }
    }
  ]
}

Event Notification Examples

MNS Example Converted for general use

An alternative approach would use existing event triggers in common use in the NHS. For the example above this would be A31 (Update person information) in place of pds-change-of-gp-2. In the example below, the ASID endpoints could still be used; the inclusion of ODS codes is desirable.

{
  "resourceType": "Bundle",
  "identifier": {
    "value": "56e9d7db-d70a-48bf-95f8-e779a741382a"
  },
  "type": "message",
  "timestamp": "2020-06-01T13:00:00Z",
  "entry": [
    {
      "fullUrl": "urn:uuid:9a7e9fd9-d774-42ef-bd23-4397a1ba1b63",
      "resource": {
        "resourceType": "MessageHeader",
        "eventCoding": {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0003",
          "code": "A31"
        },
        "sender": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "699X0"
          },
          "display": "NHS NW Genomics"
        },
        "source": {
          "endpoint": "https://fhir.nwgenomics.nhs.uk/Endpoint/IGENE",
          "software": "NW Genomics HIE"
        },
        "destination": [
          {
            "endpoint": "https://fhir.nwgenomics.nhs.uk/Endpoint/EPIC",
            "receiver": {
              "identifier": {
                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                "value": "R0A"
              }
            }
          }
        ],
        "focus": [{
          "reference": "https://api.service.nhs.uk/personal-demographics/FHIR/R4/Patient/9912003888",
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9912003888"
          }
        }]
      }
    }
  ]
}

Original Document Notification Example

{
  "resourceType": "Bundle",
  "identifier": {
    "value": "56e9d7db-d70a-48bf-95f8-e779a741382a"
  },
  "type": "message",
  "timestamp": "2020-06-01T13:00:00Z",
  "entry": [
    {
      "fullUrl": "urn:uuid:9a7e9fd9-d774-42ef-bd23-4397a1ba1b63",
      "resource": {
        "resourceType": "MessageHeader",
        "eventCoding": {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0003",
          "code": "T01"
        },
        "sender": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "699X0"
          },
          "display": "NHS NW Genomics"
        },
        "source": {
          "endpoint": "https://fhir.nwgenomics.nhs.uk/Endpoint/IGENE",
          "software": "NW Genomics HIE"
        },
        "destination": [
          {
            "endpoint": "https://fhir.nwgenomics.nhs.uk/Endpoint/EPIC",
            "receiver": {
              "identifier": {
                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                "value": "R0A"
              }
            }
          }
        ],
        "focus": [{
          "reference": "urn:uuid:006fffb3-0810-4c18-b943-4cc0c815c16b"
        }]
      }
    },
    {
      "fullUrl": "urn:uuid:006fffb3-0810-4c18-b943-4cc0c815c16b",
      "resource": {
        "resourceType": "DocumentReference",
        "content": [
          {
            "attachment": {
              "contentType": "application/pdf",
              "url": "https://fhir.nwgenomics.nhs.uk/Binary/T25-0209"
            }
          }
        ],
        "context": {
          "period": {
            "end": "2025-10-14T15:59:16+00:00",
            "start": "2025-10-14T15:59:16+00:00"
          },
          "related": [
            {
              "identifier": {
                "assigner": {
                  "identifier": {
                    "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                    "value": "RR8"
                  }
                },
                "type": {
                  "coding": [
                    {
                      "code": "PLAC",
                      "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
                    }
                  ]
                },
                "value": "1000152872"
              },
              "type": "ServiceRequest"
            },
            {
              "identifier": {
                "assigner": {
                  "identifier": {
                    "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                    "value": "699X0"
                  }
                },
                "system": "https://fhir.nwgenomics.nhs.uk/iGene/ReportIdentifier",
                "type": {
                  "coding": [
                    {
                      "code": "FILL",
                      "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
                    }
                  ]
                },
                "value": "T25-0209"
              },
              "type": "DiagnosticReport"
            }
          ],
          "sourcePatientInfo": {
            "identifier": {
              "assigner": {
                "identifier": {
                  "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                  "value": "RR8"
                }
              },
              "type": {
                "coding": [
                  {
                    "code": "MR",
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
                  }
                ]
              },
              "value": "L765432"
            }
          }
        },
        "custodian": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "699X0"
          },
          "type": "Organization"
        },
        "date": "2025-10-14T15:59:16+00:00",
        "identifier": [
          {
            "assigner": {
              "identifier": {
                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                "value": "699X0"
              }
            },
            "system": "https://fhir.nwgenomics.nhs.uk/iGene/ReportIdentifier",
            "type": {
              "coding": [
                {
                  "code": "FILL",
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
                }
              ]
            },
            "value": "T25-0209"
          }
        ],
        "status": "current",
        "subject": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "type": {
              "coding": [
                {
                  "code": "NH",
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
                }
              ]
            },
            "value": "9737383222"
          }
        },
        "type": {
          "coding": [
            {
              "code": "1054161000000101",
              "display": "Genetic report",
              "system": "http://snomed.info/sct"
            }
          ]
        }
      }
    }
  ]
}

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
MessageHeader.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MessageHeader.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
MessageHeader.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MessageHeader.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageHeader.Slices for event[x] This element is included in summaries. 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageHeader.Slices for event[x].event[x]:eventCoding This element must be supported. This element is included in summaries. 1..1 Coding Code for the event this message represents or link to event definition
Binding: Hl7VSEventCode (3.0.0) (required)
MessageHeader.sender This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
MessageHeader.sender.identifier This element must be supported. This element is included in summaries. 1..1 OrganisationCode Logical reference, when literal reference is not known
MessageHeader.source This element is included in summaries. 1..1 BackboneElement Message source application
MessageHeader.source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageHeader.source.endpoint This element is included in summaries. 1..1 url Actual message source address or id
MessageHeader.Slices for focus This element must be supported. This element is included in summaries. 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MessageHeader.Slices for focus.focus:Patient This element must be supported. This element is included in summaries. 1..1 Reference(Patient) The actual content of the message
MessageHeader.Slices for focus.focus:Patient.identifier This element is included in summaries. 1..1 NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
MessageHeader.Slices for focus.focus:Resource This element must be supported. This element is included in summaries. 0..1 Reference(Resource) The actual content of the message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventCoding Base required hl7VS-eventCode 📍3.0.0 THO v7.5

Constraints

Id Grade Path(s) Description Expression

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
MessageHeader.meta
MessageHeader.meta.lastUpdated This element must be supported. 1..1 instant When the resource version last changed
MessageHeader.Slices for event[x] 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
MessageHeader.Slices for event[x].event[x]:eventCoding This element must be supported. 1..1 Coding Code for the event this message represents or link to event definition
Binding: Hl7VSEventCode (3.0.0) (required)
MessageHeader.sender
MessageHeader.sender.identifier This element must be supported. 1..1 OrganisationCode Logical reference, when literal reference is not known
MessageHeader.Slices for focus This element must be supported. 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MessageHeader.Slices for focus.focus:Patient This element must be supported. 1..1 Reference(Patient) The actual content of the message
MessageHeader.Slices for focus.focus:Patient.identifier 1..1 NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
MessageHeader.Slices for focus.focus:Resource This element must be supported. 0..1 Reference(Resource) The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MessageHeader.event[x]:eventCoding Base required hl7VS-eventCode 📍3.0.0 THO v7.5
NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
MessageHeader.id This element is included in summaries. 0..1 id Logical id of this artifact
MessageHeader.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MessageHeader.meta.id 0..1 string Unique id for inter-element referencing
MessageHeader.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageHeader.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
MessageHeader.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
MessageHeader.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
MessageHeader.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
MessageHeader.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
MessageHeader.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
MessageHeader.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MessageHeader.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MessageHeader.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
MessageHeader.contained 0..* Resource Contained, inline Resources
MessageHeader.extension 0..* Extension Additional content defined by implementations
MessageHeader.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageHeader.Slices for event[x] This element is included in summaries. 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageHeader.Slices for event[x].event[x]:eventCoding This element must be supported. This element is included in summaries. 1..1 Coding Code for the event this message represents or link to event definition
Binding: Hl7VSEventCode (3.0.0) (required)
MessageHeader.destination This element is included in summaries. 0..* BackboneElement Message destination application(s)
MessageHeader.destination.id 0..1 string Unique id for inter-element referencing
MessageHeader.destination.extension 0..* Extension Additional content defined by implementations
MessageHeader.destination.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageHeader.destination.name This element is included in summaries. 0..1 string Name of system
MessageHeader.destination.target This element is included in summaries. 0..1 Reference(Device) Particular delivery destination within the destination
MessageHeader.destination.endpoint This element is included in summaries. 1..1 url Actual destination address or id
MessageHeader.destination.receiver This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
MessageHeader.sender This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
MessageHeader.sender.id 0..1 string Unique id for inter-element referencing
MessageHeader.sender.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageHeader.sender.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
MessageHeader.sender.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
MessageHeader.sender.identifier This element must be supported. This element is included in summaries. 1..1 OrganisationCode Logical reference, when literal reference is not known
MessageHeader.sender.display This element is included in summaries. 0..1 string Text alternative for the resource
MessageHeader.enterer This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
MessageHeader.author This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
MessageHeader.source This element is included in summaries. 1..1 BackboneElement Message source application
MessageHeader.source.id 0..1 string Unique id for inter-element referencing
MessageHeader.source.extension 0..* Extension Additional content defined by implementations
MessageHeader.source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageHeader.source.name This element is included in summaries. 0..1 string Name of system
MessageHeader.source.software This element is included in summaries. 0..1 string Name of software running the system
MessageHeader.source.version This element is included in summaries. 0..1 string Version of software running
MessageHeader.source.contact This element is included in summaries. 0..1 ContactPoint Human contact for problems
MessageHeader.source.endpoint This element is included in summaries. 1..1 url Actual message source address or id
MessageHeader.responsible This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
MessageHeader.reason This element is included in summaries. 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
MessageHeader.response This element is included in summaries. 0..1 BackboneElement If this is a reply to prior message
MessageHeader.response.id 0..1 string Unique id for inter-element referencing
MessageHeader.response.extension 0..* Extension Additional content defined by implementations
MessageHeader.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageHeader.response.identifier This element is included in summaries. 1..1 id Id of original message
MessageHeader.response.code This element is included in summaries. 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
MessageHeader.response.details This element is included in summaries. 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
MessageHeader.Slices for focus This element must be supported. This element is included in summaries. 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MessageHeader.Slices for focus.focus:Patient This element must be supported. This element is included in summaries. 1..1 Reference(Patient) The actual content of the message
MessageHeader.Slices for focus.focus:Patient.id 0..1 string Unique id for inter-element referencing
MessageHeader.Slices for focus.focus:Patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageHeader.Slices for focus.focus:Patient.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
MessageHeader.Slices for focus.focus:Patient.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
MessageHeader.Slices for focus.focus:Patient.identifier This element is included in summaries. 1..1 NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
MessageHeader.Slices for focus.focus:Patient.display This element is included in summaries. 0..1 string Text alternative for the resource
MessageHeader.Slices for focus.focus:Resource This element must be supported. This element is included in summaries. 0..1 Reference(Resource) The actual content of the message
MessageHeader.definition This element is included in summaries. 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MessageHeader.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
MessageHeader.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageHeader.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventCoding Base required hl7VS-eventCode 📍3.0.0 THO v7.5
MessageHeader.sender.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
MessageHeader.reason Base example Example Message Reason Codes 📍4.0.1 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍4.0.1 FHIR Std.
MessageHeader.focus:Patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.event[x]
  • The element 1 is sliced based on the value of MessageHeader.focus

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
MessageHeader.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MessageHeader.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
MessageHeader.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MessageHeader.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageHeader.Slices for event[x] This element is included in summaries. 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageHeader.Slices for event[x].event[x]:eventCoding This element must be supported. This element is included in summaries. 1..1 Coding Code for the event this message represents or link to event definition
Binding: Hl7VSEventCode (3.0.0) (required)
MessageHeader.sender This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
MessageHeader.sender.identifier This element must be supported. This element is included in summaries. 1..1 OrganisationCode Logical reference, when literal reference is not known
MessageHeader.source This element is included in summaries. 1..1 BackboneElement Message source application
MessageHeader.source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageHeader.source.endpoint This element is included in summaries. 1..1 url Actual message source address or id
MessageHeader.Slices for focus This element must be supported. This element is included in summaries. 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MessageHeader.Slices for focus.focus:Patient This element must be supported. This element is included in summaries. 1..1 Reference(Patient) The actual content of the message
MessageHeader.Slices for focus.focus:Patient.identifier This element is included in summaries. 1..1 NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
MessageHeader.Slices for focus.focus:Resource This element must be supported. This element is included in summaries. 0..1 Reference(Resource) The actual content of the message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventCoding Base required hl7VS-eventCode 📍3.0.0 THO v7.5

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
MessageHeader.meta
MessageHeader.meta.lastUpdated This element must be supported. 1..1 instant When the resource version last changed
MessageHeader.Slices for event[x] 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
MessageHeader.Slices for event[x].event[x]:eventCoding This element must be supported. 1..1 Coding Code for the event this message represents or link to event definition
Binding: Hl7VSEventCode (3.0.0) (required)
MessageHeader.sender
MessageHeader.sender.identifier This element must be supported. 1..1 OrganisationCode Logical reference, when literal reference is not known
MessageHeader.Slices for focus This element must be supported. 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MessageHeader.Slices for focus.focus:Patient This element must be supported. 1..1 Reference(Patient) The actual content of the message
MessageHeader.Slices for focus.focus:Patient.identifier 1..1 NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
MessageHeader.Slices for focus.focus:Resource This element must be supported. 0..1 Reference(Resource) The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MessageHeader.event[x]:eventCoding Base required hl7VS-eventCode 📍3.0.0 THO v7.5

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
MessageHeader.id This element is included in summaries. 0..1 id Logical id of this artifact
MessageHeader.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MessageHeader.meta.id 0..1 string Unique id for inter-element referencing
MessageHeader.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageHeader.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
MessageHeader.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
MessageHeader.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
MessageHeader.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
MessageHeader.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
MessageHeader.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
MessageHeader.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MessageHeader.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MessageHeader.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
MessageHeader.contained 0..* Resource Contained, inline Resources
MessageHeader.extension 0..* Extension Additional content defined by implementations
MessageHeader.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MessageHeader.Slices for event[x] This element is included in summaries. 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageHeader.Slices for event[x].event[x]:eventCoding This element must be supported. This element is included in summaries. 1..1 Coding Code for the event this message represents or link to event definition
Binding: Hl7VSEventCode (3.0.0) (required)
MessageHeader.destination This element is included in summaries. 0..* BackboneElement Message destination application(s)
MessageHeader.destination.id 0..1 string Unique id for inter-element referencing
MessageHeader.destination.extension 0..* Extension Additional content defined by implementations
MessageHeader.destination.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageHeader.destination.name This element is included in summaries. 0..1 string Name of system
MessageHeader.destination.target This element is included in summaries. 0..1 Reference(Device) Particular delivery destination within the destination
MessageHeader.destination.endpoint This element is included in summaries. 1..1 url Actual destination address or id
MessageHeader.destination.receiver This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
MessageHeader.sender This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
MessageHeader.sender.id 0..1 string Unique id for inter-element referencing
MessageHeader.sender.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageHeader.sender.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
MessageHeader.sender.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
MessageHeader.sender.identifier This element must be supported. This element is included in summaries. 1..1 OrganisationCode Logical reference, when literal reference is not known
MessageHeader.sender.display This element is included in summaries. 0..1 string Text alternative for the resource
MessageHeader.enterer This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
MessageHeader.author This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
MessageHeader.source This element is included in summaries. 1..1 BackboneElement Message source application
MessageHeader.source.id 0..1 string Unique id for inter-element referencing
MessageHeader.source.extension 0..* Extension Additional content defined by implementations
MessageHeader.source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageHeader.source.name This element is included in summaries. 0..1 string Name of system
MessageHeader.source.software This element is included in summaries. 0..1 string Name of software running the system
MessageHeader.source.version This element is included in summaries. 0..1 string Version of software running
MessageHeader.source.contact This element is included in summaries. 0..1 ContactPoint Human contact for problems
MessageHeader.source.endpoint This element is included in summaries. 1..1 url Actual message source address or id
MessageHeader.responsible This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
MessageHeader.reason This element is included in summaries. 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
MessageHeader.response This element is included in summaries. 0..1 BackboneElement If this is a reply to prior message
MessageHeader.response.id 0..1 string Unique id for inter-element referencing
MessageHeader.response.extension 0..* Extension Additional content defined by implementations
MessageHeader.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MessageHeader.response.identifier This element is included in summaries. 1..1 id Id of original message
MessageHeader.response.code This element is included in summaries. 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
MessageHeader.response.details This element is included in summaries. 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
MessageHeader.Slices for focus This element must be supported. This element is included in summaries. 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MessageHeader.Slices for focus.focus:Patient This element must be supported. This element is included in summaries. 1..1 Reference(Patient) The actual content of the message
MessageHeader.Slices for focus.focus:Patient.id 0..1 string Unique id for inter-element referencing
MessageHeader.Slices for focus.focus:Patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageHeader.Slices for focus.focus:Patient.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
MessageHeader.Slices for focus.focus:Patient.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
MessageHeader.Slices for focus.focus:Patient.identifier This element is included in summaries. 1..1 NHSIdentifier UK National Health Identifiers: NHS NUMBER (England and Wales)
MessageHeader.Slices for focus.focus:Patient.display This element is included in summaries. 0..1 string Text alternative for the resource
MessageHeader.Slices for focus.focus:Resource This element must be supported. This element is included in summaries. 0..1 Reference(Resource) The actual content of the message
MessageHeader.definition This element is included in summaries. 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MessageHeader.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
MessageHeader.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageHeader.event[x] Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventCoding Base required hl7VS-eventCode 📍3.0.0 THO v7.5
MessageHeader.sender.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
MessageHeader.reason Base example Example Message Reason Codes 📍4.0.1 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍4.0.1 FHIR Std.
MessageHeader.focus:Patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.event[x]
  • The element 1 is sliced based on the value of MessageHeader.focus

 

Other representations of profile: CSV, Excel, Schematron