US Public Health Profiles Library
2.0.0 - STU2
US Public Health Profiles Library
2.0.0 - STU2
US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-messageheader | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: USPublicHealthMessageHeader | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.39 | ||||
This MessageHeader profile represents the header for transmitting content using FHIR messaging.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  MessageHeader |
0..* | MessageHeader | US Public Health MessageHeader | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:dataEncrypted |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension |
 extension:messageProcessingCategory |
S | 1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory |
 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 | ||||
| Path | Conformance | ValueSet | URI |
| MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes(a valid code from US Public Health CodeSystem - Message Types)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-message-typesFrom this IG | |
| MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent(a valid code from US Public Health CodeSystem - Trigger Definition Named Events)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-triggerdefinition-namedeventFrom this IG | |
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1From the FHIR Standard |
| 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() |
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | US Public Health MessageHeader | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:dataEncrypted |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension |
| extension:messageProcessingCategory |
S | 1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory |
| event[x] |
S | 1..1 | Coding | Types of messages being sent between systems Binding: 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 | ||||
| Path | Conformance | ValueSet | URI |
| MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes(a valid code from US Public Health CodeSystem - Message Types)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-message-typesFrom this IG | |
| MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent(a valid code from US Public Health CodeSystem - Trigger Definition Named Events)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-triggerdefinition-namedeventFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:dataEncrypted |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension | ||||
| extension:messageProcessingCategory |
S | 1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes(a valid code from US Public Health CodeSystem - Message Types)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-message-typesFrom this IG | ||||
| MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent(a valid code from US Public Health CodeSystem - Trigger Definition Named Events)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-triggerdefinition-namedeventFrom this IG | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1From the FHIR Standard |
| 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() |
This structure is derived from MessageHeader
Summary
Mandatory: 5 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | US Public Health MessageHeader | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:dataEncrypted |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension |
| extension:messageProcessingCategory |
S | 1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes(a valid code from US Public Health CodeSystem - Message Types)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-message-typesFrom this IG | |
| MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent(a valid code from US Public Health CodeSystem - Trigger Definition Named Events)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-triggerdefinition-namedeventFrom this IG | |
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1From the FHIR Standard |
| 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() |
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | US Public Health MessageHeader | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:dataEncrypted |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension |
| extension:messageProcessingCategory |
S | 1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory |
| event[x] |
S | 1..1 | Coding | Types of messages being sent between systems Binding: 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 | ||||
| Path | Conformance | ValueSet | URI |
| MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes(a valid code from US Public Health CodeSystem - Message Types)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-message-typesFrom this IG | |
| MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent(a valid code from US Public Health CodeSystem - Trigger Definition Named Events)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-triggerdefinition-namedeventFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:dataEncrypted |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension | ||||
| extension:messageProcessingCategory |
S | 1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| MessageHeader.event[x] | extensible | USPublicHealthValueSetMessageTypes(a valid code from US Public Health CodeSystem - Message Types)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-message-typesFrom this IG | ||||
| MessageHeader.reason | extensible | USPublicHealthValueSetTriggerDefinitionNamedEvent(a valid code from US Public Health CodeSystem - Trigger Definition Named Events)http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-triggerdefinition-namedeventFrom this IG | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1From the FHIR Standard |
| 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() |
This structure is derived from MessageHeader
Summary
Mandatory: 5 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health. Package hl7.fhir.us.ph-library#2.0.0 based on FHIR 4.0.1. Generated 2025-06-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change