Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998

Download Excel representation

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

>

This structure is derived from Message Header - Asynchronous message rejection

NameCard.TypeConstraints and Usage
.  MessageHeader 0..*Message Header - Asynchronous message rejectionDefinition:
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 1..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 1..1uriSlice: Unordered, Open by value:value
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.

...  profile
       (profile)
1..1uriFixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


Comments:
Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998

..  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..1codeFixed Value: 998
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).


Comments:
Fixed value: 998

..  response 1..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 should be populated with the MessageHeader.id from the message that is being rejected.  Upon receipt, vendors will use this identfier to discover the message that is being rejected.



In the context of PrescribeIT® Quebec Bundle Available for Retrieval Notification PMS (i.e. not Central Switch) error handling, this value is derived from the 903 MessageHeader.response.identifier that contains the MessageHeader.id assigned by the EMR clinic in the originating Bundle 401 message.

...  code 1..1codeBinding: SharedMessageHeaderResponseCodeError (20190415) (required)
Definition:
Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.


Comments:
This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data.

...  details 1..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 identifies Health Exchange who created this response.

..  destination 1..1BackboneElementDefinition:
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:
This will be the endpoint of the sender of the original message that is being rejected.



In the context of PrescribeIT® Quebec Bundle Available for Retrieval Notification error handling, this is the EMR Clinic that sent the original Bundle 401 message.

This structure is derived from Message Header - Asynchronous message rejection

Summary

Mandatory: 4 elements
Must-Support: 6 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element MessageHeader.meta.profile is sliced based on the value of value:value

This structure is derived from Message Header - Asynchronous message rejection

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader S0..*Message Header - Asynchronous message rejectionA resource that describes a message that is exchanged between systems
... meta S1..1MetaMetadata about the resource
.... profile S1..1(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile S1..1uriProfiles this resource claims to conform to
Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998
... event S1..1CodingCode for the event this message represents
.... code S1..1codeSymbol in syntax defined by the system
Fixed Value: 998
... source
.... endpoint S1..1uriActual message source address or id

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader SΣ0..*Message Header - Asynchronous message rejectionA resource that describes a message that is exchanged between systems
... id SΣ1..1idLogical id of this artifact
... meta SΣ1..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Σ1..1(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998
.... 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
Fixed Value: 998
.... display Σ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... response ?!SΣ1..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 ?!SΣ1..1codeok | transient-error | fatal-error
Binding: SharedMessageHeaderResponseCodeError (20190415) (required)
.... details SΣ1..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..1BackboneElementMessage 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


doco Documentation for this format

Grid View

This structure is derived from Message Header - Asynchronous message rejection

NameCard.TypeConstraints and Usage
.  MessageHeader 0..*Message Header - Asynchronous message rejectionDefinition:
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 1..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 1..1uriSlice: Unordered, Open by value:value
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.

...  profile
       (profile)
1..1uriFixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


Comments:
Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998

..  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..1codeFixed Value: 998
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).


Comments:
Fixed value: 998

..  response 1..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 should be populated with the MessageHeader.id from the message that is being rejected.  Upon receipt, vendors will use this identfier to discover the message that is being rejected.



In the context of PrescribeIT® Quebec Bundle Available for Retrieval Notification PMS (i.e. not Central Switch) error handling, this value is derived from the 903 MessageHeader.response.identifier that contains the MessageHeader.id assigned by the EMR clinic in the originating Bundle 401 message.

...  code 1..1codeBinding: SharedMessageHeaderResponseCodeError (20190415) (required)
Definition:
Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.


Comments:
This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data.

...  details 1..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 identifies Health Exchange who created this response.

..  destination 1..1BackboneElementDefinition:
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:
This will be the endpoint of the sender of the original message that is being rejected.



In the context of PrescribeIT® Quebec Bundle Available for Retrieval Notification error handling, this is the EMR Clinic that sent the original Bundle 401 message.

This structure is derived from Message Header - Asynchronous message rejection

Summary

Mandatory: 4 elements
Must-Support: 6 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element MessageHeader.meta.profile is sliced based on the value of value:value

Differential View

This structure is derived from Message Header - Asynchronous message rejection

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader S0..*Message Header - Asynchronous message rejectionA resource that describes a message that is exchanged between systems
... meta S1..1MetaMetadata about the resource
.... profile S1..1(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile S1..1uriProfiles this resource claims to conform to
Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998
... event S1..1CodingCode for the event this message represents
.... code S1..1codeSymbol in syntax defined by the system
Fixed Value: 998
... source
.... endpoint S1..1uriActual message source address or id

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader SΣ0..*Message Header - Asynchronous message rejectionA resource that describes a message that is exchanged between systems
... id SΣ1..1idLogical id of this artifact
... meta SΣ1..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Σ1..1(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-998
.... 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
Fixed Value: 998
.... display Σ0..1stringRepresentation defined by the system
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... response ?!SΣ1..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 ?!SΣ1..1codeok | transient-error | fatal-error
Binding: SharedMessageHeaderResponseCodeError (20190415) (required)
.... details SΣ1..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..1BackboneElementMessage 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


doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Constraints

PathConformanceValueSet
MessageHeader.meta.securityextensibleAll Security Labels
MessageHeader.meta.tagexample
MessageHeader.languagerequiredhttp://tools.ietf.org/html/bcp47
MessageHeader.eventpreferredFixed Value: 998
MessageHeader.response.coderequiredSharedMessageHeaderResponseCodeError
MessageHeader.reasonexampleExample Message Reason Codes
IdPathDetailsRequirements
© 2017+ . Based on FHIR version (1.4.0-8139). IG generated on Fri, Feb 4, 2022 12:22-0500. | IG Change History