Pan-Canadian eReferral-eConsult (CA:eReC) iGuide

DRAFT - The specification is currently in development and subject to significant change. It is not ready for limited roll-out or production level use.

MessageHeader (CA:eReC)

Structure Definition: MessageHeader Profile

Canonical URL:https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-MessageHeader

Simplifier project page: MessageHeader

Derived from: MessageHeader (R4)

Formal Views of Profile Content

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

MessageHeader	I		MessageHeader	There are no (further) constraints on this element Element id MessageHeader Short description A resource that describes a message that is exchanged between systems Definition The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. Data type MessageHeader Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim: Entity. Role, or Act v2: MSH / MSA / ERR rim: Message
id	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	Element id MessageHeader.meta Short description Metadata about the resource Definition The 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. Comments The MustSupport flag on this element has been relaxed in this version until further confirmation of the use of meta.profile (outside of use for certain validation suites) and impact can be assessed by the working group. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id MessageHeader.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id MessageHeader.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A 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. 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id MessageHeader.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
referralIdentifier	I	0..1	Extension(Identifier)Binding	Element id MessageHeader.extension:referralIdentifier Short description Optional Extensions Element Alternate names extensions, user content Definition For requisitions this extension is used to convey the ServiceRequest.requisition identifier in the MessageHeader. 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. Data type Extension(Identifier) Extension URL https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Referral-Identifier-EXT Binding Codes supported by Ontario Health that can be used to determine which identifier to use for a specific purpose. eReferralIdentifierType (extensible) Constraints 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 rim: N/A
routingOptions	I	0..*	Extension(CodeableConcept)	Element id MessageHeader.extension:routingOptions Short description Optional Extensions Element Alternate names extensions, user content Definition For Referral Source Type identification. Only one referral routing object is expected. 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. Data type Extension(CodeableConcept) Extension URL https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Routing-Options-EXT Constraints 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 rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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). 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
event[x]	Σ	1..1		Element id MessageHeader.event[x] Short description Code for the event this message represents or link to event definition Definition Code 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. Requirements Drives the behavior associated with this message. Comments The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. Sliced: Unordered, Open, by $this(Type) Binding One of the message events defined as part of this version of FHIR. MessageEvent (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] v2: MSH-9.2 rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
eventUri			uri	There are no (further) constraints on this element Data type uri
eventCoding	S Σ	0..1	CodingBinding	Element id MessageHeader.event[x]:eventCoding Short description Code for the event this message represents or link to event definition Definition Code 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. Requirements Drives the behavior associated with this message. Comments The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. Data type Coding Binding One of the message events defined as part of this version of FHIR. MessageEventCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] v2: MSH-9.2 rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
system	Σ	0..1	uri	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ	0..1	codeBinding	Element id MessageHeader.event[x]:eventCoding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding MessageEventCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
destination	S Σ	0..*	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.destination Short description Message destination application(s) Definition The destination application which the message is intended for. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.subject[x] rim: ./communicationFunction[typeCode="RCV"] w5: FiveWs.subject
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.destination.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.destination.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.destination.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
name	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.destination.name Short description Name of system Definition Human-readable name for the target system. Requirements May be used for routing of response and/or to support audit. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-5 rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])
target	Σ I	0..1	Reference(Device)	There are no (further) constraints on this element Element id MessageHeader.destination.target Short description Particular delivery destination within the destination Definition Identifies the target end system in situations where the initial message transmission is to an intermediary system. Requirements Supports multi-hop routing. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Device) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]
endpoint	Σ	1..1	url	There are no (further) constraints on this element Element id MessageHeader.destination.endpoint Short description Actual destination address or id Definition Indicates where the message should be routed to. Requirements Identifies where to route the message. Comments The id may be a non-resolvable URI for systems that do not use standard network-based addresses. Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-25 (or MSH-6) rim: ./telecom
receiver	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.destination.receiver Short description Intended "real-world" recipient for the data Definition Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Requirements Allows routing beyond just the application level. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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
sender	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.sender Short description Real world sender of the message Definition Identifies the sending system to allow the use of a trust relationship. 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. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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
enterer	Σ I	0..1	Reference(PractitionerRole \| Practitioner)	Element id MessageHeader.enterer Short description The source of the data entry Definition The 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. 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. Data type Reference(PractitionerRole \| Practitioner) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
author	S Σ I	1..1	Reference(PractitionerRole)	Element id MessageHeader.author Short description The source of the decision Definition The 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. 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. Data type Reference(PractitionerRole) Allowed aggregation: referenced Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
source	S Σ	1..1	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.source Short description Message source application Definition The source application from which this message originated. Requirements Allows replies, supports audit. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.actor rim: unique(./communicationFunction[typeCode="SND"])
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
name	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.name Short description Name of system Definition Human-readable name for the source system. Requirements May be used to support audit. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-3 rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])
software	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.software Short description Name of software running the system Definition May include configuration or other information useful in debugging. Requirements Supports audit and possibly interface engine behavior. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: SFT-3 ( +SFT-1) rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])
version	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.version Short description Version of software running Definition Can convey versions of multiple systems in situations where a message passes through multiple hands. Requirements Supports audit and possibly interface engine behavior. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: SFT-2 rim: (Not supported)
contact	S Σ I	0..1	ContactPoint	There are no (further) constraints on this element Element id MessageHeader.source.contact Short description Human contact for problems Definition An e-mail, phone, website or other contact point to use to resolve issues with message communications. Requirements Allows escalation of technical issues. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: (MSH-22?) rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.contact.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.contact.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
system	S Σ I	0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.source.contact.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.3 rim: ./scheme servd: ./ContactPointType
value	S Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.contact.value Short description The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.source.contact.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element id MessageHeader.source.contact.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id MessageHeader.source.contact.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
endpoint	S Σ	1..1	url	There are no (further) constraints on this element Element id MessageHeader.source.endpoint Short description Actual message source address or id Definition Identifies the routing target to send acknowledgements to. Requirements Identifies where to send responses, may influence security permissions. Comments The id may be a non-resolvable URI for systems that do not use standard network-based addresses. Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-24 rim: ./telecom[isNormalDatatype()]
responsible	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.responsible Short description Final responsibility for event Definition The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. 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. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
reason	S Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element id MessageHeader.reason Short description Cause of event Definition Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. 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 Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding Reason for event occurrence. ExampleMessageReasonCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD 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()])
response	Σ	0..1	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.response Short description If this is a reply to prior message Definition Information about the message that this message is a response to. Only present if this message is a response. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA rim: ./conveyedAcknowledgement
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.response.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.response.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.response.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
identifier	Σ	1..1	id	There are no (further) constraints on this element Element id MessageHeader.response.identifier Short description Id of original message Definition The MessageHeader.id of the message to which this message is a response. Requirements Allows receiver to know what message is being responded to. Comments RFC 4122 Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA-2 rim: ./acknowledges.id[isNormalDatatype()]
code	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.response.code Short description ok \| transient-error \| fatal-error Definition Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. 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. Data type code Binding The kind of response to a message. ResponseType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA-1 rim: ./typeCode[isNormalDatatype()]
details	Σ I	0..1	Reference(OperationOutcome)	There are no (further) constraints on this element Element id MessageHeader.response.details Short description Specific list of hints/warnings/errors Definition Full details of any issues found in the message. 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. Data type Reference(OperationOutcome) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: ERR rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
focus	S Σ I	0..*	Reference(ServiceRequest \| Task \| Appointment \| Communication)	Element id MessageHeader.focus Short description The actual content of the message Definition The actual data of the message - a reference to the root/focus class of the event. 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. Data type Reference(ServiceRequest \| Task \| Appointment \| Communication) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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)
definition	Σ	0..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element id MessageHeader.definition Short description Link to the definition for this message Definition Permanent link to the MessageDefinition for this message. Requirements Allows sender to define the expected contents of the message. Comments see Canonical References Data type canonical(MessageDefinition) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: Not directly supported.

