Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1

Making Electronic Data More available for Research and Public Health (MedMorph), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-medmorph/ and changes regularly. See the Directory of published versions

## Resource Profile: USPublicHealthMessageHeader - Detailed Descriptions

Draft as of 2019-09-01

Definitions for the us-ph-messageheader resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. MessageHeader
Definition | Sets expectations for supported capabilities for MessageHeader resource for public health. The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
2. MessageHeader.extension
Control | 10..*
Must Support | true
Slicing | This element introduces a set of slices on MessageHeader.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
3. MessageHeader.extension:dataEncrypted
SliceName | dataEncrypted
Control | 0..1
Type | Extension(USPublicHealthDataEncryptedExtension) (Extension Type: boolean)
Must Support | true
4. MessageHeader.extension:reportInitiationType
SliceName | reportInitiationType
Control | 1..1
Type | Extension(USPHInitiationType) (Extension Type: CodeableConcept)
Must Support | true
5. MessageHeader.event[x]
Binding | The codes SHALL be taken from US Public Health Message Types; other codes may be used where these codes are not suitableFor example codes, see MessageEvent US Public Health Message Types ValueSet One of the message events defined as part of this version of FHIR.
Type | Choice of: , uri
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
6. MessageHeader.destination
Control | 10..*
Must Support | true
7. MessageHeader.destination.endpoint
Must Support | true
8. MessageHeader.sender
Control | 10..1
Type | Reference(USPublicHealthOrganization|Practitioner|PractitionerRole|Organization)
Must Support | true
9. MessageHeader.source
Must Support | true
10. MessageHeader.source.endpoint
Must Support | true
11. MessageHeader.reason
Control | 10..1
Binding | The codes SHALL be taken from US Public Health TriggerDefinition NamedEvent; other codes may be used where these codes are not suitableFor example codes, see ExampleMessageReasonCodes US Public Health TriggerDefinition NamedEvents Reason for event occurrence.
Must Support | true
12. MessageHeader.response
Must Support | true
13. MessageHeader.response.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Must Support | true
14. MessageHeader.response.code
Must Support | true
15. MessageHeader.response.details
Must Support | true
16. MessageHeader.definition
Type | canonical(USPublicHealthMessageDefinition|MessageDefinition)
Must Support | true

Guidance on how to interpret the contents of this table can be found here.

