Belgian MyCareNet Profiles
2.2.1 - STU Belgium flag

Belgian MyCareNet Profiles, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/mycarenet/ and changes regularly. See the Directory of published versions

Resource Profile: MyCareNet MessageHeader BE profile

Official URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-messageheader Version: 2.2.1
Standards status: Trial-use Maturity Level: 1 Computable Name: BeMyCareNetMessageHeader
Other Identifiers: OID:2.16.840.1.113883.4.642.40.200.6.42.14

This is the generic MessageHeader profile for use in the different eAgreement flows from MyCareNet.

Usages:

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.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
MessageHeader.meta This element must be supported. This element is included in summaries. 1..1 Meta Metadata about the resource
MessageHeader.meta.profile This element is included in summaries. 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
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 must be supported. This element is included in summaries. 1..1 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.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
MessageHeader.Slices for event[x].eventCoding Coding
MessageHeader.Slices for event[x].eventUri uri
MessageHeader.Slices for event[x].event[x]:eventCoding This element is included in summaries. 0..1 Coding Code for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageHeader.Slices for event[x].event[x]:eventCoding.system This element is included in summaries. 1..1 uri Identity of the terminology system
MessageHeader.Slices for event[x].event[x]:eventCoding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
MessageHeader.destination This element must be supported. This element is included in summaries. 1..1 BackboneElement Message destination application(s)
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.endpoint This element is included in summaries. 1..1 url Actual destination address or id
MessageHeader.sender This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
MessageHeader.sender.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
MessageHeader.source This element must be supported. 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.response This element must be supported. This element is included in summaries. 0..1 BackboneElement If this is a reply to prior message
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.focus This element must be supported. This element is included in summaries. 1..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 example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventUri Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader MessageHeader
MessageHeader.id This element must be supported. 1..1 id Logical id of this artifact
MessageHeader.meta This element must be supported. 1..1 Meta Metadata about the resource
MessageHeader.meta.profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
MessageHeader.Slices for event[x] This element must be supported. 1..1 Coding, uri Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
MessageHeader.Slices for event[x].event[x]:eventCoding 0..1 Coding Code for the event this message represents or link to event definition
MessageHeader.Slices for event[x].event[x]:eventCoding.system 1..1 uri Identity of the terminology system
MessageHeader.Slices for event[x].event[x]:eventCoding.code 1..1 code Symbol in syntax defined by the system
MessageHeader.sender This element must be supported. 1..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
MessageHeader.sender.reference 1..1 string Literal reference, Relative, internal or absolute URL
MessageHeader.enterer 0..0 The source of the data entry
MessageHeader.author 0..0 The source of the decision
MessageHeader.source This element must be supported. 1..1 BackboneElement Message source application
MessageHeader.responsible 0..0 Final responsibility for event
MessageHeader.reason 0..0 Cause of event
MessageHeader.response This element must be supported. 0..1 BackboneElement If this is a reply to prior message
MessageHeader.focus This element must be supported. 1..1 Reference(Resource) The actual content of the message
MessageHeader.definition 0..0 Link to the definition for this message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
MessageHeader.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
MessageHeader.meta This element must be supported. This element is included in summaries. 1..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 is included in summaries. 0..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. 1..1 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 must be supported. This element is included in summaries. 1..1 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.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
MessageHeader.Slices for event[x].eventCoding Coding
MessageHeader.Slices for event[x].eventUri uri
MessageHeader.Slices for event[x].event[x]:eventCoding This element is included in summaries. 0..1 Coding Code for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageHeader.Slices for event[x].event[x]:eventCoding.id 0..1 string Unique id for inter-element referencing
MessageHeader.Slices for event[x].event[x]:eventCoding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageHeader.Slices for event[x].event[x]:eventCoding.system This element is included in summaries. 1..1 uri Identity of the terminology system
MessageHeader.Slices for event[x].event[x]:eventCoding.version This element is included in summaries. 0..1 string Version of the system - if relevant
MessageHeader.Slices for event[x].event[x]:eventCoding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
MessageHeader.Slices for event[x].event[x]:eventCoding.display This element is included in summaries. 0..1 string Representation defined by the system
MessageHeader.Slices for event[x].event[x]:eventCoding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
MessageHeader.destination This element must be supported. This element is included in summaries. 1..1 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 must be supported. This element is included in summaries. 1..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 1..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 is included in summaries. 0..1 Identifier 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.source This element must be supported. 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.response This element must be supported. 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.focus This element must be supported. This element is included in summaries. 1..1 Reference(Resource) The actual content of the 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 example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventUri Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.sender.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍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: 7 elements(2 nested mandatory elements)
Must-Support: 8 elements
Prohibited: 5 elements

