{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","contact":[{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/inm"}]}],"date":"2026-03-31T18:55:04+00:00","derivation":"specialization","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.","differential":{"element":[{"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.","id":"MessageHeader","isModifier":false,"mapping":[{"identity":"workflow","map":"Event"},{"identity":"w5","map":"infrastructure.exchange"},{"identity":"v2","map":"MSH / MSA / ERR"},{"identity":"rim","map":"Message"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader","short":"A resource that describes a message that is exchanged between systems"},{"binding":{"description":"One of the message events defined as part of this version of FHIR.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MessageEvent"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/message-events"},"comment":"The time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp).","definition":"Code that identifies the event this message represents and connects it with its definition. Events are defined by codes, or by URIs that identify events, or by reference to EventDefinition or SubscriptionTopic resources that define the event directly. This element is intentionally unbound, and the selection of appropriate event codes is delegated to implementations and implementation guides. For codes, a good set of example codes is found in [the V2 event codes](https://terminology.hl7.org/ValueSet-v2-0003.html).","id":"MessageHeader.event[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"v2","map":"MSH-9.2"},{"identity":"rim","map":"./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code"}],"max":"1","min":1,"mustSupport":false,"path":"MessageHeader.event[x]","requirements":"Drives the behavior associated with this message.","short":"The real world event that triggered this messsage","type":[{"code":"Coding"},{"code":"uri"},{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/EventDefinition","http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"]}]},{"comment":"There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.","definition":"The destination application which the message is intended for.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name","valueString":"MessageDestination"}],"id":"MessageHeader.destination","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject"},{"identity":"rim","map":"./communicationFunction[typeCode=\"RCV\"]"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader.destination","requirements":"Indicates where message is to be sent for routing purposes. Allows verification of \"am I the intended recipient\".","short":"Message destination application(s)","type":[{"code":"BackboneElement"}]},{"comment":"The url may be a non-resolvable URI for systems that do not use standard network-based addresses.","definition":"Indicates where the message should be routed.","id":"MessageHeader.destination.endpoint[x]","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.destination.endpoint[x]","requirements":"Identifies where to route the message.","short":"Actual destination address or Endpoint resource","type":[{"code":"url"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Endpoint"]}]},{"definition":"Human-readable name for the target system.","id":"MessageHeader.destination.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSH-5"},{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.destination.name","requirements":"May be used for routing of response and/or to support audit.","short":"Name of system","type":[{"code":"string"}]},{"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.","id":"MessageHeader.destination.receiver","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject"},{"identity":"v2","map":"PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'"},{"identity":"rim","map":"Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.destination.receiver","requirements":"Allows routing beyond just the application level.","short":"Intended \"real-world\" recipient for the data","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}]},{"definition":"The source application from which this message originated.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name","valueString":"MessageSource"}],"id":"MessageHeader.source","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.actor"},{"identity":"rim","map":"unique(./communicationFunction[typeCode=\"SND\"])"}],"max":"1","min":1,"mustSupport":false,"path":"MessageHeader.source","requirements":"Allows replies, supports audit.","short":"Message source application","type":[{"code":"BackboneElement"}]},{"comment":"The url may be a non-resolvable URI for systems that do not use standard network-based addresses.","definition":"Identifies the routing target to send acknowledgements to.","id":"MessageHeader.source.endpoint[x]","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.endpoint[x]","requirements":"Identifies where to send responses, may influence security permissions.","short":"Actual source address or Endpoint resource","type":[{"code":"url"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Endpoint"]}]},{"definition":"Human-readable name for the source system.","id":"MessageHeader.source.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSH-3"},{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.name","requirements":"May be used to support audit.","short":"Name of system","type":[{"code":"string"}]},{"definition":"May include configuration or other information useful in debugging.","id":"MessageHeader.source.software","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"SFT-3 ( +SFT-1)"},{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.software","requirements":"Supports audit and possibly interface engine behavior.","short":"Name of software running the system","type":[{"code":"string"}]},{"definition":"Can convey versions of multiple systems in situations where a message passes through multiple hands.","id":"MessageHeader.source.version","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"SFT-2"},{"identity":"rim","map":"(Not supported)"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.version","requirements":"Supports audit and possibly interface engine behavior.","short":"Version of software running","type":[{"code":"string"}]},{"definition":"An e-mail, phone, website or other contact point to use to resolve issues with message communications.","id":"MessageHeader.source.contact","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"(MSH-22?)"},{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.contact","requirements":"Allows escalation of technical issues.","short":"Human contact for problems","type":[{"code":"ContactPoint"}]},{"comment":"Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Proposing to remove and rely on Task to convey this information.","definition":"Identifies the sending entity to allow the use of a trust relationship.","id":"MessageHeader.source.sender","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.sender","requirements":"Allows routing beyond just the application level.","short":"Real world sender of the message","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}]},{"binding":{"description":"Reason for event occurrence.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"EventReason"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/message-reason-encounter"},"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.","id":"MessageHeader.reason","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.reason"},{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"v2","map":"EVN-4 / ORC-16 / OBR-31 / BPO-13 / RXO-20 / RXE-27 / RXD-21 / RXG-22 / RXA-19"},{"identity":"rim","map":"unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.reason","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.","short":"Cause of event","type":[{"code":"CodeableConcept"}]},{"definition":"Information about the message that this message is a response to. Only present if this message is a response.","id":"MessageHeader.response","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSA"},{"identity":"rim","map":"./conveyedAcknowledgement"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.response","short":"If this is a reply to prior message","type":[{"code":"BackboneElement"}]},{"definition":"The Bundle.identifier of the message to which this message is a response.","id":"MessageHeader.response.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSA-2"},{"identity":"rim","map":"./acknowledges.id[isNormalDatatype()]"}],"max":"1","min":1,"mustSupport":false,"path":"MessageHeader.response.identifier","requirements":"Allows receiver to know what message is being responded to.","short":"Bundle.identifier of original message","type":[{"code":"Identifier"}]},{"binding":{"description":"The kind of response to a message.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ResponseType"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/response-code|6.0.0-ballot4"},"comment":"This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.","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.","id":"MessageHeader.response.code","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSA-1"},{"identity":"rim","map":"./typeCode[isNormalDatatype()]"}],"max":"1","min":1,"mustSupport":false,"path":"MessageHeader.response.code","requirements":"Allows the sender of the acknowledge message to know if the request was successful or if action is needed.","short":"ok | transient-error | fatal-error","type":[{"code":"code"}]},{"comment":"This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.","definition":"Full details of any issues found in the message.","id":"MessageHeader.response.details","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"ERR"},{"identity":"rim","map":"AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.response.details","requirements":"Allows the sender of the message to determine what the specific issues are.","short":"Specific list of hints/warnings/errors","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/OperationOutcome"]}]},{"comment":"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.","definition":"The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource.","id":"MessageHeader.focus","isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"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)"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader.focus","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.","short":"The actual content of the message","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}]},{"definition":"Permanent link to the MessageDefinition for this message.","id":"MessageHeader.definition","isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"Not directly supported."}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.definition","requirements":"Allows sender to define the expected contents of the message.","short":"Link to the definition for this message","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]}]}]},"experimental":false,"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"inm"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":4},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"not-classified"}],"fhirVersion":"6.0.0-ballot4","id":"MessageHeader","jurisdiction":[{"coding":[{"code":"001","display":"World","system":"http://unstats.un.org/unsd/methods/m49/m49.htm"}]}],"kind":"resource","mapping":[{"identity":"workflow","name":"Workflow Pattern","uri":"http://hl7.org/fhir/workflow"},{"identity":"w5","name":"FiveWs Pattern Mapping","uri":"http://hl7.org/fhir/fivews"},{"identity":"v2","name":"HL7 V2 Mapping","uri":"http://hl7.org/v2"},{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"}],"meta":{"lastUpdated":"2026-03-31T18:55:04.283+00:00"},"name":"MessageHeader","publisher":"HL7 International / Infrastructure And Messaging","purpose":"Many implementations are not prepared to use REST and need a messaging based infrastructure.","resourceType":"StructureDefinition","snapshot":{"element":[{"base":{"max":"*","min":0,"path":"MessageHeader"},"constraint":[{"expression":"contained.contained.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain nested Resources","key":"dom-2","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"expression":"contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()","human":"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","key":"dom-3","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"expression":"contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated","key":"dom-4","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"expression":"contained.meta.security.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a security label","key":"dom-5","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"},{"expression":"text.`div`.exists()","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice","valueBoolean":true},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation","valueMarkdown":"When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}],"human":"A resource should have narrative for robust management","key":"dom-6","severity":"warning","source":"http://hl7.org/fhir/StructureDefinition/DomainResource"}],"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.","id":"MessageHeader","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Entity, Role, or Act,Message"},{"identity":"workflow","map":"Event"},{"identity":"w5","map":"infrastructure.exchange"},{"identity":"v2","map":"MSH / MSA / ERR"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader","short":"A resource that describes a message that is exchanged between systems"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"MessageHeader.id","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.id","short":"Logical id of this artifact","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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.","id":"MessageHeader.meta","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"comment":"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 its narrative along with other profiles, value sets, etc.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.","id":"MessageHeader.implicitRules","isModifier":true,"isModifierReason":"This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation","isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"additional":[{"purpose":"starter","valueSet":"http://hl7.org/fhir/ValueSet/languages"}],"description":"IETF language tag for a human language","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot4"},"comment":"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The base language in which the resource is written.","id":"MessageHeader.language","isModifier":false,"isSummary":false,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.language","short":"Language of the resource content","type":[{"code":"code"}]},{"alias":["narrative","html","xhtml","display"],"base":{"max":"1","min":0,"path":"DomainResource.text"},"comment":"Contained resources do not have a 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.","condition":["dom-6"],"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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.","id":"MessageHeader.text","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.text","short":"Text summary of the resource, for human interpretation","type":[{"code":"Narrative"}]},{"alias":["inline resources","anonymous resources","contained resources"],"base":{"max":"*","min":0,"path":"DomainResource.contained"},"comment":"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. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](resource.html#additional).","condition":["dom-2","dom-4","dom-3","dom-5"],"definition":"These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","id":"MessageHeader.contained","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader.contained","short":"Contained, inline Resources","type":[{"code":"Resource"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.extension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 managable, 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.","id":"MessageHeader.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.modifierExtension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"MessageHeader.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader.modifierExtension","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](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"base":{"max":"1","min":1,"path":"MessageHeader.event[x]"},"binding":{"description":"One of the message events defined as part of this version of FHIR.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MessageEvent"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/message-events"},"comment":"The time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Code that identifies the event this message represents and connects it with its definition. Events are defined by codes, or by URIs that identify events, or by reference to EventDefinition or SubscriptionTopic resources that define the event directly. This element is intentionally unbound, and the selection of appropriate event codes is delegated to implementations and implementation guides. For codes, a good set of example codes is found in [the V2 event codes](https://terminology.hl7.org/ValueSet-v2-0003.html).","id":"MessageHeader.event[x]","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.code"},{"identity":"w5","map":"FiveWs.what[x]"},{"identity":"v2","map":"MSH-9.2"},{"identity":"rim","map":"./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code"}],"max":"1","min":1,"mustSupport":false,"path":"MessageHeader.event[x]","requirements":"Drives the behavior associated with this message.","short":"The real world event that triggered this messsage","type":[{"code":"Coding"},{"code":"uri"},{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/EventDefinition","http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"]}]},{"base":{"max":"*","min":0,"path":"MessageHeader.destination"},"comment":"There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children or both","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The destination application which the message is intended for.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name","valueString":"MessageDestination"}],"id":"MessageHeader.destination","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject"},{"identity":"rim","map":"./communicationFunction[typeCode=\"RCV\"]"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader.destination","requirements":"Indicates where message is to be sent for routing purposes. Allows verification of \"am I the intended recipient\".","short":"Message destination application(s)","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"MessageHeader.destination.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"MessageHeader.destination.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 managable, 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.","id":"MessageHeader.destination.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"MessageHeader.destination.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"MessageHeader.destination.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"MessageHeader.destination.modifierExtension","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](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.destination.endpoint[x]"},"comment":"The url may be a non-resolvable URI for systems that do not use standard network-based addresses.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Indicates where the message should be routed.","id":"MessageHeader.destination.endpoint[x]","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.destination.endpoint[x]","requirements":"Identifies where to route the message.","short":"Actual destination address or Endpoint resource","type":[{"code":"url"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Endpoint"]}]},{"base":{"max":"1","min":0,"path":"MessageHeader.destination.name"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Human-readable name for the target system.","id":"MessageHeader.destination.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSH-5"},{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.destination.name","requirements":"May be used for routing of response and/or to support audit.","short":"Name of system","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.destination.receiver"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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.","id":"MessageHeader.destination.receiver","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject"},{"identity":"v2","map":"PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'"},{"identity":"rim","map":"Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.destination.receiver","requirements":"Allows routing beyond just the application level.","short":"Intended \"real-world\" recipient for the data","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole","http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}]},{"base":{"max":"1","min":1,"path":"MessageHeader.source"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children or both","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The source application from which this message originated.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name","valueString":"MessageSource"}],"id":"MessageHeader.source","isModifier":false,"isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.actor"},{"identity":"rim","map":"unique(./communicationFunction[typeCode=\"SND\"])"}],"max":"1","min":1,"mustSupport":false,"path":"MessageHeader.source","requirements":"Allows replies, supports audit.","short":"Message source application","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"MessageHeader.source.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"MessageHeader.source.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 managable, 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.","id":"MessageHeader.source.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"MessageHeader.source.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"MessageHeader.source.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"MessageHeader.source.modifierExtension","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](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.source.endpoint[x]"},"comment":"The url may be a non-resolvable URI for systems that do not use standard network-based addresses.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Identifies the routing target to send acknowledgements to.","id":"MessageHeader.source.endpoint[x]","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.endpoint[x]","requirements":"Identifies where to send responses, may influence security permissions.","short":"Actual source address or Endpoint resource","type":[{"code":"url"},{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Endpoint"]}]},{"base":{"max":"1","min":0,"path":"MessageHeader.source.name"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Human-readable name for the source system.","id":"MessageHeader.source.name","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSH-3"},{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.name","requirements":"May be used to support audit.","short":"Name of system","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.source.software"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"May include configuration or other information useful in debugging.","id":"MessageHeader.source.software","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"SFT-3 ( +SFT-1)"},{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.software","requirements":"Supports audit and possibly interface engine behavior.","short":"Name of software running the system","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.source.version"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Can convey versions of multiple systems in situations where a message passes through multiple hands.","id":"MessageHeader.source.version","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"SFT-2"},{"identity":"rim","map":"(Not supported)"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.version","requirements":"Supports audit and possibly interface engine behavior.","short":"Version of software running","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.source.contact"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"An e-mail, phone, website or other contact point to use to resolve issues with message communications.","id":"MessageHeader.source.contact","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"(MSH-22?)"},{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.contact","requirements":"Allows escalation of technical issues.","short":"Human contact for problems","type":[{"code":"ContactPoint"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.source.sender"},"comment":"Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Proposing to remove and rely on Task to convey this information.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Identifies the sending entity to allow the use of a trust relationship.","id":"MessageHeader.source.sender","isModifier":false,"isSummary":true,"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.source.sender","requirements":"Allows routing beyond just the application level.","short":"Real world sender of the message","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Device","http://hl7.org/fhir/StructureDefinition/Organization","http://hl7.org/fhir/StructureDefinition/Patient","http://hl7.org/fhir/StructureDefinition/Practitioner","http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}]},{"base":{"max":"1","min":0,"path":"MessageHeader.reason"},"binding":{"description":"Reason for event occurrence.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"EventReason"}],"strength":"example","valueSet":"http://hl7.org/fhir/ValueSet/message-reason-encounter"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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.","id":"MessageHeader.reason","isModifier":false,"isSummary":true,"mapping":[{"identity":"workflow","map":"Event.reason"},{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"v2","map":"EVN-4 / ORC-16 / OBR-31 / BPO-13 / RXO-20 / RXE-27 / RXD-21 / RXG-22 / RXA-19"},{"identity":"rim","map":"unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.reason","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.","short":"Cause of event","type":[{"code":"CodeableConcept"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.response"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children or both","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Information about the message that this message is a response to. Only present if this message is a response.","id":"MessageHeader.response","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSA"},{"identity":"rim","map":"./conveyedAcknowledgement"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.response","short":"If this is a reply to prior message","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"MessageHeader.response.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"MessageHeader.response.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 managable, 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.","id":"MessageHeader.response.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"MessageHeader.response.extension","short":"Additional content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content","modifiers"],"base":{"max":"*","min":0,"path":"BackboneElement.modifierExtension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","id":"MessageHeader.response.modifierExtension","isModifier":true,"isModifierReason":"Modifier extensions are expected to modify the meaning or interpretation of the element that contains them","isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"MessageHeader.response.modifierExtension","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](extensibility.html#modifierExtension).","short":"Extensions that cannot be ignored even if unrecognized","type":[{"code":"Extension"}]},{"base":{"max":"1","min":1,"path":"MessageHeader.response.identifier"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The Bundle.identifier of the message to which this message is a response.","id":"MessageHeader.response.identifier","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSA-2"},{"identity":"rim","map":"./acknowledges.id[isNormalDatatype()]"}],"max":"1","min":1,"mustSupport":false,"path":"MessageHeader.response.identifier","requirements":"Allows receiver to know what message is being responded to.","short":"Bundle.identifier of original message","type":[{"code":"Identifier"}]},{"base":{"max":"1","min":1,"path":"MessageHeader.response.code"},"binding":{"description":"The kind of response to a message.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ResponseType"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/response-code|6.0.0-ballot4"},"comment":"This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"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.","id":"MessageHeader.response.code","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"MSA-1"},{"identity":"rim","map":"./typeCode[isNormalDatatype()]"}],"max":"1","min":1,"mustSupport":false,"path":"MessageHeader.response.code","requirements":"Allows the sender of the acknowledge message to know if the request was successful or if action is needed.","short":"ok | transient-error | fatal-error","type":[{"code":"code"}]},{"base":{"max":"1","min":0,"path":"MessageHeader.response.details"},"comment":"This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Full details of any issues found in the message.","id":"MessageHeader.response.details","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"ERR"},{"identity":"rim","map":"AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.response.details","requirements":"Allows the sender of the message to determine what the specific issues are.","short":"Specific list of hints/warnings/errors","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/OperationOutcome"]}]},{"base":{"max":"*","min":0,"path":"MessageHeader.focus"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource.","id":"MessageHeader.focus","isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"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)"}],"max":"*","min":0,"mustSupport":false,"path":"MessageHeader.focus","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.","short":"The actual content of the message","type":[{"code":"Reference","targetProfile":["http://hl7.org/fhir/StructureDefinition/Resource"]}]},{"base":{"max":"1","min":0,"path":"MessageHeader.definition"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Permanent link to the MessageDefinition for this message.","id":"MessageHeader.definition","isModifier":false,"isSummary":true,"mapping":[{"identity":"rim","map":"Not directly supported."}],"max":"1","min":0,"mustSupport":false,"path":"MessageHeader.definition","requirements":"Allows sender to define the expected contents of the message.","short":"Link to the definition for this message","type":[{"code":"canonical","targetProfile":["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]}]}]},"status":"active","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" MessageHeader NDomainResourceA resource that describes a message that is exchanged between systems

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" event[x] Σ1..1The real world event that triggered this messsage
Binding: MessageEvent (Example)
\".\"\".\"\".\"\".\" eventCodingCoding
\".\"\".\"\".\"\".\" eventUriuri
\".\"\".\"\".\"\".\" eventCanonicalcanonical(EventDefinition | SubscriptionTopic)
\".\"\".\"\".\" destination Σ0..*BackboneElementMessage destination application(s)

\".\"\".\"\".\"\".\" endpoint[x] Σ0..1Actual destination address or Endpoint resource
\".\"\".\"\".\"\".\"\".\" endpointUrlurl
\".\"\".\"\".\"\".\"\".\" endpointReferenceReference(Endpoint)
\".\"\".\"\".\"\".\" name Σ0..1stringName of system
\".\"\".\"\".\"\".\" receiver Σ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Intended "real-world" recipient for the data
\".\"\".\"\".\" source Σ1..1BackboneElementMessage source application
\".\"\".\"\".\"\".\" endpoint[x] Σ0..1Actual source address or Endpoint resource
\".\"\".\"\".\"\".\"\".\" endpointUrlurl
\".\"\".\"\".\"\".\"\".\" endpointReferenceReference(Endpoint)
\".\"\".\"\".\"\".\" name Σ0..1stringName of system
\".\"\".\"\".\"\".\" software Σ0..1stringName of software running the system
\".\"\".\"\".\"\".\" version Σ0..1stringVersion of software running
\".\"\".\"\".\"\".\" contact Σ0..1ContactPointHuman contact for problems
\".\"\".\"\".\"\".\" sender Σ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole)Real world sender of the message
\".\"\".\"\".\" reason Σ0..1CodeableConceptCause of event
Binding: Example Message Reason Codes (Example)
\".\"\".\"\".\" response Σ0..1BackboneElementIf this is a reply to prior message
\".\"\".\"\".\"\".\" identifier Σ1..1IdentifierBundle.identifier of original message
\".\"\".\"\".\"\".\" code Σ1..1codeok | transient-error | fatal-error
Binding: Response Type (Required)
\".\"\".\"\".\"\".\" details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
\".\"\".\"\".\" focus Σ0..*Reference(Any)The actual content of the message

\".\"\".\"\".\" definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

\"doco\" Documentation for this format
","status":"generated"},"type":"MessageHeader","url":"http://hl7.org/fhir/StructureDefinition/MessageHeader","version":"6.0.0-ballot4"}