US Public Health Profiles Library
​2.0.0 - United States of America flag

US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health MessageHeader

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-messageheader Version: 2.0.0
Standards status: Trial-use Active as of 2025-10-23 Maturity Level: 3 Computable Name: USPublicHealthMessageHeader
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.39

This MessageHeader profile represents the header for transmitting content using FHIR messaging.

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: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.0.1) US Public Health MessageHeader
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
Constraints: ext-1
.... extension:messageProcessingCategory S 1..1 code US Public Health Message Processing Category Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension
Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... destination SΣ 1..* BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... endpoint SΣ 1..1 url Actual destination address or id
... sender SΣ 1..1 Reference(US Public Health Organization(2.0.0)) Real world sender of the message
... source SΣ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... endpoint SΣ 1..1 url Actual message source address or id
... reason SΣ 1..1 CodeableConcept The named event that gave rise to the message
Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents
... response SΣ 0..1 BackboneElement If this is a reply to prior message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... identifier SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
.... details SΣ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base extensible US Public Health ValueSet - Message Types 📍2.0.0 This IG
MessageHeader.reason Base extensible US Public Health ValueSet - TriggerDefinition NamedEvent 📍2.0.0 This IG
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 MessageHeader.implicitRules, MessageHeader.extension, MessageHeader.extension:dataEncrypted, MessageHeader.extension:messageProcessingCategory, MessageHeader.modifierExtension, MessageHeader.event[x], MessageHeader.destination, MessageHeader.destination.modifierExtension, MessageHeader.destination.endpoint, MessageHeader.sender, MessageHeader.source, MessageHeader.source.modifierExtension, MessageHeader.source.endpoint, MessageHeader.reason, MessageHeader.response, MessageHeader.response.modifierExtension, MessageHeader.response.identifier, MessageHeader.response.code, MessageHeader.response.details All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageHeader.extension, MessageHeader.extension:dataEncrypted, MessageHeader.extension:messageProcessingCategory, MessageHeader.modifierExtension, MessageHeader.destination.modifierExtension, MessageHeader.source.modifierExtension, MessageHeader.response.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.0.1) US Public Health MessageHeader
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
.... extension:messageProcessingCategory S 1..1 code US Public Health Message Processing Category Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension
Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
... event[x] S 1..1 Coding Types of messages being sent between systems
Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet
... destination S 1..* BackboneElement Message destination application(s)
.... endpoint S 1..1 url Actual destination address or id
... source S 1..1 BackboneElement Message source application
.... endpoint S 1..1 url Actual message source address or id
... reason S 1..1 CodeableConcept The named event that gave rise to the message
Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents
... response S 0..1 BackboneElement If this is a reply to prior message
.... identifier S 1..1 id Id of original message
.... code S 1..1 code ok | transient-error | fatal-error
.... details S 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base extensible US Public Health ValueSet - Message Types 📍2.0.0 This IG
MessageHeader.reason Base extensible US Public Health ValueSet - TriggerDefinition NamedEvent 📍2.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.0.1) US Public Health MessageHeader
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
Constraints: ext-1
.... extension:messageProcessingCategory S 1..1 code US Public Health Message Processing Category Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension
Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... event[x] SΣ 1..1 Coding Types of messages being sent between systems
Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet
... destination SΣ 1..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint SΣ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender SΣ 1..1 Reference(US Public Health Organization(2.0.0)) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source SΣ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 SΣ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason SΣ 1..1 CodeableConcept The named event that gave rise to the message
Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents
... response SΣ 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... identifier SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
.... details SΣ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* 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.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageHeader.event[x] Base extensible US Public Health ValueSet - Message Types 📍2.0.0 This IG
MessageHeader.reason Base extensible US Public Health ValueSet - TriggerDefinition NamedEvent 📍2.0.0 This IG
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 MessageHeader.meta, MessageHeader.implicitRules, MessageHeader.language, MessageHeader.text, MessageHeader.extension, MessageHeader.extension:dataEncrypted, MessageHeader.extension:messageProcessingCategory, MessageHeader.modifierExtension, MessageHeader.event[x], MessageHeader.destination, MessageHeader.destination.extension, MessageHeader.destination.modifierExtension, MessageHeader.destination.name, MessageHeader.destination.target, MessageHeader.destination.endpoint, MessageHeader.destination.receiver, MessageHeader.sender, MessageHeader.enterer, MessageHeader.author, MessageHeader.source, MessageHeader.source.extension, MessageHeader.source.modifierExtension, MessageHeader.source.name, MessageHeader.source.software, MessageHeader.source.version, MessageHeader.source.contact, MessageHeader.source.endpoint, MessageHeader.responsible, MessageHeader.reason, MessageHeader.response, MessageHeader.response.extension, MessageHeader.response.modifierExtension, MessageHeader.response.identifier, MessageHeader.response.code, MessageHeader.response.details, MessageHeader.focus, MessageHeader.definition All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageHeader.extension, MessageHeader.extension:dataEncrypted, MessageHeader.extension:messageProcessingCategory, MessageHeader.modifierExtension, MessageHeader.destination.extension, MessageHeader.destination.modifierExtension, MessageHeader.source.extension, MessageHeader.source.modifierExtension, MessageHeader.response.extension, MessageHeader.response.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.0.1) US Public Health MessageHeader
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
Constraints: ext-1
.... extension:messageProcessingCategory S 1..1 code US Public Health Message Processing Category Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension
Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... destination SΣ 1..* BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... endpoint SΣ 1..1 url Actual destination address or id
... sender SΣ 1..1 Reference(US Public Health Organization(2.0.0)) Real world sender of the message
... source SΣ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... endpoint SΣ 1..1 url Actual message source address or id
... reason SΣ 1..1 CodeableConcept The named event that gave rise to the message
Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents
... response SΣ 0..1 BackboneElement If this is a reply to prior message
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... identifier SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
.... details SΣ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base extensible US Public Health ValueSet - Message Types 📍2.0.0 This IG
MessageHeader.reason Base extensible US Public Health ValueSet - TriggerDefinition NamedEvent 📍2.0.0 This IG
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 MessageHeader.implicitRules, MessageHeader.extension, MessageHeader.extension:dataEncrypted, MessageHeader.extension:messageProcessingCategory, MessageHeader.modifierExtension, MessageHeader.event[x], MessageHeader.destination, MessageHeader.destination.modifierExtension, MessageHeader.destination.endpoint, MessageHeader.sender, MessageHeader.source, MessageHeader.source.modifierExtension, MessageHeader.source.endpoint, MessageHeader.reason, MessageHeader.response, MessageHeader.response.modifierExtension, MessageHeader.response.identifier, MessageHeader.response.code, MessageHeader.response.details All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageHeader.extension, MessageHeader.extension:dataEncrypted, MessageHeader.extension:messageProcessingCategory, MessageHeader.modifierExtension, MessageHeader.destination.modifierExtension, MessageHeader.source.modifierExtension, MessageHeader.response.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.0.1) US Public Health MessageHeader
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
.... extension:messageProcessingCategory S 1..1 code US Public Health Message Processing Category Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension
Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
... event[x] S 1..1 Coding Types of messages being sent between systems
Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet
... destination S 1..* BackboneElement Message destination application(s)
.... endpoint S 1..1 url Actual destination address or id
... source S 1..1 BackboneElement Message source application
.... endpoint S 1..1 url Actual message source address or id
... reason S 1..1 CodeableConcept The named event that gave rise to the message
Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents
... response S 0..1 BackboneElement If this is a reply to prior message
.... identifier S 1..1 id Id of original message
.... code S 1..1 code ok | transient-error | fatal-error
.... details S 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base extensible US Public Health ValueSet - Message Types 📍2.0.0 This IG
MessageHeader.reason Base extensible US Public Health ValueSet - TriggerDefinition NamedEvent 📍2.0.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.0.1) US Public Health MessageHeader
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:dataEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
Constraints: ext-1
.... extension:messageProcessingCategory S 1..1 code US Public Health Message Processing Category Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension
Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... event[x] SΣ 1..1 Coding Types of messages being sent between systems
Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet
... destination SΣ 1..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint SΣ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender SΣ 1..1 Reference(US Public Health Organization(2.0.0)) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source SΣ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 SΣ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason SΣ 1..1 CodeableConcept The named event that gave rise to the message
Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents
... response SΣ 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... identifier SΣ 1..1 id Id of original message
.... code SΣ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
.... details SΣ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* 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.language Base preferred Common Languages 📍4.0.1 FHIR Std.
MessageHeader.event[x] Base extensible US Public Health ValueSet - Message Types 📍2.0.0 This IG
MessageHeader.reason Base extensible US Public Health ValueSet - TriggerDefinition NamedEvent 📍2.0.0 This IG
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 MessageHeader.meta, MessageHeader.implicitRules, MessageHeader.language, MessageHeader.text, MessageHeader.extension, MessageHeader.extension:dataEncrypted, MessageHeader.extension:messageProcessingCategory, MessageHeader.modifierExtension, MessageHeader.event[x], MessageHeader.destination, MessageHeader.destination.extension, MessageHeader.destination.modifierExtension, MessageHeader.destination.name, MessageHeader.destination.target, MessageHeader.destination.endpoint, MessageHeader.destination.receiver, MessageHeader.sender, MessageHeader.enterer, MessageHeader.author, MessageHeader.source, MessageHeader.source.extension, MessageHeader.source.modifierExtension, MessageHeader.source.name, MessageHeader.source.software, MessageHeader.source.version, MessageHeader.source.contact, MessageHeader.source.endpoint, MessageHeader.responsible, MessageHeader.reason, MessageHeader.response, MessageHeader.response.extension, MessageHeader.response.modifierExtension, MessageHeader.response.identifier, MessageHeader.response.code, MessageHeader.response.details, MessageHeader.focus, MessageHeader.definition All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageHeader.extension, MessageHeader.extension:dataEncrypted, MessageHeader.extension:messageProcessingCategory, MessageHeader.modifierExtension, MessageHeader.destination.extension, MessageHeader.destination.modifierExtension, MessageHeader.source.extension, MessageHeader.source.modifierExtension, MessageHeader.response.extension, MessageHeader.response.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron