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: US Public Health MessageHeader

Official URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-messageheader | Version: 1.0.0
Draft as of 2019-09-01 | Computable Name: USPublicHealthMessageHeader

This is the MessageHeader Resource profile for the IG.

Usage:

- Use this Resource Profile: US Public Health Reporting Bundle and US Public Health Response Bundle
- Examples for this Resource Profile: MessageHeader/messageheader-example-reportheader

### 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 |  | 0..* | MessageHeader | US Public Health MessageHeader
Slices for extension | S | 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/medmorph/StructureDefinition/us-ph-data-encrypted-extension
reportInitiationType | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type Binding: US Public Health Report Initiation Type (extensible): Initiation Types
event[x] | S | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health 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 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
definition | S | 0..1 | canonical(US Public Health MessageDefinition) | Link to the definition for this message
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
MessageHeader.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | US Public Health MessageHeader
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension | S | 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/medmorph/StructureDefinition/us-ph-data-encrypted-extension
reportInitiationType | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type Binding: US Public Health Report Initiation Type (extensible): Initiation Types
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 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 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
definition | S Σ | 0..1 | canonical(US Public Health MessageDefinition) | Link to the definition for this message
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
MessageHeader.response.code | required | ResponseType

#### Constraints

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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | 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
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 | S | 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/medmorph/StructureDefinition/us-ph-data-encrypted-extension
reportInitiationType | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type Binding: US Public Health Report Initiation Type (extensible): Initiation Types
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 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 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 | S Σ | 0..1 | canonical(US Public Health 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 | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
MessageHeader.response.code | required | ResponseType

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from MessageHeader

Summary

Mandatory: 9 elements (2 nested mandatory elements)
Must-Support: 15 elements

Structures

This structure refers to these other structures:

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

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
- http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type

Differential View

This structure is derived from MessageHeader

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | US Public Health MessageHeader
Slices for extension | S | 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/medmorph/StructureDefinition/us-ph-data-encrypted-extension
reportInitiationType | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type Binding: US Public Health Report Initiation Type (extensible): Initiation Types
event[x] | S | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health 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 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
definition | S | 0..1 | canonical(US Public Health MessageDefinition) | Link to the definition for this message
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
MessageHeader.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | US Public Health MessageHeader
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension | S | 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/medmorph/StructureDefinition/us-ph-data-encrypted-extension
reportInitiationType | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type Binding: US Public Health Report Initiation Type (extensible): Initiation Types
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 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 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
definition | S Σ | 0..1 | canonical(US Public Health MessageDefinition) | Link to the definition for this message
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
MessageHeader.response.code | required | ResponseType

#### Constraints

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

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageHeader |  | 0..* | MessageHeader | 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
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 | S | 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/medmorph/StructureDefinition/us-ph-data-encrypted-extension
reportInitiationType | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type Binding: US Public Health Report Initiation Type (extensible): Initiation Types
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 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 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 | S Σ | 0..1 | canonical(US Public Health 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 | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition Named Events)
MessageHeader.response.code | required | ResponseType

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from MessageHeader

Summary

Mandatory: 9 elements (2 nested mandatory elements)
Must-Support: 15 elements

Structures

This structure refers to these other structures:

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

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
- http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-report-initiation-type

Other representations of profile: CSV, Excel, Schematron