Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/profile-messageheader

Download Excel representation

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

>

This structure is derived from MessageHeader

NameCard.TypeConstraints and Usage
.  MessageHeader 0..*MessageHeaderDefinition:
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..1idDefinition:
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..1MetaDefinition:
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..*uriDefinition:
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..1instantDefinition:
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..1CodingBinding: SharedMessageEvents (20190415) (preferred)
Definition:
Code that identifies the event this message represents and connects it with its definition.

...  system 1..1uriFixed 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..1codeDefinition:
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..1BackboneElementDefinition:
Information about the message that this message is a response to. Only present if this message is a response.

...  identifier 1..1idDefinition:
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..1Reference(Shared Health Operation Outcome) {b}Definition:
A reference from one resource to another.


Comments:


..  source 1..1BackboneElementDefinition:
The source application from which this message originated.

...  extension
       (applicationId)
1..1Message Header Application IdDefinition:
Unique identifier for the application responsible for sending a message.


Comments:
Vendors will be assigned this identifier upon registration by PrescribeIT® technical support.

...  extension
       (conformanceVersion)
1..1Message Header Source Conformance VersionDefinition:
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..1stringDefinition:
Human-readable name for the source system.


Comments:
Usage Note: The name of the Vendor.

...  software 1..1stringDefinition:
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..1stringDefinition:
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..1uriDefinition:
Identifies the routing target to send acknowledgements to.


Comments:
Conformance Rule: This must be populated with the full URL for the Organization Identifier (CPRID) 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/{CPRID}



Vendors will be given the actual values for {environmentSpecificHost}/{environmentAndContextSpecificPath} in the API document at time of onboarding.

..  destination 1..*BackboneElementDefinition:
The destination application which the message is intended for.


Comments:
Usage Note: This is used to specify the destination system.

...  endpoint 1..1uriDefinition:
Indicates where the message should be routed to.


Comments:
Conformance Rule: This must be populated with the full URL for the Organization Identifier (CPRID) 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/{CPRID}



Vendors will be given the actual values for {environmentSpecificHost}/{environmentAndContextSpecificPath} in the API document at time of onboarding.



Conformance Rule: In the context of Task e180-m - Deferred RX Fill Request, this will be the PrescribeIT® Switch URI (https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/111111111)

This structure is derived from MessageHeader

Summary

Mandatory: 11 elements (1 nested mandatory element)
Must-Support: 19 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader S0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id S1..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... profile S0..*uriProfiles this resource claims to conform to
... timestamp S1..1instantTime that the message was sent
... event S1..1CodingCode for the event this message represents
Binding: SharedMessageEvents (20190415) (preferred)
.... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents
.... code S1..1codeSymbol in syntax defined by the system
... response S0..1BackboneElementIf this is a reply to prior message
.... identifier S1..1idId of original message
.... details S0..1Reference(Shared Health Operation Outcome) {b}A reference from one resource to another
... source S1..1BackboneElementMessage Source Application
.... ext-messageheader-application-id S1..1uriSending application id
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id
.... ext-messageheader-conformance-version S1..1stringConformance version
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version
.... name S0..1stringName of system
.... software S1..1stringName of software running the system
.... version S1..1stringVersion of software running
.... endpoint S1..1uriActual message source address or id
... destination S1..*BackboneElementMessage Destination Application(s)
.... endpoint S1..1uriActual destination address or id

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader SΣ0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id SΣ1..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile SΣ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... timestamp SΣ1..1instantTime that the message was sent
... event ?!SΣ1..1CodingCode for the event this message represents
Binding: SharedMessageEvents (20190415) (preferred)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents
.... version Σ0..1stringVersion of the system - if relevant
.... code SΣ1..1codeSymbol in syntax defined by the system
.... display Σ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... response ?!SΣ0..1BackboneElementIf this is a reply to prior message
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier SΣ1..1idId of original message
.... code ?!Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message

