US Public Health Profiles Library
1.0.0 - STU1

US Public Health Profiles Library, published by HL7 Public Health Working 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-us-ph-common-library-ig/ 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: 1.0.0
Active as of 2023-10-04 | Computable Name: USPublicHealthMessageHeader

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

Usage:

- Use this Resource Profile: US Public Health Reporting Bundle and US Public Health Response Bundle
- Examples for this Resource Profile: MessageHeader/us-ph-messageheader-case-report and MessageHeader/us-ph-messageheader-response

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from MessageHeader

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  |  | MessageHeader |
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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
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: US Public Health VaueSet - Message Types (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
sender | S | 1..1 | Reference(US Public Health Organization) | Real world sender of the message
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: US Public Health VaueSet - TriggerDefinition NamedEvent (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
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types)
MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent (a valid code from US Public Health CodeSystem - Trigger Definition Named Events)

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
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
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
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | S Σ | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health VaueSet - Message Types (extensible): US Public Health Message Types ValueSet
destination | S Σ | 1..* | BackboneElement | Message destination application(s)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | S Σ | 1..1 | url | Actual destination address or id
sender | S Σ | 1..1 | Reference(US Public Health Organization) | 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
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: US Public Health VaueSet - TriggerDefinition NamedEvent (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
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types)
MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent (a valid code from US Public Health CodeSystem - Trigger Definition Named Events)
MessageHeader.response.code | required | ResponseType

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | S Σ | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health VaueSet - Message Types (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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 0..1 | string | Name of system
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination
endpoint | 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) | 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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 0..1 | string | Name of system
software | Σ | 0..1 | string | Name of software running the system
version | Σ | 0..1 | string | Version of software running
contact | Σ | 0..1 | ContactPoint | Human contact for problems
endpoint | 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: US Public Health VaueSet - TriggerDefinition NamedEvent (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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types)
MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent (a valid code from US Public Health CodeSystem - Trigger Definition Named Events)
MessageHeader.response.code | required | ResponseType

This structure is derived from MessageHeader

Summary

Mandatory: 5 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

- US Public Health Organization (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-organization)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension

Differential View

This structure is derived from MessageHeader

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  |  | MessageHeader |
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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
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: US Public Health VaueSet - Message Types (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
sender | S | 1..1 | Reference(US Public Health Organization) | Real world sender of the message
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: US Public Health VaueSet - TriggerDefinition NamedEvent (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
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types)
MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent (a valid code from US Public Health CodeSystem - Trigger Definition Named Events)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
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
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
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | S Σ | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health VaueSet - Message Types (extensible): US Public Health Message Types ValueSet
destination | S Σ | 1..* | BackboneElement | Message destination application(s)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
endpoint | S Σ | 1..1 | url | Actual destination address or id
sender | S Σ | 1..1 | Reference(US Public Health Organization) | 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
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: US Public Health VaueSet - TriggerDefinition NamedEvent (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
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types)
MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent (a valid code from US Public Health CodeSystem - Trigger Definition Named Events)
MessageHeader.response.code | required | ResponseType

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
event[x] | S Σ | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health VaueSet - Message Types (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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 0..1 | string | Name of system
target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination
endpoint | 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) | 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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 0..1 | string | Name of system
software | Σ | 0..1 | string | Name of software running the system
version | Σ | 0..1 | string | Version of software running
contact | Σ | 0..1 | ContactPoint | Human contact for problems
endpoint | 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: US Public Health VaueSet - TriggerDefinition NamedEvent (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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types)
MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent (a valid code from US Public Health CodeSystem - Trigger Definition Named Events)
MessageHeader.response.code | required | ResponseType

This structure is derived from MessageHeader

Summary

Mandatory: 5 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

- US Public Health Organization (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-organization)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension

Other representations of profile: CSV, Excel, Schematron