Shared Health Specification and Guide Version 5.0

 

Definitions for the interaction-messageheader-997 Profile.

1. MessageHeader
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.

Control0..*
Must Supporttrue
Max Length0
2. MessageHeader.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control1..1
Typeid
Must Supporttrue
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.

Max Length0
3. MessageHeader.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.

Control1..1
TypeMeta
Must Supporttrue
Comments

See children

Max Length0
4. MessageHeader.meta.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
5. MessageHeader.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
6. MessageHeader.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Max Length0
7. MessageHeader.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

Max Length0
8. MessageHeader.meta.profile
Definition

A list of profiles StructureDefinitions that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..1
Typeuri
Must Supporttrue
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.

Max Length0
SlicingThis element introduces a set of slices on MessageHeader.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ value
9. MessageHeader.meta.profile:profile
SliceNameprofile
Definition

A list of profiles StructureDefinitions that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..1
Typeuri
Must Supporttrue
Comments

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

Max Length0
Fixed Valuehttp://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-997
10. MessageHeader.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System.
TypeCoding
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Max Length0
11. MessageHeader.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Max Length0
12. MessageHeader.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Max Length0
13. MessageHeader.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Max Length0
14. MessageHeader.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Max Length0
15. MessageHeader.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Max Length0
16. MessageHeader.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
17. MessageHeader.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
18. MessageHeader.timestamp
Definition

Time and date the transaction was created

Control1..1
Typeinstant
Must Supporttrue
Requirements

Allows limited detection of out-of-order and delayed transmission. Also supports audit.

Comments

Conformance Rule: Must be a full date and time with timezone (i.e. yyyy-mm-ddTHH:mm:ss.SSS-ZZZZZ).

Max Length0
19. MessageHeader.event
Definition

Code that identifies the event this message represents and connects it with its definition.

Control1..1
BindingThe codes SHOULD be taken from SharedMessageEvents (20220810)
TypeCoding
Is Modifiertrue
Must Supporttrue
Requirements

Drives the behavior associated with this message.

Max Length0
20. MessageHeader.event.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
21. MessageHeader.event.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
22. MessageHeader.event.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents

Max Length0
Fixed Valuehttps://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents
23. MessageHeader.event.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
24. MessageHeader.event.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).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments

Fixed value: 997

Max Length0
Fixed Value997
25. MessageHeader.event.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Max Length0
26. MessageHeader.event.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
27. MessageHeader.response
Definition

Information about the message that this message is a response to. Only present if this message is a response.

Control1..1
TypeBackboneElement
Is Modifiertrue
Must Supporttrue
Max Length0
28. MessageHeader.response.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
29. MessageHeader.response.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
30. MessageHeader.response.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
31. MessageHeader.response.identifier
Definition

The id of the message that this message is a response to.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
Typeid
Must Supporttrue
Requirements

Allows receiver to know what message is being responded 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.

Max Length0
32. MessageHeader.response.code
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.

Control1..1
BindingThe codes SHALL be taken from SharedMessageHeaderResponseCodeError (20190415)
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

Allows the sender of the acknowledge message to know if the request was successful or if action is needed.

Comments

Usage Note: 997, 998 and 999 messages generated by Central Switch have value = 'transient-error'.

Max Length0
33. MessageHeader.response.details
Definition

A reference from one resource to another.

Control1..1
TypeReference(Shared Health Reference)(Shared Health Operation Outcome)
Must Supporttrue
Requirements

Allows the sender of the message to determine what the specific issues are.

Comments

-

Max Length0
34. MessageHeader.source
Definition

The source application from which this message originated.

Control1..1
TypeBackboneElement
Must Supporttrue
Requirements

Allows replies, supports audit.

Max Length0
35. MessageHeader.source.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
36. MessageHeader.source.extension
Definition

An Extension

Control0..*
TypeExtension
Max Length0
SlicingThis element introduces a set of slices on MessageHeader.source.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
37. MessageHeader.source.extension:applicationId
SliceNameapplicationId
Definition

