MessageHeader

The FHIR resource MessageHeader is for sending and receiving applications purposes

idΣ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..1CodingBinding
tagΣ0..1Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..1Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
eventUriuri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1string
id0..0string
extensionI0..*Extension
referenceΣ I0..0string
typeΣ0..0uriBinding
identifierΣ0..0Identifier
displayΣ0..0string
endpointΣ1..1url
receiverΣ0..1Reference(Practitioner | PractitionerRole | Organization)
senderΣ0..1Reference(Practitioner | PractitionerRole | Organization)
entererΣ0..1Reference(Practitioner | PractitionerRole)
authorΣ0..1Reference(Practitioner | PractitionerRole)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringFixed Value
softwareΣ0..1string
versionΣ0..1string
contactΣ0..1ContactPoint
endpointΣ1..1url
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..0string
extensionI0..*Extension
codingΣ0..0Coding
textΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifierΣ1..1id
codeΣ1..1codeBinding
detailsΣ0..1Reference(OperationOutcome)
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
definitionΣ0..1canonical(MessageDefinition)
MessageHeader
DefinitionThe 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.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • v2: MSH / MSA / ERR
  • rim: Message
MessageHeader.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Mappings
  • bundleID: (bundle.id)
MessageHeader.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality1...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MessageHeader.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.meta.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MessageHeader.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...1
Typeid
SummaryTrue
Comments

Apply '2025.01.1' (This indicates FHIR changes onJan 2025).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MessageHeader.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...1
Typeinstant
SummaryTrue
Comments

Updated: Relax the previously crossed-out elements.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MessageHeader.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality0...1
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MessageHeader.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality1...1
Typecanonical(StructureDefinition)
SummaryTrue
Comments

Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader'

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader

MessageHeader.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...1
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MessageHeader.meta.tag
DefinitionTags 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.
Cardinality0...1
TypeCoding
Binding

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

CommonTags (example)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MessageHeader.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MessageHeader.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
MessageHeader.text
DefinitionA human-readable narrative that contains a summary of the resource and can 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
MessageHeader.contained
DefinitionThese 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.
Cardinality0...1
TypeResource
Aliasinline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: N/A
MessageHeader.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MessageHeader.modifierExtension
DefinitionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MessageHeader.event[x]
DefinitionCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.
Cardinality1...1
Typeuri
Binding

One of the message events defined as part of this version of FHIR.

MessageEvent (example)
SummaryTrue
Requirements

Drives the behavior associated with this message.

Comments

Apply 'http://ehealth.bc.ca/panorama/fhir/MessageHeader'

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://ehealth.bc.ca/panorama/fhir/MessageHeader

Mappings
  • w5: FiveWs.what[x]
  • v2: MSH-9.2
  • rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
MessageHeader.destination
DefinitionThe destination application which the message is intended for.
Cardinality1...*
TypeBackboneElement
SummaryTrue
Requirements

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

Comments

There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.subject[x]
  • rim: ./communicationFunction[typeCode="RCV"]
  • w5: FiveWs.subject
MessageHeader.destination.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.destination.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MessageHeader.destination.modifierExtension
DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MessageHeader.destination.name
DefinitionHuman-readable name for the target system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: MSH-5
  • rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])
  • dest-fha: fha
  • dest-HealthGateway: hgwy
  • dest-iha: iha
  • dest-nha: nha
  • dest-vcha: vcha
  • dest-viha: viha
  • dest-indigenousHealthOrganization: indigenous health organizations
MessageHeader.destination.target
DefinitionIdentifies the target end system in situations where the initial message transmission is to an intermediary system.
Cardinality0...1
TypeReference(Device)
SummaryTrue
Requirements

Supports multi-hop routing.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]
MessageHeader.destination.target.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
MessageHeader.destination.target.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MessageHeader.destination.target.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...0
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.destination.target.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...0
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.destination.target.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...0
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
MessageHeader.destination.target.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.destination.endpoint
DefinitionIndicates where the message should be routed to.
Cardinality1...1
Typeurl
SummaryTrue
Requirements