.... details SΣ0..1Reference(Shared Health Operation Outcome) {b}A reference from one resource to another
... source SΣ1..1BackboneElementMessage Source Application
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-messageheader-application-id S1..1uriSending application id
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id
.... ext-messageheader-conformance-version S1..1stringConformance version
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name SΣ0..1stringName of system
.... software SΣ1..1stringName of software running the system
.... version SΣ1..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint SΣ1..1uriActual message source address or id
... destination SΣ1..*BackboneElementMessage Destination Application(s)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint SΣ1..1uriActual destination address or id
... enterer Σ0..1Reference(Practitioner)The source of the data entry
... author Σ0..1Reference(Practitioner)The source of the decision
... receiver Σ0..1Reference(Practitioner | Organization)Intended "real-world" recipient for the data
... responsible Σ0..1Reference(Practitioner | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: Example Message Reason Codes (example): Reason for event occurrence

... data Σ0..*Reference(Resource)The actual content of the message

doco Documentation for this format

Grid View

This structure is derived from MessageHeader

NameCard.TypeConstraints and Usage
.  MessageHeader 0..*MessageHeaderDefinition:
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..1idDefinition:
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..1MetaDefinition:
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..*uriDefinition:
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..1instantDefinition:
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..1CodingBinding: SharedMessageEvents (20190415) (preferred)
Definition:
Code that identifies the event this message represents and connects it with its definition.

...  system 1..1uriFixed 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..1codeDefinition:
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..1BackboneElementDefinition:
Information about the message that this message is a response to. Only present if this message is a response.

...  identifier 1..1idDefinition:
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..1Reference(Shared Health Operation Outcome) {b}Definition:
A reference from one resource to another.


Comments:


..  source 1..1BackboneElementDefinition:
The source application from which this message originated.

...  extension
       (applicationId)
1..1Message Header Application IdDefinition:
Unique identifier for the application responsible for sending a message.


Comments:
Vendors will be assigned this identifier upon registration by PrescribeIT® technical support.

...  extension
       (conformanceVersion)
1..1Message Header Source Conformance VersionDefinition:
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..1stringDefinition:
Human-readable name for the source system.


Comments:
Usage Note: The name of the Vendor.

...  software 1..1stringDefinition:
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..1stringDefinition:
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..1uriDefinition:
Identifies the routing target to send acknowledgements to.


Comments:
Conformance Rule: This must be populated with the full URL for the Organization Identifier (CPRID) 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/{CPRID}



Vendors will be given the actual values for {environmentSpecificHost}/{environmentAndContextSpecificPath} in the API document at time of onboarding.

..  destination 1..*BackboneElementDefinition:
The destination application which the message is intended for.


Comments:
Usage Note: This is used to specify the destination system.

...  endpoint 1..1uriDefinition:
Indicates where the message should be routed to.


Comments:
Conformance Rule: This must be populated with the full URL for the Organization Identifier (CPRID) 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/{CPRID}



Vendors will be given the actual values for {environmentSpecificHost}/{environmentAndContextSpecificPath} in the API document at time of onboarding.



Conformance Rule: In the context of Task e180-m - Deferred RX Fill Request, this will be the PrescribeIT® Switch URI (https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/111111111)

This structure is derived from MessageHeader

Summary

Mandatory: 11 elements (1 nested mandatory element)
Must-Support: 19 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader S0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id S1..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... profile S0..*uriProfiles this resource claims to conform to
... timestamp S1..1instantTime that the message was sent
... event S1..1CodingCode for the event this message represents
Binding: SharedMessageEvents (20190415) (preferred)
.... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents
.... code S1..1codeSymbol in syntax defined by the system
... response S0..1BackboneElementIf this is a reply to prior message
.... identifier S1..1idId of original message
.... details S0..1Reference(Shared Health Operation Outcome) {b}A reference from one resource to another
... source S1..1BackboneElementMessage Source Application
.... ext-messageheader-application-id S1..1uriSending application id
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id
.... ext-messageheader-conformance-version S1..1stringConformance version
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version
.... name S0..1stringName of system
.... software S1..1stringName of software running the system
.... version S1..1stringVersion of software running
.... endpoint S1..1uriActual message source address or id
... destination S1..*BackboneElementMessage Destination Application(s)
.... endpoint S1..1uriActual destination address or id

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader SΣ0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id SΣ1..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile SΣ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... timestamp SΣ1..1instantTime that the message was sent
... event ?!SΣ1..1CodingCode for the event this message represents
Binding: SharedMessageEvents (20190415) (preferred)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents
.... version Σ0..1stringVersion of the system - if relevant
.... code SΣ1..1codeSymbol in syntax defined by the system
.... display Σ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... response ?!SΣ0..1BackboneElementIf this is a reply to prior message
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier SΣ1..1idId of original message
.... code ?!Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message

.... details SΣ0..1Reference(Shared Health Operation Outcome) {b}A reference from one resource to another
... source SΣ1..1BackboneElementMessage Source Application
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-messageheader-application-id S1..1uriSending application id
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id
.... ext-messageheader-conformance-version S1..1stringConformance version
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name SΣ0..1stringName of system
.... software SΣ1..1stringName of software running the system
.... version SΣ1..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint SΣ1..1uriActual message source address or id
... destination SΣ1..*BackboneElementMessage Destination Application(s)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint SΣ1..1uriActual destination address or id
... enterer Σ0..1Reference(Practitioner)The source of the data entry
... author Σ0..1Reference(Practitioner)The source of the decision
... receiver Σ0..1Reference(Practitioner | Organization)Intended "real-world" recipient for the data
... responsible Σ0..1Reference(Practitioner | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: Example Message Reason Codes (example): Reason for event occurrence

... data Σ0..*Reference(Resource)The actual content of the message

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
MessageHeader.meta.securityextensibleAll Security Labels
MessageHeader.meta.tagexample
MessageHeader.languagerequiredhttp://tools.ietf.org/html/bcp47
MessageHeader.eventpreferredSharedMessageEvents
MessageHeader.response.coderequiredResponseType
MessageHeader.reasonexampleExample Message Reason Codes

Constraints

IdPathDetailsRequirements