Slices

This structure defines the following Slices:

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

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
MessageHeader.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
MessageHeader.meta This element must be supported. This element is included in summaries. 1..1 Meta Metadata about the resource
MessageHeader.meta.profile This element is included in summaries. 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
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 must be supported. This element is included in summaries. 1..1 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.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
MessageHeader.Slices for event[x].eventCoding Coding
MessageHeader.Slices for event[x].eventUri uri
MessageHeader.Slices for event[x].event[x]:eventCoding This element is included in summaries. 0..1 Coding Code for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageHeader.Slices for event[x].event[x]:eventCoding.system This element is included in summaries. 1..1 uri Identity of the terminology system
MessageHeader.Slices for event[x].event[x]:eventCoding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
MessageHeader.destination This element must be supported. This element is included in summaries. 1..1 BackboneElement Message destination application(s)
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.endpoint This element is included in summaries. 1..1 url Actual destination address or id
MessageHeader.sender This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
MessageHeader.sender.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
MessageHeader.source This element must be supported. 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.response This element must be supported. This element is included in summaries. 0..1 BackboneElement If this is a reply to prior message
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.focus This element must be supported. This element is included in summaries. 1..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 example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventUri Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍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()

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MessageHeader MessageHeader
MessageHeader.id This element must be supported. 1..1 id Logical id of this artifact
MessageHeader.meta This element must be supported. 1..1 Meta Metadata about the resource
MessageHeader.meta.profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
MessageHeader.Slices for event[x] This element must be supported. 1..1 Coding, uri Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
MessageHeader.Slices for event[x].event[x]:eventCoding 0..1 Coding Code for the event this message represents or link to event definition
MessageHeader.Slices for event[x].event[x]:eventCoding.system 1..1 uri Identity of the terminology system
MessageHeader.Slices for event[x].event[x]:eventCoding.code 1..1 code Symbol in syntax defined by the system
MessageHeader.destination This element must be supported. 1..1 BackboneElement Message destination application(s)
MessageHeader.sender This element must be supported. 1..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
MessageHeader.sender.reference 1..1 string Literal reference, Relative, internal or absolute URL
MessageHeader.enterer 0..0 The source of the data entry
MessageHeader.author 0..0 The source of the decision
MessageHeader.source This element must be supported. 1..1 BackboneElement Message source application
MessageHeader.responsible 0..0 Final responsibility for event
MessageHeader.reason 0..0 Cause of event
MessageHeader.response This element must be supported. 0..1 BackboneElement If this is a reply to prior message
MessageHeader.focus This element must be supported. 1..1 Reference(Resource) The actual content of the message
MessageHeader.definition 0..0 Link to the definition for this message

doco Documentation for this format

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 must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
MessageHeader.meta This element must be supported. This element is included in summaries. 1..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 is included in summaries. 0..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. 1..1 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 must be supported. This element is included in summaries. 1..1 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.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
MessageHeader.Slices for event[x].eventCoding Coding
MessageHeader.Slices for event[x].eventUri uri
MessageHeader.Slices for event[x].event[x]:eventCoding This element is included in summaries. 0..1 Coding Code for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
MessageHeader.Slices for event[x].event[x]:eventCoding.id 0..1 string Unique id for inter-element referencing
MessageHeader.Slices for event[x].event[x]:eventCoding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MessageHeader.Slices for event[x].event[x]:eventCoding.system This element is included in summaries. 1..1 uri Identity of the terminology system
MessageHeader.Slices for event[x].event[x]:eventCoding.version This element is included in summaries. 0..1 string Version of the system - if relevant
MessageHeader.Slices for event[x].event[x]:eventCoding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
MessageHeader.Slices for event[x].event[x]:eventCoding.display This element is included in summaries. 0..1 string Representation defined by the system
MessageHeader.Slices for event[x].event[x]:eventCoding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
MessageHeader.destination This element must be supported. This element is included in summaries. 1..1 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 must be supported. This element is included in summaries. 1..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 1..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 is included in summaries. 0..1 Identifier 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.source This element must be supported. 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.response This element must be supported. 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.focus This element must be supported. This element is included in summaries. 1..1 Reference(Resource) The actual content of the 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 example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.event[x]:eventUri Base example MessageEvent 📍4.0.1 FHIR Std.
MessageHeader.sender.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍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: 7 elements(2 nested mandatory elements)
Must-Support: 8 elements
Prohibited: 5 elements

Slices

This structure defines the following Slices:

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

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron