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

NHS North West Genomics, published by NHS North West Genomics. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nw-gmsa/nw-gmsa.github.com/ and changes regularly. See the Directory of published versions

Resource Profile: Event

Official URL: https://fhir.nwgenomics.nhs.uk/StructureDefinition/Event Version: 0.1.0
Draft as of 2026-02-04 Computable Name: Event

DRAFT

Reference:

MessageHeader and MNS Schema 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"
          }
        }
      }
    }
  ]
}

Events Types

Patient

(For illustrative purposes only)

MNS Event Type Description HL7/IHE Event Type 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

DocumentRefernce

ServiceRequest

Specimen

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

Task

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 1..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 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.
.... event[x]:eventCoding SΣ 1..1 Coding Code for the event this message represents or link to event definition
Binding: hl7VS-eventCode (required)
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
.... identifier SΣ 1..1 OrganisationCode Logical reference, when literal reference is not known
... source Σ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... Slices for focus SΣ 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type
.... focus:Patient SΣ 1..1 Reference(Patient) The actual content of the message
..... identifier Σ 1..1 NHSNumber UK National Health Identifiers: NHS NUMBER (England and Wales)
.... focus:Resource SΣ 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 📦2.0.0 THO v7.0

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... meta
.... lastUpdated S 1..1 instant When the resource version last changed
... 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
.... event[x]:eventCoding S 1..1 Coding Code for the event this message represents or link to event definition
Binding: hl7VS-eventCode (required)
... sender
.... identifier S 1..1 OrganisationCode Logical reference, when literal reference is not known
... Slices for focus S 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type
.... focus:Patient S 1..1 Reference(Patient) The actual content of the message
..... identifier 1..1 NHSNumber UK National Health Identifiers: NHS NUMBER (England and Wales)
.... focus:Resource S 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 📦2.0.0 THO v7.0
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 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.
.... event[x]:eventCoding SΣ 1..1 Coding Code for the event this message represents or link to event definition
Binding: hl7VS-eventCode (required)
... destination Σ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 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).
.... identifier SΣ 1..1 OrganisationCode Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
... response Σ 0..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 1..1 id Id of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... Slices for focus SΣ 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type
.... focus:Patient SΣ 1..1 Reference(Patient) The actual content of the message
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).
..... identifier Σ 1..1 NHSNumber UK National Health Identifiers: NHS NUMBER (England and Wales)
..... display Σ 0..1 string Text alternative for the resource
.... focus:Resource SΣ 0..1 Reference(Resource) The actual content of the message
... definition Σ 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 📦2.0.0 THO v7.0
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
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

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: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 1..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 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.
.... event[x]:eventCoding SΣ 1..1 Coding Code for the event this message represents or link to event definition
Binding: hl7VS-eventCode (required)
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
.... identifier SΣ 1..1 OrganisationCode Logical reference, when literal reference is not known
... source Σ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... Slices for focus SΣ 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type
.... focus:Patient SΣ 1..1 Reference(Patient) The actual content of the message
..... identifier Σ 1..1 NHSNumber UK National Health Identifiers: NHS NUMBER (England and Wales)
.... focus:Resource SΣ 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 📦2.0.0 THO v7.0

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... meta
.... lastUpdated S 1..1 instant When the resource version last changed
... 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
.... event[x]:eventCoding S 1..1 Coding Code for the event this message represents or link to event definition
Binding: hl7VS-eventCode (required)
... sender
.... identifier S 1..1 OrganisationCode Logical reference, when literal reference is not known
... Slices for focus S 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type
.... focus:Patient S 1..1 Reference(Patient) The actual content of the message
..... identifier 1..1 NHSNumber UK National Health Identifiers: NHS NUMBER (England and Wales)
.... focus:Resource S 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 📦2.0.0 THO v7.0

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 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.
.... event[x]:eventCoding SΣ 1..1 Coding Code for the event this message represents or link to event definition
Binding: hl7VS-eventCode (required)
... destination Σ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 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).
.... identifier SΣ 1..1 OrganisationCode Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
... response Σ 0..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 1..1 id Id of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... Slices for focus SΣ 1..2 Reference(Resource) The actual content of the message
Slice: Unordered, Open by value:type
.... focus:Patient SΣ 1..1 Reference(Patient) The actual content of the message
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).
..... identifier Σ 1..1 NHSNumber UK National Health Identifiers: NHS NUMBER (England and Wales)
..... display Σ 0..1 string Text alternative for the resource
.... focus:Resource SΣ 0..1 Reference(Resource) The actual content of the message
... definition Σ 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 📦2.0.0 THO v7.0
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
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

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