MessageHeader	I		MessageHeader	There are no (further) constraints on this element Element id MessageHeader Short description A resource that describes a message that is exchanged between systems Definition The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. Data type MessageHeader Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim: Entity. Role, or Act v2: MSH / MSA / ERR rim: Message
id	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	Element id MessageHeader.meta Short description Metadata about the resource Definition The 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. Comments The MustSupport flag on this element has been relaxed in this version until further confirmation of the use of meta.profile (outside of use for certain validation suites) and impact can be assessed by the working group. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id MessageHeader.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id MessageHeader.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A 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. 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id MessageHeader.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
referralIdentifier	I	0..1	Extension(Identifier)Binding	Element id MessageHeader.extension:referralIdentifier Short description Optional Extensions Element Alternate names extensions, user content Definition For requisitions this extension is used to convey the ServiceRequest.requisition identifier in the MessageHeader. 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. Data type Extension(Identifier) Extension URL https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Referral-Identifier-EXT Binding Codes supported by Ontario Health that can be used to determine which identifier to use for a specific purpose. eReferralIdentifierType (extensible) Constraints 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 rim: N/A
routingOptions	I	0..*	Extension(CodeableConcept)	Element id MessageHeader.extension:routingOptions Short description Optional Extensions Element Alternate names extensions, user content Definition For Referral Source Type identification. Only one referral routing object is expected. 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. Data type Extension(CodeableConcept) Extension URL https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Routing-Options-EXT Constraints 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 rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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). 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
event[x]	Σ	1..1		Element id MessageHeader.event[x] Short description Code for the event this message represents or link to event definition Definition Code 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. Requirements Drives the behavior associated with this message. Comments The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. Sliced: Unordered, Open, by $this(Type) Binding One of the message events defined as part of this version of FHIR. MessageEvent (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] v2: MSH-9.2 rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
eventUri			uri	There are no (further) constraints on this element Data type uri
eventCoding	S Σ	0..1	CodingBinding	Element id MessageHeader.event[x]:eventCoding Short description Code for the event this message represents or link to event definition Definition Code 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. Requirements Drives the behavior associated with this message. Comments The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. Data type Coding Binding One of the message events defined as part of this version of FHIR. MessageEventCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] v2: MSH-9.2 rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
system	Σ	0..1	uri	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ	0..1	codeBinding	Element id MessageHeader.event[x]:eventCoding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding MessageEventCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
destination	S Σ	0..*	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.destination Short description Message destination application(s) Definition The destination application which the message is intended for. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.subject[x] rim: ./communicationFunction[typeCode="RCV"] w5: FiveWs.subject
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.destination.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.destination.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.destination.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
name	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.destination.name Short description Name of system Definition Human-readable name for the target system. Requirements May be used for routing of response and/or to support audit. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-5 rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])
target	Σ I	0..1	Reference(Device)	There are no (further) constraints on this element Element id MessageHeader.destination.target Short description Particular delivery destination within the destination Definition Identifies the target end system in situations where the initial message transmission is to an intermediary system. Requirements Supports multi-hop routing. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Device) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]
endpoint	Σ	1..1	url	There are no (further) constraints on this element Element id MessageHeader.destination.endpoint Short description Actual destination address or id Definition Indicates where the message should be routed to. Requirements Identifies where to route the message. Comments The id may be a non-resolvable URI for systems that do not use standard network-based addresses. Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-25 (or MSH-6) rim: ./telecom
receiver	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.destination.receiver Short description Intended "real-world" recipient for the data Definition Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Requirements Allows routing beyond just the application level. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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
sender	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.sender Short description Real world sender of the message Definition Identifies the sending system to allow the use of a trust relationship. 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. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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
enterer	Σ I	0..1	Reference(PractitionerRole \| Practitioner)	Element id MessageHeader.enterer Short description The source of the data entry Definition The 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. 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. Data type Reference(PractitionerRole \| Practitioner) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
author	S Σ I	1..1	Reference(PractitionerRole)	Element id MessageHeader.author Short description The source of the decision Definition The 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. 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. Data type Reference(PractitionerRole) Allowed aggregation: referenced Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
source	S Σ	1..1	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.source Short description Message source application Definition The source application from which this message originated. Requirements Allows replies, supports audit. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.actor rim: unique(./communicationFunction[typeCode="SND"])
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
name	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.name Short description Name of system Definition Human-readable name for the source system. Requirements May be used to support audit. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-3 rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])
software	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.software Short description Name of software running the system Definition May include configuration or other information useful in debugging. Requirements Supports audit and possibly interface engine behavior. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: SFT-3 ( +SFT-1) rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])
version	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.version Short description Version of software running Definition Can convey versions of multiple systems in situations where a message passes through multiple hands. Requirements Supports audit and possibly interface engine behavior. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: SFT-2 rim: (Not supported)
contact	S Σ I	0..1	ContactPoint	There are no (further) constraints on this element Element id MessageHeader.source.contact Short description Human contact for problems Definition An e-mail, phone, website or other contact point to use to resolve issues with message communications. Requirements Allows escalation of technical issues. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: (MSH-22?) rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.contact.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.contact.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
system	S Σ I	0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.source.contact.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.3 rim: ./scheme servd: ./ContactPointType
value	S Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.contact.value Short description The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.source.contact.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element id MessageHeader.source.contact.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id MessageHeader.source.contact.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
endpoint	S Σ	1..1	url	There are no (further) constraints on this element Element id MessageHeader.source.endpoint Short description Actual message source address or id Definition Identifies the routing target to send acknowledgements to. Requirements Identifies where to send responses, may influence security permissions. Comments The id may be a non-resolvable URI for systems that do not use standard network-based addresses. Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-24 rim: ./telecom[isNormalDatatype()]
responsible	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.responsible Short description Final responsibility for event Definition The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. 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. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
reason	S Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element id MessageHeader.reason Short description Cause of event Definition Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. 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 Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding Reason for event occurrence. ExampleMessageReasonCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD 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()])
response	Σ	0..1	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.response Short description If this is a reply to prior message Definition Information about the message that this message is a response to. Only present if this message is a response. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA rim: ./conveyedAcknowledgement
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.response.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.response.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.response.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
identifier	Σ	1..1	id	There are no (further) constraints on this element Element id MessageHeader.response.identifier Short description Id of original message Definition The MessageHeader.id of the message to which this message is a response. Requirements Allows receiver to know what message is being responded to. Comments RFC 4122 Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA-2 rim: ./acknowledges.id[isNormalDatatype()]
code	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.response.code Short description ok \| transient-error \| fatal-error Definition Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. 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. Data type code Binding The kind of response to a message. ResponseType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA-1 rim: ./typeCode[isNormalDatatype()]
details	Σ I	0..1	Reference(OperationOutcome)	There are no (further) constraints on this element Element id MessageHeader.response.details Short description Specific list of hints/warnings/errors Definition Full details of any issues found in the message. 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. Data type Reference(OperationOutcome) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: ERR rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
focus	S Σ I	0..*	Reference(ServiceRequest \| Task \| Appointment \| Communication)	Element id MessageHeader.focus Short description The actual content of the message Definition The actual data of the message - a reference to the root/focus class of the event. 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. Data type Reference(ServiceRequest \| Task \| Appointment \| Communication) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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)
definition	Σ	0..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element id MessageHeader.definition Short description Link to the definition for this message Definition Permanent link to the MessageDefinition for this message. Requirements Allows sender to define the expected contents of the message. Comments see Canonical References Data type canonical(MessageDefinition) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: Not directly supported.