Identifies where to route the message.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: MSH-25 (or MSH-6)
  • rim: ./telecom
  • dest-fha: [id-system-local-base]/ca-bc-fha
  • dest-HealthGateway: [id-system-local-base]/ca-bc-healthGateway
  • dest-iha: [id-system-local-base]/ca-bc-iha
  • dest-nha: [id-system-local-base]/ca-bc-nha
  • dest-OutOfBC: [id-system-local-base]/ca-bc-outofprovince
  • dest-vch: [id-system-local-base]/ca-bc-vcha
  • dest-viha: [id-system-local-base]/ca-bc-viha
  • dest-IndigenousHealthOrganizations: [id-system-local-base]/ca-bc-indigenous health organizations
MessageHeader.destination.receiver
DefinitionAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole | Organization)
SummaryTrue
Requirements

Allows routing beyond just the application level.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.subject[x]
  • v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
  • rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
  • w5: FiveWs.subject
MessageHeader.sender
DefinitionIdentifies the sending system to allow the use of a trust relationship.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole | Organization)
SummaryTrue
Requirements

Allows routing beyond just the application level.

Comments

Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.subject[x]
  • v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
  • rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
  • w5: FiveWs.subject
MessageHeader.enterer
DefinitionThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.author
  • v2: EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])
MessageHeader.author
DefinitionThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.author
  • v2: ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])
MessageHeader.source
DefinitionThe source application from which this message originated - Provincial Immunization Registry (PIR)
Cardinality1...1
TypeBackboneElement
SummaryTrue
Requirements

Allows replies, supports audit.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.actor
  • rim: unique(./communicationFunction[typeCode="SND"])
MessageHeader.source.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.source.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MessageHeader.source.modifierExtension
DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MessageHeader.source.name
DefinitionHuman-readable name for the source system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

May be used to support audit.

Comments

Hardcode as "PIR Immz"

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

PIR Immz

Mappings
  • v2: MSH-3
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])
MessageHeader.source.software
DefinitionMay include configuration or other information useful in debugging.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Supports audit and possibly interface engine behavior.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SFT-3 ( +SFT-1)
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])
MessageHeader.source.version
DefinitionCan convey versions of multiple systems in situations where a message passes through multiple hands.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Supports audit and possibly interface engine behavior.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SFT-2
  • rim: (Not supported)
MessageHeader.source.contact
DefinitionAn e-mail, phone, website or other contact point to use to resolve issues with message communications.
Cardinality0...1
TypeContactPoint
SummaryTrue
Requirements

Allows escalation of technical issues.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: (MSH-22?)
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])
MessageHeader.source.endpoint
DefinitionIdentifies the routing target to send acknowledgements to.
Cardinality1...1
Typeurl
SummaryTrue
Requirements

Identifies where to send responses, may influence security permissions.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: MSH-24
  • rim: ./telecom[isNormalDatatype()]
  • PIRtest: https://pir.healthbc.org/test/immunization
  • PIRprod: https://pir.healthbc.org/prod/immunization
MessageHeader.responsible
DefinitionThe Panorama Organizational Unit and/or Client Health Region (CHR) 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.
Cardinality1...1
TypeReference(Practitioner | PractitionerRole | Organization)
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.witness
  • v2: ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode="PSN" and determinerCode="INST"] or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/scoper[isNormalEntity() and classCode="ORG" and determinerCode="INST"])
  • source-PIR: CHR or Submitter's Org
  • source-PHSL: clientHealthRegion
MessageHeader.responsible.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.responsible.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MessageHeader.responsible.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality1...1
Typestring
SummaryTrue
Comments

fullURL of Panorama + 'Organization' + (PIR Org ID).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.responsible.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.responsible.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
MessageHeader.responsible.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.reason
DefinitionCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
Cardinality0...1
TypeCodeableConcept
Binding

Reason for event occurrence.

ExampleMessageReasonCodes (example)
SummaryTrue
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.

Comments

See Mappings. List of event type(s) in alphabetical which have been triggered, also can be applied for filtering purposes.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.why[x]
  • v2: EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reasonCode[isNormalDatatype()])
  • trigger-CHR: CLIENT
  • trriger-humanSubject: CLIENT
  • trigger-riskFactor: RISKFACTOR
  • trigger-subjectName: CLIENT
  • trigger-consent: CONSENT
  • trigger-consentComment: CONSENTCMMT
  • trigger-AEFI: AEFI
  • trigger-aefiRecommendation: AEFI
  • trigger-invalidVaccine: IMMS
  • trigger-deferral: DEFERRAL
  • trigger-forecast: FORECAST
  • trigger-vaccination: IMMS
  • trigger-immsComments-IC: IMMSCMMTIC
  • trigger-immsComments-SC: IMMSCMMTSC
  • trigger-immsComments-DF: IMMSCMMTDF
  • trigger-immsComments-AE: IMMSCMMTAE
  • trigger-specialConsideration: SPECIALCONSID
  • trigger-vaccineStatus: IMMS
  • trigger-clientMerge: CLIENT
