3.41 StructureDefinition: Shared Services Message Header
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/profile-messageheader
3.41.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from MessageHeader
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 MessageHeader | 0..* | Definition: The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. | |
 id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This value is assigned by the system that creates a bundle and is unique to the specific message instance of the bundle and the uniqueness of this value will be validated by the PrescribeIT™ service. This value is sometimes referenced in error messages. |
| meta | 0..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Comments: See children |
  profile | 0..* | uri | Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| timestamp | 1..1 | instant | Definition: Time and date the transaction was created Comments: Conformance Rule: Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
| event | 1..1 | Coding | Binding: SharedMessageEvents (preferred) Definition: Code that identifies the event this message represents and connects it with its definition. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents |
| code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| response | 0..1 | BackboneElement | Definition: Information about the message that this message is a response to. Only present if this message is a response. |
| identifier | 1..1 | id | Definition: The id of the message that this message is a response to. Comments: Conformance Rule: This is to be populated with the MessageHeader.id of the original message that is being responded to. |
| details | 0..1 | Reference(Shared Health Operation Outcome) {b} | Definition: A reference from one resource to another. Comments: |
| source | 1..1 | BackboneElement | Definition: The source application from which this message originated. |
| extension (applicationId) | 1..1 | Message Header Application Id | Definition: Unique identifier for the application responsible for sending a message. Comments: Conformance Rule: This identifier must be an OID [Vendor Application OID].[Application Instance ID] expressed as a uri (e.g. urn:oid:2.16.840.1.113883.3.368.1234). Vendors will be assigned this identifier upon registration by PrescribeIT™ technical support. |
| extension (conformanceVersion) | 1..1 | Message Header Source Conformance Version | Definition: String identifying the version of the sending software application that was most recently subjected to conformance testing Comments: This is the version number of the software that underwent conformance testing. It may be earlier than the source.version in cases where the application has since undergone changes that do not affect the communication interface. Usage Note: This version must be registered with the Shared Services Hub and will be validated by the Hub at runtime. |
| name | 0..1 | string | Definition: Human-readable name for the source system. Comments: Usage Note: The name of the Vendor. |
| software | 1..1 | string | Definition: May include configuration or other information useful in debugging. Comments: Usage Note: The name of the Vendor's software creating the message. Conformance Rule: This must be a known value that is registered on Shared Services Hub. This will be validated at run time. |
| version | 1..1 | string | Definition: Can convey versions of multiple systems in situations where a message passes through multiple hands. Comments: Conformance Rule: This must convey the build version of the vendor application. This is the version of the application that created the message. Usage Note: This version number is issued by the software vendor and will be used primarily for audit and troubleshooting purposes. This may or may not be the same as the conformance version. |
| endpoint | 1..1 | uri | Definition: Identifies the routing target to send acknowledgements to. Comments: Conformance Rule: This must be populated with the full URL for the Organization Identifier (CPR ID) that was issued by PrescribeIT™. The format to be used is as follows. The URL's must be completely configurable within the EMR or PMS as they will vary by environment. Format: https://{environmentspecifichost}/{EnvironmentAndContextSpecificPath}/Organization/CPR1000123 Vendors will be given the actual values for {environmentspecifichost}/{EnvironmentAndContextSpecificPath} in the API document at time of onboarding. |
| destination | 1..* | BackboneElement | Definition: The destination application which the message is intended for. Comments: This is the target EMR or PMS, not Shared Services Hub. |
 endpoint | 1..1 | uri | Definition: Indicates where the message should be routed to. Comments: Conformance Rule: This must be populated with the full URL for the Organization Identifier (CPR ID) that was issued by PrescribeIT™. The URL's must be completely configurable within the EMR or PMS as they will vary by environment. Format: https://{environmentspecifichost}/{EnvironmentAndContextSpecificPath}/Organization/CPR1000123 Vendors will be given the actual values for {environmentspecifichost}/{EnvironmentAndContextSpecificPath} in the API document at time of onboarding. |
This structure is derived from MessageHeader
Summary
Mandatory: 12 elements (1 nested mandatory element)
Must-Support: 19 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-operationoutcome
Extensions
This structure refers to these extensions:
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 MessageHeader | S | 0..* | ||
| id | S | 1..1 | id | |
| meta | S | 0..1 | Meta | |
| profile | S | 0..* | uri | |
| timestamp | S | 1..1 | instant | |
| event | S | 1..1 | Coding | Binding: SharedMessageEvents (preferred) |
| system | S | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents |
| code | S | 1..1 | code | |
| response | S | 0..1 | BackboneElement | |
| identifier | S | 1..1 | id | |
 details | S | 0..1 | Reference(Shared Health Operation Outcome) {b} | |
| source | S | 1..1 | BackboneElement | |
 ext-messageheader-application-id | S | 1..1 | uri | Sending application id URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id |