MessageHeader	I		MessageHeader	There are no (further) constraints on this element Element id MessageHeader Short description A resource that describes a message that is exchanged between systems Definition The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. Data type MessageHeader Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim: Entity. Role, or Act v2: MSH / MSA / ERR rim: Message
id	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	Element id MessageHeader.meta Short description Metadata about the resource Definition The 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. Comments The MustSupport flag on this element has been relaxed in this version until further confirmation of the use of meta.profile (outside of use for certain validation suites) and impact can be assessed by the working group. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id MessageHeader.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id MessageHeader.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A 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. 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id MessageHeader.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
referralIdentifier	I	0..1	Extension(Identifier)Binding	Element id MessageHeader.extension:referralIdentifier Short description Optional Extensions Element Alternate names extensions, user content Definition For requisitions this extension is used to convey the ServiceRequest.requisition identifier in the MessageHeader. 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. Data type Extension(Identifier) Extension URL https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Referral-Identifier-EXT Binding Codes supported by Ontario Health that can be used to determine which identifier to use for a specific purpose. eReferralIdentifierType (extensible) Constraints 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 rim: N/A
routingOptions	I	0..*	Extension(CodeableConcept)	Element id MessageHeader.extension:routingOptions Short description Optional Extensions Element Alternate names extensions, user content Definition For Referral Source Type identification. Only one referral routing object is expected. 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. Data type Extension(CodeableConcept) Extension URL https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Routing-Options-EXT Constraints 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 rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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). 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
event[x]	Σ	1..1		Element id MessageHeader.event[x] Short description Code for the event this message represents or link to event definition Definition Code 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. Requirements Drives the behavior associated with this message. Comments The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. Sliced: Unordered, Open, by $this(Type) Binding One of the message events defined as part of this version of FHIR. MessageEvent (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] v2: MSH-9.2 rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
eventUri			uri	There are no (further) constraints on this element Data type uri
eventCoding	S Σ	0..1	CodingBinding	Element id MessageHeader.event[x]:eventCoding Short description Code for the event this message represents or link to event definition Definition Code 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. Requirements Drives the behavior associated with this message. Comments The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. Data type Coding Binding One of the message events defined as part of this version of FHIR. MessageEventCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.what[x] v2: MSH-9.2 rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
system	Σ	0..1	uri	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ	0..1	codeBinding	Element id MessageHeader.event[x]:eventCoding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding MessageEventCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id MessageHeader.event[x]:eventCoding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
destination	S Σ	0..*	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.destination Short description Message destination application(s) Definition The destination application which the message is intended for. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.subject[x] rim: ./communicationFunction[typeCode="RCV"] w5: FiveWs.subject
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.destination.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.destination.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.destination.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
name	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.destination.name Short description Name of system Definition Human-readable name for the target system. Requirements May be used for routing of response and/or to support audit. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-5 rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])
target	Σ I	0..1	Reference(Device)	There are no (further) constraints on this element Element id MessageHeader.destination.target Short description Particular delivery destination within the destination Definition Identifies the target end system in situations where the initial message transmission is to an intermediary system. Requirements Supports multi-hop routing. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Device) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]
endpoint	Σ	1..1	url	There are no (further) constraints on this element Element id MessageHeader.destination.endpoint Short description Actual destination address or id Definition Indicates where the message should be routed to. Requirements Identifies where to route the message. Comments The id may be a non-resolvable URI for systems that do not use standard network-based addresses. Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-25 (or MSH-6) rim: ./telecom
receiver	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.destination.receiver Short description Intended "real-world" recipient for the data Definition Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Requirements Allows routing beyond just the application level. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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
sender	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.sender Short description Real world sender of the message Definition Identifies the sending system to allow the use of a trust relationship. 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. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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
enterer	Σ I	0..1	Reference(PractitionerRole \| Practitioner)	Element id MessageHeader.enterer Short description The source of the data entry Definition The 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. 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. Data type Reference(PractitionerRole \| Practitioner) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
author	S Σ I	1..1	Reference(PractitionerRole)	Element id MessageHeader.author Short description The source of the decision Definition The 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. 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. Data type Reference(PractitionerRole) Allowed aggregation: referenced Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
source	S Σ	1..1	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.source Short description Message source application Definition The source application from which this message originated. Requirements Allows replies, supports audit. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.actor rim: unique(./communicationFunction[typeCode="SND"])
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
name	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.name Short description Name of system Definition Human-readable name for the source system. Requirements May be used to support audit. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-3 rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])
software	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.software Short description Name of software running the system Definition May include configuration or other information useful in debugging. Requirements Supports audit and possibly interface engine behavior. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: SFT-3 ( +SFT-1) rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])
version	Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.version Short description Version of software running Definition Can convey versions of multiple systems in situations where a message passes through multiple hands. Requirements Supports audit and possibly interface engine behavior. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: SFT-2 rim: (Not supported)
contact	S Σ I	0..1	ContactPoint	There are no (further) constraints on this element Element id MessageHeader.source.contact Short description Human contact for problems Definition An e-mail, phone, website or other contact point to use to resolve issues with message communications. Requirements Allows escalation of technical issues. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: (MSH-22?) rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.contact.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.source.contact.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
system	S Σ I	0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.source.contact.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.3 rim: ./scheme servd: ./ContactPointType
value	S Σ	0..1	string	There are no (further) constraints on this element Element id MessageHeader.source.contact.value Short description The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.source.contact.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element id MessageHeader.source.contact.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id MessageHeader.source.contact.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
endpoint	S Σ	1..1	url	There are no (further) constraints on this element Element id MessageHeader.source.endpoint Short description Actual message source address or id Definition Identifies the routing target to send acknowledgements to. Requirements Identifies where to send responses, may influence security permissions. Comments The id may be a non-resolvable URI for systems that do not use standard network-based addresses. Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSH-24 rim: ./telecom[isNormalDatatype()]
responsible	Σ I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Element id MessageHeader.responsible Short description Final responsibility for event Definition The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. 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. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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"])
reason	S Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element id MessageHeader.reason Short description Cause of event Definition Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. 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 Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding Reason for event occurrence. ExampleMessageReasonCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD 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()])
response	Σ	0..1	BackboneElement	There are no (further) constraints on this element Element id MessageHeader.response Short description If this is a reply to prior message Definition Information about the message that this message is a response to. Only present if this message is a response. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA rim: ./conveyedAcknowledgement
id		0..1	string	There are no (further) constraints on this element Element id MessageHeader.response.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.response.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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 rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id MessageHeader.response.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). 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. Data type Extension Constraints 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 rim: N/A
identifier	Σ	1..1	id	There are no (further) constraints on this element Element id MessageHeader.response.identifier Short description Id of original message Definition The MessageHeader.id of the message to which this message is a response. Requirements Allows receiver to know what message is being responded to. Comments RFC 4122 Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA-2 rim: ./acknowledges.id[isNormalDatatype()]
code	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id MessageHeader.response.code Short description ok \| transient-error \| fatal-error Definition Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. 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. Data type code Binding The kind of response to a message. ResponseType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: MSA-1 rim: ./typeCode[isNormalDatatype()]
details	Σ I	0..1	Reference(OperationOutcome)	There are no (further) constraints on this element Element id MessageHeader.response.details Short description Specific list of hints/warnings/errors Definition Full details of any issues found in the message. 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. Data type Reference(OperationOutcome) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: ERR rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
focus	S Σ I	0..*	Reference(ServiceRequest \| Task \| Appointment \| Communication)	Element id MessageHeader.focus Short description The actual content of the message Definition The actual data of the message - a reference to the root/focus class of the event. 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. Data type Reference(ServiceRequest \| Task \| Appointment \| Communication) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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)
definition	Σ	0..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element id MessageHeader.definition Short description Link to the definition for this message Definition Permanent link to the MessageDefinition for this message. Requirements Allows sender to define the expected contents of the message. Comments see Canonical References Data type canonical(MessageDefinition) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: Not directly supported.