1. MessageHeader
Definition | Sets expectations for supported capabilities for MessageHeader resource for public health. The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
Control | 0..*
Summary | false
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. MessageHeader.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. MessageHeader.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 10..*
Type | Extension
Must Support | true
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on MessageHeader.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. MessageHeader.extension:dataEncrypted
SliceName | dataEncrypted
Definition | Indicates whether the data in the content bundle is encrypted or not.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(USPublicHealthDataEncryptedExtension) (Extension Type: boolean)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. MessageHeader.extension:reportInitiationType
SliceName | reportInitiationType
Definition | An Extension
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(USPHInitiationType) (Extension Type: CodeableConcept)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. MessageHeader.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
7. MessageHeader.event[x]
Definition | Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.
Control | 1..1
Binding | The codes SHALL be taken from US Public Health Message Types; other codes may be used where these codes are not suitableFor example codes, see MessageEvent US Public Health Message Types ValueSet One of the message events defined as part of this version of FHIR.
Type | Choice of: Coding, uri
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Summary | true
Requirements | Drives the behavior associated with this message.
Comments | The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. MessageHeader.destination
Definition | The destination application which the message is intended for.
Control | 10..*
Type | BackboneElement
Must Support | true
Summary | true
Requirements | Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".
Comments | There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. MessageHeader.destination.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. MessageHeader.destination.endpoint
Definition | Indicates where the message should be routed to.
Control | 1..1
Type | url
Must Support | true
Summary | true
Requirements | Identifies where to route the message.
Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. MessageHeader.sender
Definition | Identifies the sending system to allow the use of a trust relationship.
Control | 10..1
Type | Reference(USPublicHealthOrganization|Practitioner|PractitionerRole|Organization)
Must Support | true
Summary | true
Requirements | Allows routing beyond just the application level.
Comments | Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. MessageHeader.source
Definition | The source application from which this message originated.
Control | 1..1
Type | BackboneElement
Must Support | true
Summary | true
Requirements | Allows replies, supports audit.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. MessageHeader.source.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
14. MessageHeader.source.endpoint
Definition | Identifies the routing target to send acknowledgements to.
Control | 1..1
Type | url
Must Support | true
Summary | true
Requirements | Identifies where to send responses, may influence security permissions.
Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. MessageHeader.reason
Definition | Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
Control | 10..1
Binding | The codes SHALL be taken from US Public Health TriggerDefinition NamedEvent; other codes may be used where these codes are not suitableFor example codes, see ExampleMessageReasonCodes US Public Health TriggerDefinition NamedEvents Reason for event occurrence.
Type | CodeableConcept
Must Support | true
Summary | true
Requirements | Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. MessageHeader.response
Definition | Information about the message that this message is a response to. Only present if this message is a response.
Control | 0..1
Type | BackboneElement
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. MessageHeader.response.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
18. MessageHeader.response.identifier
Definition | The MessageHeader.id of the message to which this message is a response.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | id
Must Support | true
Summary | true
Requirements | Allows receiver to know what message is being responded to.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. MessageHeader.response.code
Definition | Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
Control | 1..1
Binding | The codes SHALL be taken from ResponseType The kind of response to a message.
Type | code
Must Support | true
Summary | true
Requirements | Allows the sender of the acknowledge message to know if the request was successful or if action is needed.
Comments | This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. MessageHeader.response.details
Definition | Full details of any issues found in the message.
Control | 0..1
Type | Reference(OperationOutcome)
Must Support | true
Summary | true
Requirements | Allows the sender of the message to determine what the specific issues are.
Comments | This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. MessageHeader.definition
Definition | Permanent link to the MessageDefinition for this message.
Control | 0..1
Type | canonical(USPublicHealthMessageDefinition|MessageDefinition)
Must Support | true
Summary | true
Requirements | Allows sender to define the expected contents of the message.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. MessageHeader
Definition | Sets expectations for supported capabilities for MessageHeader resource for public health.
Control | 0..*
Summary | false
2. MessageHeader.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Summary | true
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. MessageHeader.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. MessageHeader.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. MessageHeader.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Summary | false
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. MessageHeader.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1
Type | Narrative
Summary | false
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. MessageHeader.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. MessageHeader.extension
Definition | An Extension
Control | 1..*
Type | Extension
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on MessageHeader.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. MessageHeader.extension:dataEncrypted
SliceName | dataEncrypted
Definition | Indicates whether the data in the content bundle is encrypted or not.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(USPublicHealthDataEncryptedExtension) (Extension Type: boolean)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. MessageHeader.extension:reportInitiationType
SliceName | reportInitiationType
Definition | An Extension
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(USPHInitiationType) (Extension Type: CodeableConcept)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. MessageHeader.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. MessageHeader.event[x]
Definition | Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.
Control | 1..1
Binding | The codes SHALL be taken from US Public Health Message Types; other codes may be used where these codes are not suitable US Public Health Message Types ValueSe
Type | Coding
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Summary | true
Requirements | Drives the behavior associated with this message.
Comments | The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. MessageHeader.destination
Definition | The destination application which the message is intended for.
Control | 1..*
Type | BackboneElement
Must Support | true
Summary | true
Requirements | Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".
Comments | There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. MessageHeader.destination.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
15. MessageHeader.destination.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
16. MessageHeader.destination.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
17. MessageHeader.destination.name
Definition | Human-readable name for the target system.
Control | 0..1
Type | string
Summary | true
Requirements | May be used for routing of response and/or to support audit.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. MessageHeader.destination.target
Definition | Identifies the target end system in situations where the initial message transmission is to an intermediary system.
Control | 0..1
Type | Reference(Device)
Summary | true
Requirements | Supports multi-hop routing.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. MessageHeader.destination.endpoint
Definition | Indicates where the message should be routed to.
Control | 1..1
Type | url
Must Support | true
Summary | true
Requirements | Identifies where to route the message.
Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. MessageHeader.destination.receiver
Definition | Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
Control | 0..1
Type | Reference(Practitioner|PractitionerRole|Organization)
Summary | true
Requirements | Allows routing beyond just the application level.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. MessageHeader.sender
Definition | Identifies the sending system to allow the use of a trust relationship.
Control | 1..1
Type | Reference(USPublicHealthOrganization)
Must Support | true
Summary | true
Requirements | Allows routing beyond just the application level.
Comments | Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. MessageHeader.enterer
Definition | The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
Control | 0..1
Type | Reference(Practitioner|PractitionerRole)
Summary | true
Requirements | Need to know for audit/traceback requirements and possibly for authorization.
Comments | Usually only for the request but can be used in a response.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. MessageHeader.author
Definition | The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
Control | 0..1
Type | Reference(Practitioner|PractitionerRole)
Summary | true
Requirements | Need to know for audit/traceback requirements and possibly for authorization.
Comments | Usually only for the request but can be used in a response.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. MessageHeader.source
Definition | The source application from which this message originated.
Control | 1..1
Type | BackboneElement
Must Support | true
Summary | true
Requirements | Allows replies, supports audit.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. MessageHeader.source.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
26. MessageHeader.source.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
27. MessageHeader.source.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
28. MessageHeader.source.name
Definition | Human-readable name for the source system.
Control | 0..1
Type | string
Summary | true
Requirements | May be used to support audit.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. MessageHeader.source.software
Definition | May include configuration or other information useful in debugging.
Control | 0..1
Type | string
Summary | true
Requirements | Supports audit and possibly interface engine behavior.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. MessageHeader.source.version
Definition | Can convey versions of multiple systems in situations where a message passes through multiple hands.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Summary | true
Requirements | Supports audit and possibly interface engine behavior.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. MessageHeader.source.contact
Definition | An e-mail, phone, website or other contact point to use to resolve issues with message communications.
Control | 0..1
Type | ContactPoint
Summary | true
Requirements | Allows escalation of technical issues.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. MessageHeader.source.endpoint
Definition | Identifies the routing target to send acknowledgements to.
Control | 1..1
Type | url
Must Support | true
Summary | true
Requirements | Identifies where to send responses, may influence security permissions.
Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. MessageHeader.responsible
Definition | The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
Control | 0..1
Type | Reference(Practitioner|PractitionerRole|Organization)
Summary | true
Requirements | Need to know for audit/traceback requirements and possibly for authorization.
Comments | Usually only for the request but can be used in a response.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. MessageHeader.reason
Definition | Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
Control | 1..1
Binding | The codes SHALL be taken from US Public Health TriggerDefinition NamedEvent; other codes may be used where these codes are not suitable US Public Health TriggerDefinition NamedEvent
Type | CodeableConcept
Must Support | true
Summary | true
Requirements | Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. MessageHeader.response
Definition | Information about the message that this message is a response to. Only present if this message is a response.
Control | 0..1
Type | BackboneElement
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. MessageHeader.response.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
37. MessageHeader.response.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
38. MessageHeader.response.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. MessageHeader.response.identifier
Definition | The MessageHeader.id of the message to which this message is a response.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | id
Must Support | true
Summary | true
Requirements | Allows receiver to know what message is being responded to.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. MessageHeader.response.code
Definition | Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
Control | 1..1
Binding | The codes SHALL be taken from ResponseType The kind of response to a message
Type | code
Must Support | true
Summary | true
Requirements | Allows the sender of the acknowledge message to know if the request was successful or if action is needed.
Comments | This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. MessageHeader.response.details
Definition | Full details of any issues found in the message.
Control | 0..1
Type | Reference(OperationOutcome)
Must Support | true
Summary | true
Requirements | Allows the sender of the message to determine what the specific issues are.
Comments | This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. MessageHeader.focus
Definition | The actual data of the message - a reference to the root/focus class of the event.
Control | 0..*
Type | Reference(Resource)
Summary | true
Requirements | Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.
Comments | The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. MessageHeader.definition
Definition | Permanent link to the MessageDefinition for this message.
Control | 0..1
Type | canonical(USPublicHealthMessageDefinition)
Must Support | true
Summary | true
Requirements | Allows sender to define the expected contents of the message.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))