MessageHeader.reason.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
MessageHeader.reason.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MessageHeader.reason.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...0
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
MessageHeader.reason.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

To be applied if IDS message contains only Forecasting data only. See Mappings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
  • source-PIR: Forecast
MessageHeader.response
DefinitionInformation about the message that this message is a response to. Only present if this message is a response.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: MSA
  • rim: ./conveyedAcknowledgement
MessageHeader.response.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.response.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MessageHeader.response.modifierExtension
DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
MessageHeader.response.identifier
DefinitionThe MessageHeader.id of the message to which this message is a response.
Cardinality1...1
Typeid
SummaryTrue
Requirements

Allows receiver to know what message is being responded to.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: MSA-2
  • rim: ./acknowledges.id[isNormalDatatype()]
MessageHeader.response.code
DefinitionCode that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
Cardinality1...1
Typecode
Binding

The kind of response to a message.

ResponseType (required)
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: MSA-1
  • rim: ./typeCode[isNormalDatatype()]
MessageHeader.response.details
DefinitionFull details of any issues found in the message.
Cardinality0...1
TypeReference(OperationOutcome)
SummaryTrue
Requirements

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

Comments

This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: ERR
  • rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
MessageHeader.focus
DefinitionThe actual data of the message all related to a specific patient.
Cardinality1...1
TypeReference(Resource)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ" and isNormalActRelatoinship]/target)
MessageHeader.focus.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.focus.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
MessageHeader.focus.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality1...1
Typestring
SummaryTrue
Comments

fullURL of Panorama + 'Patient' + PIR Client ID

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.focus.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.focus.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
MessageHeader.focus.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
MessageHeader.definition
DefinitionPermanent link to the MessageDefinition for this message.
Cardinality0...1
Typecanonical(MessageDefinition)
SummaryTrue
Requirements