MessageHeader		..
MessageHeader.meta		..
MessageHeader.extension	Extension	..
MessageHeader.extension	Extension	..
MessageHeader.event[x]		..
MessageHeader.event[x]	Coding	..
MessageHeader.event[x].code		..
MessageHeader.destination		..
MessageHeader.destination.receiver	Reference(Practitioner \| PractitionerRole \| Organization)	..
MessageHeader.sender	Reference(Practitioner \| PractitionerRole \| Organization)	..
MessageHeader.enterer	Reference(PractitionerRole \| Practitioner)	..
MessageHeader.author	Reference(PractitionerRole)	1..
MessageHeader.source		..
MessageHeader.source.contact		..
MessageHeader.source.contact.system		..
MessageHeader.source.contact.value		..
MessageHeader.source.endpoint		..
MessageHeader.responsible	Reference(Practitioner \| PractitionerRole \| Organization)	..
MessageHeader.reason		..
MessageHeader.focus	Reference(ServiceRequest \| Task \| Appointment \| Communication)	..

{
    "resourceType": "StructureDefinition",
    "id": "CA-eReC-MessageHeader",
    "url": "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-MessageHeader",
    "version": "0.1.0",
    "name": "MessageHeader",
    "title": "MessageHeader",
    "status": "draft",
    "description": "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "MessageHeader",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "MessageHeader.meta",
                "path": "MessageHeader.meta",
                "comment": "The MustSupport flag on this element has been relaxed in this version until further confirmation of the use of meta.profile (outside of use for certain validation suites) and impact can be assessed by the working group."
            },
            {
                "id": "MessageHeader.extension:referralIdentifier",
                "path": "MessageHeader.extension",
                "sliceName": "referralIdentifier",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Referral-Identifier-EXT"
                        ]
                    }
                ],
                "isModifier": false,
                "binding": {
                    "strength": "extensible",
                    "description": "Codes supported by Ontario Health that can be used to determine which identifier to use for a specific purpose.",
                    "valueSet": "https://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/identifier-type"
                }
            },
            {
                "id": "MessageHeader.extension:routingOptions",
                "path": "MessageHeader.extension",
                "sliceName": "routingOptions",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Routing-Options-EXT"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "MessageHeader.event[x]",
                "path": "MessageHeader.event[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "MessageHeader.event[x]:eventCoding",
                "path": "MessageHeader.event[x]",
                "sliceName": "eventCoding",
                "type":  [
                    {
                        "code": "Coding"
                    }
                ],
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/message-event-code"
                }
            },
            {
                "id": "MessageHeader.event[x]:eventCoding.code",
                "path": "MessageHeader.event[x].code",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/message-event-code"
                }
            },
            {
                "id": "MessageHeader.destination",
                "path": "MessageHeader.destination",
                "mustSupport": true
            },
            {
                "id": "MessageHeader.destination.receiver",
                "path": "MessageHeader.destination.receiver",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Practitioner",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.sender",
                "path": "MessageHeader.sender",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Practitioner",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.enterer",
                "path": "MessageHeader.enterer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Practitioner"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.author",
                "path": "MessageHeader.author",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole"
                        ],
                        "aggregation":  [
                            "referenced"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "MessageHeader.source",
                "path": "MessageHeader.source",
                "mustSupport": true
            },
            {
                "id": "MessageHeader.source.contact",
                "path": "MessageHeader.source.contact",
                "mustSupport": true
            },
            {
                "id": "MessageHeader.source.contact.system",
                "path": "MessageHeader.source.contact.system",
                "mustSupport": true
            },
            {
                "id": "MessageHeader.source.contact.value",
                "path": "MessageHeader.source.contact.value",
                "mustSupport": true
            },
            {
                "id": "MessageHeader.source.endpoint",
                "path": "MessageHeader.source.endpoint",
                "mustSupport": true
            },
            {
                "id": "MessageHeader.responsible",
                "path": "MessageHeader.responsible",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Practitioner",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MessageHeader.reason",
                "path": "MessageHeader.reason",
                "mustSupport": true
            },
            {
                "id": "MessageHeader.focus",
                "path": "MessageHeader.focus",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Task",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Appointment",
                            "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Communication"
                        ]
                    }
                ],
                "mustSupport": true
            }
        ]
    }
}