Unique identifier for the application responsible for sending a message.

Control1..1
TypeExtension(Message Header Application Id) (Extension Type: uri)
Must Supporttrue
Comments

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

Max Length0
38. MessageHeader.source.extension:conformanceVersion
SliceNameconformanceVersion
Definition

String identifying the version of the sending software application that was most recently subjected to conformance testing

Control1..1
TypeExtension(Message Header Source Conformance Version) (Extension Type: string)
Must Supporttrue
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.

Max Length0
39. MessageHeader.source.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
40. MessageHeader.source.name
Definition

Human-readable name for the source system.

Control0..1
Typestring
Must Supporttrue
Requirements

May be used to support audit.

Comments

Usage Note: The name of the Vendor.

Usage Note: Max Length = 100 characters. If greater than this limit, an error will be returned

Max Length0
41. MessageHeader.source.software
Definition

May include configuration or other information useful in debugging.

Control1..1
Typestring
Must Supporttrue
Requirements

Supports audit and possibly interface engine behavior.

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.

Max Length0
42. MessageHeader.source.version
Definition

Can convey versions of multiple systems in situations where a message passes through multiple hands.

NoteThis is a business versionId, not a resource version id (see discussion)
Control1..1
Typestring
Must Supporttrue
Requirements

Supports audit and possibly interface engine behavior.

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.

Max Length0
43. MessageHeader.source.contact
Definition

An e-mail, phone, website or other contact point to use to resolve issues with message communications.

Control0..1
TypeContactPoint
Requirements

Allows escalation of technical issues.

Max Length0
44. MessageHeader.source.endpoint
Definition

Identifies the routing target to send acknowledgements to.

Control1..1
Typeuri
Must Supporttrue
Requirements

Identifies where to send responses, may influence security permissions.

Comments

Conformance Rule: This identifies the organization who did not successfully receive and/or process the message.

Max Length0
45. MessageHeader.destination
Definition

The destination application which the message is intended for.

Control1..1
TypeBackboneElement
Must Supporttrue
Requirements

Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".

Comments

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

Max Length0
46. MessageHeader.destination.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
47. MessageHeader.destination.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
48. MessageHeader.destination.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
49. MessageHeader.destination.name
Definition

Human-readable name for the target system.

Control0..1
Typestring
Requirements

May be used for routing of response and/or to support audit.

Max Length0
50. MessageHeader.destination.target
Definition

Identifies the target end system in situations where the initial message transmission is to an intermediary system.

Control0..1
TypeReference(Device)
Requirements

Supports multi-hop routing.

Max Length0
51. MessageHeader.destination.endpoint
Definition

Indicates where the message should be routed to.

Control1..1
Typeuri
Must Supporttrue
Requirements

Identifies where to route the message.

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.

Max Length0
52. MessageHeader.enterer
Definition

The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.

Control0..1
TypeReference(Practitioner)
Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request, but can be used in a response.

Max Length0
53. MessageHeader.author
Definition

The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.

Control0..1
TypeReference(Practitioner)
Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request, but can be used in a response.

Max Length0
54. MessageHeader.receiver
Definition

Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.

Control0..1
TypeReference(Practitioner | Organization)
Requirements

Allows routing beyond just the application level.

Max Length0
55. MessageHeader.responsible
Definition

The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.

Control0..1
TypeReference(Practitioner | Organization)
Requirements

Need to know for audit/traceback requirements and possibly for authorization.

Comments

Usually only for the request, but can be used in a response.

Max Length0
56. MessageHeader.reason
Definition

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

Control0..1
BindingFor example codes, see Example Message Reason Codes Reason for event occurrence
TypeCodeableConcept
Requirements

Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.

Max Length0
57. MessageHeader.data
Definition

The actual data of the message - a reference to the root/focus class of the event.

Control0..0
TypeReference(Resource)
Requirements

Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.

Comments

The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.

Max Length0