Allows sender to define the expected contents of the message.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Not directly supported.
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="f1b0af3a-c77c-4357-be00-acc45bdee22b" />
    <meta>
        <versionId value="18" />
        <lastUpdated value="2025-01-24T22:57:28.3446711+00:00" />
    </meta>
    <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader" />
    <name value="MessageHeader" />
    <status value="draft" />
    <date value="2022-03-12T00:03:09.9131217+00:00" />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="MessageHeader" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/MessageHeader" />
    <derivation value="constraint" />
    <differential>
        <element id="MessageHeader.id">
            <path value="MessageHeader.id" />
            <short value="Same unique GUID as resourceBundle.id" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="bundleID" />
                <map value="(bundle.id)" />
            </mapping>
        </element>
        <element id="MessageHeader.meta">
            <path value="MessageHeader.meta" />
            <min value="1" />
        </element>
        <element id="MessageHeader.meta.versionId">
            <path value="MessageHeader.meta.versionId" />
            <comment value="Apply &#39;2025.01.1&#39; (This indicates FHIR changes onJan 2025)." />
        </element>
        <element id="MessageHeader.meta.lastUpdated">
            <path value="MessageHeader.meta.lastUpdated" />
            <comment value="Updated: Relax the previously crossed-out elements." />
        </element>
        <element id="MessageHeader.meta.profile">
            <path value="MessageHeader.meta.profile" />
            <comment value="Use &#39;http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader&#39;" />
            <min value="1" />
            <max value="1" />
            <fixedCanonical value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader" />
        </element>
        <element id="MessageHeader.meta.security">
            <path value="MessageHeader.meta.security" />
            <max value="1" />
        </element>
        <element id="MessageHeader.meta.tag">
            <path value="MessageHeader.meta.tag" />
            <max value="1" />
        </element>
        <element id="MessageHeader.contained">
            <path value="MessageHeader.contained" />
            <max value="1" />
        </element>
        <element id="MessageHeader.event[x]">
            <path value="MessageHeader.event[x]" />
            <comment value="Apply &#39;http://ehealth.bc.ca/panorama/fhir/MessageHeader&#39;" />
            <type>
                <code value="uri" />
            </type>
            <fixedUri value="http://ehealth.bc.ca/panorama/fhir/MessageHeader" />
        </element>
        <element id="MessageHeader.destination">
            <path value="MessageHeader.destination" />
            <min value="1" />
        </element>
        <element id="MessageHeader.destination.name">
            <path value="MessageHeader.destination.name" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="dest-fha" />
                <map value="fha" />
            </mapping>
            <mapping>
                <identity value="dest-HealthGateway" />
                <map value="hgwy" />
            </mapping>
            <mapping>
                <identity value="dest-iha" />
                <map value="iha" />
            </mapping>
            <mapping>
                <identity value="dest-nha" />
                <map value="nha" />
                <comment value="NHA COVID Immunization Record" />
            </mapping>
            <mapping>
                <identity value="dest-vcha" />
                <map value="vcha" />
            </mapping>
            <mapping>
                <identity value="dest-viha" />
                <map value="viha" />
                <comment value="VIHA  COVID Immunization Record" />
            </mapping>
            <mapping>
                <identity value="dest-indigenousHealthOrganization" />
                <map value="indigenous health organizations" />
            </mapping>
        </element>
        <element id="MessageHeader.destination.target.id">
            <path value="MessageHeader.destination.target.id" />
            <max value="0" />
        </element>
        <element id="MessageHeader.destination.target.reference">
            <path value="MessageHeader.destination.target.reference" />
            <max value="0" />
        </element>
        <element id="MessageHeader.destination.target.type">
            <path value="MessageHeader.destination.target.type" />
            <max value="0" />
        </element>
        <element id="MessageHeader.destination.target.identifier">
            <path value="MessageHeader.destination.target.identifier" />
            <max value="0" />
        </element>
        <element id="MessageHeader.destination.target.display">
            <path value="MessageHeader.destination.target.display" />
            <max value="0" />
        </element>
        <element id="MessageHeader.destination.endpoint">
            <path value="MessageHeader.destination.endpoint" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="dest-fha" />
                <map value="[id-system-local-base]/ca-bc-fha" />
            </mapping>
            <mapping>
                <identity value="dest-HealthGateway" />
                <map value="[id-system-local-base]/ca-bc-healthGateway" />
            </mapping>
            <mapping>
                <identity value="dest-iha" />
                <map value="[id-system-local-base]/ca-bc-iha" />
            </mapping>
            <mapping>
                <identity value="dest-nha" />
                <map value="[id-system-local-base]/ca-bc-nha" />
                <comment value="NHA endpoint" />
            </mapping>
            <mapping>
                <identity value="dest-OutOfBC" />
                <map value="[id-system-local-base]/ca-bc-outofprovince" />
            </mapping>
            <mapping>
                <identity value="dest-vch" />
                <map value="[id-system-local-base]/ca-bc-vcha" />
            </mapping>
            <mapping>
                <identity value="dest-viha" />
                <map value="[id-system-local-base]/ca-bc-viha" />
                <comment value="VIHA endpoint" />
            </mapping>
            <mapping>
                <identity value="dest-IndigenousHealthOrganizations" />
                <map value="[id-system-local-base]/ca-bc-indigenous health organizations" />
            </mapping>
        </element>
        <element id="MessageHeader.source">
            <path value="MessageHeader.source" />
            <short value="Message source application - PIR" />
            <definition value="The source application from which this message originated - Provincial Immunization Registry (PIR)" />
        </element>
        <element id="MessageHeader.source.name">
            <path value="MessageHeader.source.name" />
            <comment value="Hardcode as &quot;PIR Immz&quot;" />
            <min value="1" />
            <fixedString value="PIR Immz" />
        </element>
        <element id="MessageHeader.source.endpoint">
            <path value="MessageHeader.source.endpoint" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="PIRtest" />
                <map value="https://pir.healthbc.org/test/immunization" />
                <comment value="PIR Test Environment" />
            </mapping>
            <mapping>
                <identity value="PIRprod" />
                <map value="https://pir.healthbc.org/prod/immunization" />
                <comment value="PIR Prod ennvironment" />
            </mapping>
        </element>
        <element id="MessageHeader.responsible">
            <path value="MessageHeader.responsible" />
            <short value="The Panorama Organizational Unit and/or Client Health Region which submitted the message contents." />
            <definition value="The Panorama Organizational Unit and/or Client Health Region (CHR) 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." />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="CHR or Submitter&#39;s Org" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="clientHealthRegion" />
            </mapping>
        </element>
        <element id="MessageHeader.responsible.reference">
            <path value="MessageHeader.responsible.reference" />
            <comment value="fullURL of Panorama + &#39;Organization&#39; + (PIR Org ID)." />
            <min value="1" />
        </element>
        <element id="MessageHeader.reason">
            <path value="MessageHeader.reason" />
            <comment value="See Mappings.  List of event type(s) in alphabetical which have been triggered, also can be applied for filtering purposes." />
            <mapping>
                <identity value="trigger-CHR" />
                <map value="CLIENT" />
            </mapping>
            <mapping>
                <identity value="trriger-humanSubject" />
                <map value="CLIENT" />
            </mapping>
            <mapping>
                <identity value="trigger-riskFactor" />
                <map value="RISKFACTOR" />
            </mapping>
            <mapping>
                <identity value="trigger-subjectName" />
                <map value="CLIENT" />
            </mapping>
            <mapping>
                <identity value="trigger-consent" />
                <map value="CONSENT" />
            </mapping>
            <mapping>
                <identity value="trigger-consentComment" />
                <map value="CONSENTCMMT" />
            </mapping>
            <mapping>
                <identity value="trigger-AEFI" />
                <map value="AEFI" />
            </mapping>
            <mapping>
                <identity value="trigger-aefiRecommendation" />
                <map value="AEFI" />
            </mapping>
            <mapping>
                <identity value="trigger-invalidVaccine" />
                <map value="IMMS" />
            </mapping>
            <mapping>
                <identity value="trigger-deferral" />
                <map value="DEFERRAL" />
            </mapping>
            <mapping>
                <identity value="trigger-forecast" />
                <map value="FORECAST" />
            </mapping>
            <mapping>
                <identity value="trigger-vaccination" />
                <map value="IMMS" />
            </mapping>
            <mapping>
                <identity value="trigger-immsComments-IC" />
                <map value="IMMSCMMTIC" />
            </mapping>
            <mapping>
                <identity value="trigger-immsComments-SC" />
                <map value="IMMSCMMTSC" />
            </mapping>
            <mapping>
                <identity value="trigger-immsComments-DF" />
                <map value="IMMSCMMTDF" />
            </mapping>
            <mapping>
                <identity value="trigger-immsComments-AE" />
                <map value="IMMSCMMTAE" />
            </mapping>
            <mapping>
                <identity value="trigger-specialConsideration" />
                <map value="SPECIALCONSID" />
            </mapping>
            <mapping>
                <identity value="trigger-vaccineStatus" />
                <map value="IMMS" />
            </mapping>
            <mapping>
                <identity value="trigger-clientMerge" />
                <map value="CLIENT" />
            </mapping>
        </element>
        <element id="MessageHeader.reason.id">
            <path value="MessageHeader.reason.id" />
            <max value="0" />
        </element>
        <element id="MessageHeader.reason.coding">
            <path value="MessageHeader.reason.coding" />
            <max value="0" />
        </element>
        <element id="MessageHeader.reason.text">
            <path value="MessageHeader.reason.text" />
            <comment value="To be applied if IDS message contains only Forecasting data only.  See Mappings." />
            <mapping>
                <identity value="source-PIR" />
                <map value="Forecast" />
            </mapping>
        </element>
        <element id="MessageHeader.focus">
            <path value="MessageHeader.focus" />
            <short value="The actual content of the message related to a specific patient." />
            <definition value="The actual data of the message all related to a specific patient." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="MessageHeader.focus.reference">
            <path value="MessageHeader.focus.reference" />
            <comment value="fullURL of Panorama + &#39;Patient&#39; + PIR Client ID" />
            <min value="1" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "f1b0af3a-c77c-4357-be00-acc45bdee22b",
    "meta": {
        "versionId": "18",
        "lastUpdated": "01/24/2025 22:57:28"
    },
    "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader",
    "name": "MessageHeader",
    "status": "draft",
    "date": "03/12/2022 00:03:09",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "MessageHeader",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "MessageHeader.id",
                "path": "MessageHeader.id",
                "short": "Same unique GUID as resourceBundle.id",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "bundleID",
                        "map": "(bundle.id)"
                    }
                ]
            },
            {
                "id": "MessageHeader.meta",
                "path": "MessageHeader.meta",
                "min": 1
            },
            {
                "id": "MessageHeader.meta.versionId",
                "path": "MessageHeader.meta.versionId",
                "comment": "Apply '2025.01.1' (This indicates FHIR changes onJan 2025)."
            },
            {
                "id": "MessageHeader.meta.lastUpdated",
                "path": "MessageHeader.meta.lastUpdated",
                "comment": "Updated: Relax the previously crossed-out elements."
            },
            {
                "id": "MessageHeader.meta.profile",
                "path": "MessageHeader.meta.profile",
                "comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader'",
                "min": 1,
                "max": "1",
                "fixedCanonical": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader"
            },
            {
                "id": "MessageHeader.meta.security",
                "path": "MessageHeader.meta.security",
                "max": "1"
            },
            {
                "id": "MessageHeader.meta.tag",
                "path": "MessageHeader.meta.tag",
                "max": "1"
            },
            {
                "id": "MessageHeader.contained",
                "path": "MessageHeader.contained",
                "max": "1"
            },
            {
                "id": "MessageHeader.event[x]",
                "path": "MessageHeader.event[x]",
                "comment": "Apply 'http://ehealth.bc.ca/panorama/fhir/MessageHeader'",
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "fixedUri": "http://ehealth.bc.ca/panorama/fhir/MessageHeader"
            },
            {
                "id": "MessageHeader.destination",
                "path": "MessageHeader.destination",
                "min": 1
            },
            {
                "id": "MessageHeader.destination.name",
                "path": "MessageHeader.destination.name",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "dest-fha",
                        "map": "fha"
                    },
                    {
                        "identity": "dest-HealthGateway",
                        "map": "hgwy"
                    },
                    {
                        "identity": "dest-iha",
                        "map": "iha"
                    },
                    {
                        "identity": "dest-nha",
                        "map": "nha",
                        "comment": "NHA COVID Immunization Record"
                    },
                    {
                        "identity": "dest-vcha",
                        "map": "vcha"
                    },
                    {
                        "identity": "dest-viha",
                        "map": "viha",
                        "comment": "VIHA  COVID Immunization Record"
                    },
                    {
                        "identity": "dest-indigenousHealthOrganization",
                        "map": "indigenous health organizations"
                    }
                ]
            },
            {
                "id": "MessageHeader.destination.target.id",
                "path": "MessageHeader.destination.target.id",
                "max": "0"
            },
            {
                "id": "MessageHeader.destination.target.reference",
                "path": "MessageHeader.destination.target.reference",
                "max": "0"
            },
            {
                "id": "MessageHeader.destination.target.type",
                "path": "MessageHeader.destination.target.type",
                "max": "0"
            },
            {
                "id": "MessageHeader.destination.target.identifier",
                "path": "MessageHeader.destination.target.identifier",
                "max": "0"
            },
            {
                "id": "MessageHeader.destination.target.display",
                "path": "MessageHeader.destination.target.display",
                "max": "0"
            },
            {
                "id": "MessageHeader.destination.endpoint",
                "path": "MessageHeader.destination.endpoint",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "dest-fha",
                        "map": "[id-system-local-base]/ca-bc-fha"
                    },
                    {
                        "identity": "dest-HealthGateway",
                        "map": "[id-system-local-base]/ca-bc-healthGateway"
                    },
                    {
                        "identity": "dest-iha",
                        "map": "[id-system-local-base]/ca-bc-iha"
                    },
                    {
                        "identity": "dest-nha",
                        "map": "[id-system-local-base]/ca-bc-nha",
                        "comment": "NHA endpoint"
                    },
                    {
                        "identity": "dest-OutOfBC",
                        "map": "[id-system-local-base]/ca-bc-outofprovince"
                    },
                    {
                        "identity": "dest-vch",
                        "map": "[id-system-local-base]/ca-bc-vcha"
                    },
                    {
                        "identity": "dest-viha",
                        "map": "[id-system-local-base]/ca-bc-viha",
                        "comment": "VIHA endpoint"
                    },
                    {
                        "identity": "dest-IndigenousHealthOrganizations",
                        "map": "[id-system-local-base]/ca-bc-indigenous health organizations"
                    }
                ]
            },
            {
                "id": "MessageHeader.source",
                "path": "MessageHeader.source",
                "short": "Message source application - PIR",
                "definition": "The source application from which this message originated - Provincial Immunization Registry (PIR)"
            },
            {
                "id": "MessageHeader.source.name",
                "path": "MessageHeader.source.name",
                "comment": "Hardcode as \"PIR Immz\"",
                "min": 1,
                "fixedString": "PIR Immz"
            },
            {
                "id": "MessageHeader.source.endpoint",
                "path": "MessageHeader.source.endpoint",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "PIRtest",
                        "map": "https://pir.healthbc.org/test/immunization",
                        "comment": "PIR Test Environment"
                    },
                    {
                        "identity": "PIRprod",
                        "map": "https://pir.healthbc.org/prod/immunization",
                        "comment": "PIR Prod ennvironment"
                    }
                ]
            },
            {
                "id": "MessageHeader.responsible",
                "path": "MessageHeader.responsible",
                "short": "The Panorama Organizational Unit and/or Client Health Region which submitted the message contents.",
                "definition": "The Panorama Organizational Unit and/or Client Health Region (CHR) 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.",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "CHR or Submitter's Org"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "clientHealthRegion"
                    }
                ]
            },
            {
                "id": "MessageHeader.responsible.reference",
                "path": "MessageHeader.responsible.reference",
                "comment": "fullURL of Panorama + 'Organization' + (PIR Org ID).",
                "min": 1
            },
            {
                "id": "MessageHeader.reason",
                "path": "MessageHeader.reason",
                "comment": "See Mappings.  List of event type(s) in alphabetical which have been triggered, also can be applied for filtering purposes.",
                "mapping":  [
                    {
                        "identity": "trigger-CHR",
                        "map": "CLIENT"
                    },
                    {
                        "identity": "trriger-humanSubject",
                        "map": "CLIENT"
                    },
                    {
                        "identity": "trigger-riskFactor",
                        "map": "RISKFACTOR"
                    },
                    {
                        "identity": "trigger-subjectName",
                        "map": "CLIENT"
                    },
                    {
                        "identity": "trigger-consent",
                        "map": "CONSENT"
                    },
                    {
                        "identity": "trigger-consentComment",
                        "map": "CONSENTCMMT"
                    },
                    {
                        "identity": "trigger-AEFI",
                        "map": "AEFI"
                    },
                    {
                        "identity": "trigger-aefiRecommendation",
                        "map": "AEFI"
                    },
                    {
                        "identity": "trigger-invalidVaccine",
                        "map": "IMMS"
                    },
                    {
                        "identity": "trigger-deferral",
                        "map": "DEFERRAL"
                    },
                    {
                        "identity": "trigger-forecast",
                        "map": "FORECAST"
                    },
                    {
                        "identity": "trigger-vaccination",
                        "map": "IMMS"
                    },
                    {
                        "identity": "trigger-immsComments-IC",
                        "map": "IMMSCMMTIC"
                    },
                    {
                        "identity": "trigger-immsComments-SC",
                        "map": "IMMSCMMTSC"
                    },
                    {
                        "identity": "trigger-immsComments-DF",
                        "map": "IMMSCMMTDF"
                    },
                    {
                        "identity": "trigger-immsComments-AE",
                        "map": "IMMSCMMTAE"
                    },
                    {
                        "identity": "trigger-specialConsideration",
                        "map": "SPECIALCONSID"
                    },
                    {
                        "identity": "trigger-vaccineStatus",
                        "map": "IMMS"
                    },
                    {
                        "identity": "trigger-clientMerge",
                        "map": "CLIENT"
                    }
                ]
            },
            {
                "id": "MessageHeader.reason.id",
                "path": "MessageHeader.reason.id",
                "max": "0"
            },
            {
                "id": "MessageHeader.reason.coding",
                "path": "MessageHeader.reason.coding",
                "max": "0"
            },
            {
                "id": "MessageHeader.reason.text",
                "path": "MessageHeader.reason.text",
                "comment": "To be applied if IDS message contains only Forecasting data only.  See Mappings.",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "Forecast"
                    }
                ]
            },
            {
                "id": "MessageHeader.focus",
                "path": "MessageHeader.focus",
                "short": "The actual content of the message related to a specific patient.",
                "definition": "The actual data of the message all related to a specific patient.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "MessageHeader.focus.reference",
                "path": "MessageHeader.focus.reference",
                "comment": "fullURL of Panorama + 'Patient' + PIR Client ID",
                "min": 1
            }
        ]
    }
}