Usage

The header for a message exchange that is either requesting or responding to an eReferral/eConsult.

The MessageHeader is used to convey the purpose of the message (i.e.: eventCoding), to direct the performe toward the information acted upon (i.e.: focus) and to support message routing.

Notes

.id

used to uniquely identify a message
populate this element with a UUID each time a message is created
note: a FHIR message contains two identifiers that are unique within the message stream, rules:
- a MessageHeader.id (this element) SHALL be assigned when the message is created
- a Bundle.id SHALL be assigned each time the message is sent

.eventCoding

used to convey the business event that triggered the message
SHALL be populated with a code from MessageEventCode and coding system

.destination

used to enable message routing through an intermediary
.endpoint SHALL be populated with either:
- a literal URL that identifies the addresses to which the message should be delivered, or
- a logical URI (i.e. non-dereferenceable) known to the intermediary.

.author

identifies the person who initiated the event
SHALL be populated with a reference to a PractitionerRole resource included as a message Bundle.entry

.source.endpoint

used to enable message routing of responses through an intermediary
SHALL be populated with either:
- a literal URL that identifies the addresses to which the message should be delivered, or
- a logical URI (i.e. non-dereferenceable) known to the intermediary

.reason

indicates the reason for the event that is the focus of this message, eg. RFI

.response

indicates that a message is a response to a request message (with status)
if used:
- .response.identifier SHALL be populated with the MessageHeader.id of the message to which this message is a response
- .response.code SHALL be populated with a valid ResponseType
- .response.details MAY be provided in a referenced OperationOutcome included in the Bundle

.focus

identifies the information acted upon when the message was triggered
SHALL include a reference to a ServiceRequest, Task, Appointment, Communication which are included as a message Bundle.entry
a MessageHeader MAY include multiple instances of focus to communicate some events