Making EHR Data More available for Research and Public Health (MedMorph)
0.1.0 - STU Ballot
Making EHR Data More available for Research and Public Health (MedMorph)
0.1.0 - STU Ballot
This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-messageheader |
| Version: | 0.1.0 |
| Name: | USPublicHealthMessageHeader |
| Title: | US Public Health MessageHeader |
| Status: | Draft as of 2019-09-01 |
| Definition: | This is the MessageHeader Resource profile for the IG. |
| Publisher: | HL7 International - Public Health Work Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-messageheader
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | MessageHeader | US Public Health MessageHeader | |
  ext-dataEncrypted | S | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted |
| ext-messageProcessingCategory | S | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message |
 event[x] | S | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems |
  destination | S | 1..* | BackboneElement | Message destination application(s) |
  endpoint | S | 1..1 | url | Actual destination address or id |
 sender | S | 1..1 | Reference(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 | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message |
 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | US Public Health MessageHeader | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-dataEncrypted | S | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted |
| ext-messageProcessingCategory | S | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| event[x] | SΣ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems |
| 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(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 | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message |
| 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | US Public Health MessageHeader | |
| ext-dataEncrypted | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted | |
| ext-messageProcessingCategory | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message | |
| event[x] | Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems |
| destination | Σ | 1..* | BackboneElement | Message destination application(s) |
| endpoint | Σ | 1..1 | url | Actual destination address or id |
| sender | Σ | 1..1 | Reference(Organization) | Real world sender of the message |
| source | Σ | 1..1 | BackboneElement | Message source application |
| endpoint | Σ | 1..1 | url | Actual message source address or id |
| reason | Σ | 1..1 | CodeableConcept | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message |
| response | Σ | 0..1 | BackboneElement | If this is a reply to prior message |
| identifier | Σ | 1..1 | id | Id of original message |
| code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. |
| details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
| Documentation for this format | ||||
This structure is derived from MessageHeader
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | US Public Health MessageHeader | |
| ext-dataEncrypted | S | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted |
| ext-messageProcessingCategory | S | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message |
| event[x] | S | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems |
| destination | S | 1..* | BackboneElement | Message destination application(s) |
| endpoint | S | 1..1 | url | Actual destination address or id |
| sender | S | 1..1 | Reference(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 | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message |
| 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | US Public Health MessageHeader | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-dataEncrypted | S | 0..1 | boolean | Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted |
| ext-messageProcessingCategory | S | 1..1 | code | Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| event[x] | SΣ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems |
| 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(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 | Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message |
| 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 | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| MessageHeader.language | preferred | CommonLanguages Max Binding: AllLanguages |
| MessageHeader.event[x] | extensible | USPublicHealthMessageTypes |
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent |
| MessageHeader.response.code | required | ResponseType |
| Id | Path | Details | Requirements |
| dom-2 | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | MessageHeader.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.extension:dataEncrypted | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.extension:dataEncrypted | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.extension:messageProcessingCategory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.extension:messageProcessingCategory | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.event[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.destination.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.destination.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.destination.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.destination.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.receiver | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.enterer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.source.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.source.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.source.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.source.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.software | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.responsible | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.reason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.response.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.details | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.focus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Public Health Work Group. Package hl7.fhir.us.medmorph#0.1.0 based on FHIR 4.0.1. Generated 2020-12-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change