| ext-messageheader-conformance-version | S | 1..1 | string | Conformance version URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version |
| name | S | 0..1 | string | |
| software | S | 1..1 | string | |
| version | S | 1..1 | string | |
| endpoint | S | 1..1 | uri | |
| destination | S | 1..* | BackboneElement | |
| endpoint | S | 1..1 | uri | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | SΣ | 0..* | A resource that describes a message that is exchanged between systems | |
 id | SΣ | 1..1 | id | Logical id of this artifact |
 meta | SΣ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 0..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| timestamp | SΣ | 1..1 | instant | Time that the message was sent |
| event | ?!SΣ | 1..1 | Coding | Code for the event this message represents Binding: SharedMessageEvents (preferred) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| response | ?!SΣ | 0..1 | BackboneElement | If this is a reply to prior message |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..1 | id | Id of original message |
| code | ?!Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required) |
| details | SΣ | 0..1 | Reference(Shared Health Operation Outcome) {b} | A reference from one resource to another |
| source | SΣ | 1..1 | BackboneElement | Message Source Application |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-messageheader-application-id | S | 1..1 | uri | Sending application id URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id |
| ext-messageheader-conformance-version | S | 1..1 | string | Conformance version URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | SΣ | 0..1 | string | Name of system |
| software | SΣ | 1..1 | string | Name of software running the system |
| version | SΣ | 1..1 | string | Version of software running |
| contact | Σ | 0..1 | ContactPoint | Human contact for problems |
| endpoint | SΣ | 1..1 | uri | Actual message source address or id |
| destination | SΣ | 1..* | BackboneElement | Message Destination Application(s) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | Σ | 0..1 | string | Name of system |
| target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination |
| endpoint | SΣ | 1..1 | uri | Actual destination address or id |
| enterer | Σ | 0..1 | Reference(Practitioner) | The source of the data entry |
| author | Σ | 0..1 | Reference(Practitioner) | The source of the decision |
| receiver | Σ | 0..1 | Reference(Practitioner | Organization) | Intended "real-world" recipient for the data |
| responsible | Σ | 0..1 | Reference(Practitioner | Organization) | Final responsibility for event |
| reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: Example Message Reason Codes (example) |
| data | Σ | 0..* | Reference(Resource) | The actual content of the message |
| Documentation for this format | ||||
Grid View
This structure is derived from MessageHeader
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| MessageHeader | 0..* | Definition: The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. | |
| id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This value is assigned by the system that creates a bundle and is unique to the specific message instance of the bundle and the uniqueness of this value will be validated by the PrescribeIT™ service. This value is sometimes referenced in error messages. |
| meta | 0..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Comments: See children |
| profile | 0..* | uri | Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| timestamp | 1..1 | instant | Definition: Time and date the transaction was created Comments: Conformance Rule: Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
| event | 1..1 | Coding | Binding: SharedMessageEvents (preferred) Definition: Code that identifies the event this message represents and connects it with its definition. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents |
| code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| response | 0..1 | BackboneElement | Definition: Information about the message that this message is a response to. Only present if this message is a response. |
| identifier | 1..1 | id | Definition: The id of the message that this message is a response to. Comments: Conformance Rule: This is to be populated with the MessageHeader.id of the original message that is being responded to. |
| details | 0..1 | Reference(Shared Health Operation Outcome) {b} | Definition: A reference from one resource to another. Comments: |
| source | 1..1 | BackboneElement | Definition: The source application from which this message originated. |
| extension (applicationId) | 1..1 | Message Header Application Id | Definition: Unique identifier for the application responsible for sending a message. Comments: Conformance Rule: This identifier must be an OID [Vendor Application OID].[Application Instance ID] expressed as a uri (e.g. urn:oid:2.16.840.1.113883.3.368.1234). Vendors will be assigned this identifier upon registration by PrescribeIT™ technical support. |
| extension (conformanceVersion) | 1..1 | Message Header Source Conformance Version | Definition: String identifying the version of the sending software application that was most recently subjected to conformance testing Comments: This is the version number of the software that underwent conformance testing. It may be earlier than the source.version in cases where the application has since undergone changes that do not affect the communication interface. Usage Note: This version must be registered with the Shared Services Hub and will be validated by the Hub at runtime. |
| name | 0..1 | string | Definition: Human-readable name for the source system. Comments: Usage Note: The name of the Vendor. |
| software | 1..1 | string | Definition: May include configuration or other information useful in debugging. Comments: Usage Note: The name of the Vendor's software creating the message. Conformance Rule: This must be a known value that is registered on Shared Services Hub. This will be validated at run time. |
| version | 1..1 | string | Definition: Can convey versions of multiple systems in situations where a message passes through multiple hands. Comments: Conformance Rule: This must convey the build version of the vendor application. This is the version of the application that created the message. Usage Note: This version number is issued by the software vendor and will be used primarily for audit and troubleshooting purposes. This may or may not be the same as the conformance version. |
| endpoint | 1..1 | uri | Definition: Identifies the routing target to send acknowledgements to. Comments: Conformance Rule: This must be populated with the full URL for the Organization Identifier (CPR ID) that was issued by PrescribeIT™. The format to be used is as follows. The URL's must be completely configurable within the EMR or PMS as they will vary by environment. Format: https://{environmentspecifichost}/{EnvironmentAndContextSpecificPath}/Organization/CPR1000123 Vendors will be given the actual values for {environmentspecifichost}/{EnvironmentAndContextSpecificPath} in the API document at time of onboarding. |
| destination | 1..* | BackboneElement | Definition: The destination application which the message is intended for. Comments: This is the target EMR or PMS, not Shared Services Hub. |
| endpoint | 1..1 | uri | Definition: Indicates where the message should be routed to. Comments: Conformance Rule: This must be populated with the full URL for the Organization Identifier (CPR ID) that was issued by PrescribeIT™. The URL's must be completely configurable within the EMR or PMS as they will vary by environment. Format: https://{environmentspecifichost}/{EnvironmentAndContextSpecificPath}/Organization/CPR1000123 Vendors will be given the actual values for {environmentspecifichost}/{EnvironmentAndContextSpecificPath} in the API document at time of onboarding. |
This structure is derived from MessageHeader
Summary
Mandatory: 12 elements (1 nested mandatory element)
Must-Support: 19 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-operationoutcome
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | S | 0..* | ||
| id | S | 1..1 | id | |
| meta | S | 0..1 | Meta | |
| profile | S | 0..* | uri | |
| timestamp | S | 1..1 | instant | |
| event | S | 1..1 | Coding | Binding: SharedMessageEvents (preferred) |
| system | S | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents |
| code | S | 1..1 | code | |
| response | S | 0..1 | BackboneElement | |
| identifier | S | 1..1 | id | |
| details | S | 0..1 | Reference(Shared Health Operation Outcome) {b} | |
| source | S | 1..1 | BackboneElement | |
| ext-messageheader-application-id | S | 1..1 | uri | Sending application id URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id |
| ext-messageheader-conformance-version | S | 1..1 | string | Conformance version URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version |
| name | S | 0..1 | string | |
| software | S | 1..1 | string | |
| version | S | 1..1 | string | |
| endpoint | S | 1..1 | uri | |
| destination | S | 1..* | BackboneElement | |
| endpoint | S | 1..1 | uri | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | SΣ | 0..* | A resource that describes a message that is exchanged between systems | |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 0..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| timestamp | SΣ | 1..1 | instant | Time that the message was sent |
| event | ?!SΣ | 1..1 | Coding | Code for the event this message represents Binding: SharedMessageEvents (preferred) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| response | ?!SΣ | 0..1 | BackboneElement | If this is a reply to prior message |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..1 | id | Id of original message |
| code | ?!Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required) |
| details | SΣ | 0..1 | Reference(Shared Health Operation Outcome) {b} | A reference from one resource to another |
| source | SΣ | 1..1 | BackboneElement | Message Source Application |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-messageheader-application-id | S | 1..1 | uri | Sending application id URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id |
| ext-messageheader-conformance-version | S | 1..1 | string | Conformance version URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | SΣ | 0..1 | string | Name of system |
| software | SΣ | 1..1 | string | Name of software running the system |
| version | SΣ | 1..1 | string | Version of software running |
| contact | Σ | 0..1 | ContactPoint | Human contact for problems |
| endpoint | SΣ | 1..1 | uri | Actual message source address or id |
| destination | SΣ | 1..* | BackboneElement | Message Destination Application(s) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | Σ | 0..1 | string | Name of system |
| target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination |
| endpoint | SΣ | 1..1 | uri | Actual destination address or id |
| enterer | Σ | 0..1 | Reference(Practitioner) | The source of the data entry |
| author | Σ | 0..1 | Reference(Practitioner) | The source of the decision |
| receiver | Σ | 0..1 | Reference(Practitioner | Organization) | Intended "real-world" recipient for the data |
| responsible | Σ | 0..1 | Reference(Practitioner | Organization) | Final responsibility for event |
| reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: Example Message Reason Codes (example) |
| data | Σ | 0..* | Reference(Resource) | The actual content of the message |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.41.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| MessageHeader.meta.security | All Security Labels | extensible | All Security Labels |
| MessageHeader.meta.tag | ?ext | example | |
| MessageHeader.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| MessageHeader.event | SharedMessageEvents | preferred | SharedMessageEvents |
| MessageHeader.response.code | ResponseType | required | ResponseType |
| MessageHeader.reason | Example Message Reason Codes | example | Example Message Reason Codes |
3.41.4 Constraints
Constraints
| Id | Path | Details | Requirements |