{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/special/committees/inm/index.cfm"}]}],"date":"2017-12-20T15:52:34+11: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","mapping":[{"identity":"v2","map":"MSH / MSA / ERR"},{"identity":"rim","map":"Message"},{"identity":"w5","map":"infrastructure.exchange"}],"max":"*","min":0,"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 FHIR.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"MessageEvent"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"example","valueSetReference":{"reference":"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 defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-events\".","id":"MessageHeader.event","isSummary":true,"mapping":[{"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"},{"identity":"w5","map":"what"}],"max":"1","min":1,"path":"MessageHeader.event","requirements":"Drives the behavior associated with this message.","short":"Code for the event this message represents","type":[{"code":"Coding"}]},{"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","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"rim","map":"./communicationFunction[typeCode=\"RCV\"]"},{"identity":"w5","map":"who.focus"}],"max":"*","min":0,"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"}]},{"definition":"Human-readable name for the target system.","id":"MessageHeader.destination.name","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,"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":"Identifies the target end system in situations where the initial message transmission is to an intermediary system.","id":"MessageHeader.destination.target","isSummary":true,"mapping":[{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]"}],"max":"1","min":0,"path":"MessageHeader.destination.target","requirements":"Supports multi-hop routing.","short":"Particular delivery destination within the destination","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Device"}]},{"comment":"The id may be a non-resolvable URI for systems that do not use standard network-based addresses.","definition":"Indicates where the message should be routed to.","id":"MessageHeader.destination.endpoint","isSummary":true,"mapping":[{"identity":"v2","map":"MSH-25 (or MSH-6)"},{"identity":"rim","map":"./telecom"}],"max":"1","min":1,"path":"MessageHeader.destination.endpoint","requirements":"Identifies where to route the message.","short":"Actual destination address or id","type":[{"code":"uri"}]},{"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","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"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"},{"identity":"w5","map":"who.focus"}],"max":"1","min":0,"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/Practitioner"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Organization"}]},{"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.","definition":"Identifies the sending system to allow the use of a trust relationship.","id":"MessageHeader.sender","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"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"},{"identity":"w5","map":"who.focus"}],"max":"1","min":0,"path":"MessageHeader.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/Practitioner"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Organization"}]},{"comment":"Usually only for the request, but can be used in a response.","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.","id":"MessageHeader.enterer","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.author"},{"identity":"v2","map":"EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10"},{"identity":"rim","map":"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\"])"},{"identity":"w5","map":"who.author"}],"max":"1","min":0,"path":"MessageHeader.enterer","requirements":"Need to know for audit/traceback requirements and possibly for authorization.","short":"The source of the data entry","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Practitioner"}]},{"comment":"Usually only for the request, but can be used in a response.","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.","id":"MessageHeader.author","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.author"},{"identity":"v2","map":"ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12"},{"identity":"rim","map":"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\"])"},{"identity":"w5","map":"who.author"}],"max":"1","min":0,"path":"MessageHeader.author","requirements":"Need to know for audit/traceback requirements and possibly for authorization.","short":"The source of the decision","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Practitioner"}]},{"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","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.actor"},{"identity":"rim","map":"unique(./communicationFunction[typeCode=\"SND\"])"},{"identity":"w5","map":"who.actor"}],"max":"1","min":1,"path":"MessageHeader.source","requirements":"Allows replies, supports audit.","short":"Message source application","type":[{"code":"BackboneElement"}]},{"definition":"Human-readable name for the source system.","id":"MessageHeader.source.name","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,"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","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,"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","isSummary":true,"mapping":[{"identity":"v2","map":"SFT-2"},{"identity":"rim","map":"(Not supported)"}],"max":"1","min":0,"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","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,"path":"MessageHeader.source.contact","requirements":"Allows escalation of technical issues.","short":"Human contact for problems","type":[{"code":"ContactPoint"}]},{"comment":"The id 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","isSummary":true,"mapping":[{"identity":"v2","map":"MSH-24"},{"identity":"rim","map":"./telecom[isNormalDatatype()]"}],"max":"1","min":1,"path":"MessageHeader.source.endpoint","requirements":"Identifies where to send responses, may influence security permissions.","short":"Actual message source address or id","type":[{"code":"uri"}]},{"comment":"Usually only for the request, but can be used in a response.","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.","id":"MessageHeader.responsible","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.witness"},{"identity":"v2","map":"ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11"},{"identity":"rim","map":"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\"])"},{"identity":"w5","map":"who.witness"}],"max":"1","min":0,"path":"MessageHeader.responsible","requirements":"Need to know for audit/traceback requirements and possibly for authorization.","short":"Final responsibility for event","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Practitioner"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Organization"}]},{"binding":{"description":"Reason for event occurrence","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"EventReason"}],"strength":"example","valueSetReference":{"reference":"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","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"v2","map":"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"},{"identity":"rim","map":"unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"},{"identity":"w5","map":"why"}],"max":"1","min":0,"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","isSummary":true,"mapping":[{"identity":"v2","map":"MSA"},{"identity":"rim","map":"./conveyedAcknowledgement"}],"max":"1","min":0,"path":"MessageHeader.response","short":"If this is a reply to prior message","type":[{"code":"BackboneElement"}]},{"definition":"The MessageHeader.id of the message to which this message is a response.","id":"MessageHeader.response.identifier","isSummary":true,"mapping":[{"identity":"v2","map":"MSA-2"},{"identity":"rim","map":"./acknowledges.id[isNormalDatatype()]"}],"max":"1","min":1,"path":"MessageHeader.response.identifier","requirements":"Allows receiver to know what message is being responded to.","short":"Id of original message","type":[{"code":"id"}]},{"binding":{"description":"The kind of response to a message","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ResponseType"}],"strength":"required","valueSetReference":{"reference":"http://hl7.org/fhir/ValueSet/response-code"}},"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","isSummary":true,"mapping":[{"identity":"v2","map":"MSA-1"},{"identity":"rim","map":"./typeCode[isNormalDatatype()]"}],"max":"1","min":1,"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","isSummary":true,"mapping":[{"identity":"v2","map":"ERR"},{"identity":"rim","map":"AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"}],"max":"1","min":0,"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.","id":"MessageHeader.focus","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,"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","isSummary":true,"mapping":[{"identity":"rim","map":"Not directly supported."}],"max":"1","min":0,"path":"MessageHeader.definition","requirements":"Allows sender to define the expected contents of the message.","short":"Link to the definition for this message","type":[{"code":"uri"}]}]},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":3},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"inm"}],"fhirVersion":"3.2.0","id":"MessageHeader","kind":"resource","mapping":[{"identity":"v2","name":"HL7 v2 Mapping","uri":"http://hl7.org/v2"},{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"},{"identity":"w5","name":"W5 Mapping","uri":"http://hl7.org/fhir/w5"}],"meta":{"lastUpdated":"2017-12-20T15:52:34.818+11:00"},"name":"MessageHeader","publisher":"Health Level Seven International (Infrastructure And Messaging)","purpose":"Many implementations are not prepared to use REST and need a messaging based infrastructure.","resourceType":"StructureDefinition","snapshot":{"element":[{"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":"DomainResource","xpath":"not(parent::f:contained and f:contained)"},{"expression":"contained.text.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain any narrative","key":"dom-1","severity":"error","source":"DomainResource","xpath":"not(parent::f:contained and f:text)"},{"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":"DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"},{"expression":"contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())","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":"DomainResource","xpath":"not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))"}],"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","mapping":[{"identity":"rim","map":"Entity. Role, or Act"},{"identity":"v2","map":"MSH / MSA / ERR"},{"identity":"rim","map":"Message"},{"identity":"w5","map":"infrastructure.exchange"}],"max":"*","min":0,"path":"MessageHeader","short":"A resource that describes a message that is exchanged between systems"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"MessageHeader.id","isSummary":true,"max":"1","min":0,"path":"MessageHeader.id","short":"Logical id of this artifact","type":[{"code":"id"}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"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","isSummary":true,"max":"1","min":0,"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.","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.","id":"MessageHeader.implicitRules","isModifier":true,"isSummary":true,"max":"1","min":0,"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":{"description":"A human language.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueReference":{"reference":"http://hl7.org/fhir/ValueSet/all-languages"}},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSetReference":{"reference":"http://hl7.org/fhir/ValueSet/languages"}},"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).","definition":"The base language in which the resource is written.","id":"MessageHeader.language","max":"1","min":0,"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 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 in formation is added later.","condition":["dom-1"],"definition":"A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.","id":"MessageHeader.text","mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"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.","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.","id":"MessageHeader.contained","mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"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.","definition":"May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"MessageHeader.extension","mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"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.","definition":"May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.","id":"MessageHeader.modifierExtension","isModifier":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"MessageHeader.modifierExtension","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"binding":{"description":"One of the message events defined as part 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","valueSetReference":{"reference":"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 defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-events\".","id":"MessageHeader.event","isSummary":true,"mapping":[{"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"},{"identity":"w5","map":"what"}],"max":"1","min":1,"path":"MessageHeader.event","requirements":"Drives the behavior associated with this message.","short":"Code for the event this message represents","type":[{"code":"Coding"}]},{"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() | (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"Element","xpath":"@value|f:*|h:div"}],"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","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"identity":"rim","map":"./communicationFunction[typeCode=\"RCV\"]"},{"identity":"w5","map":"who.focus"}],"max":"*","min":0,"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"},"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","mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"MessageHeader.destination.id","representation":["xmlAttr"],"short":"xml:id (or equivalent in JSON)","type":[{"code":"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.","definition":"May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"MessageHeader.destination.extension","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.","definition":"May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.","id":"MessageHeader.destination.modifierExtension","isModifier":true,"isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"MessageHeader.destination.modifierExtension","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"definition":"Human-readable name for the target system.","id":"MessageHeader.destination.name","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,"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":"Identifies the target end system in situations where the initial message transmission is to an intermediary system.","id":"MessageHeader.destination.target","isSummary":true,"mapping":[{"identity":"rim","map":"unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]"}],"max":"1","min":0,"path":"MessageHeader.destination.target","requirements":"Supports multi-hop routing.","short":"Particular delivery destination within the destination","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Device"}]},{"comment":"The id may be a non-resolvable URI for systems that do not use standard network-based addresses.","definition":"Indicates where the message should be routed to.","id":"MessageHeader.destination.endpoint","isSummary":true,"mapping":[{"identity":"v2","map":"MSH-25 (or MSH-6)"},{"identity":"rim","map":"./telecom"}],"max":"1","min":1,"path":"MessageHeader.destination.endpoint","requirements":"Identifies where to route the message.","short":"Actual destination address or id","type":[{"code":"uri"}]},{"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","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"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"},{"identity":"w5","map":"who.focus"}],"max":"1","min":0,"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/Practitioner"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Organization"}]},{"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.","definition":"Identifies the sending system to allow the use of a trust relationship.","id":"MessageHeader.sender","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.subject[x]"},{"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"},{"identity":"w5","map":"who.focus"}],"max":"1","min":0,"path":"MessageHeader.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/Practitioner"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Organization"}]},{"comment":"Usually only for the request, but can be used in a response.","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.","id":"MessageHeader.enterer","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.author"},{"identity":"v2","map":"EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10"},{"identity":"rim","map":"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\"])"},{"identity":"w5","map":"who.author"}],"max":"1","min":0,"path":"MessageHeader.enterer","requirements":"Need to know for audit/traceback requirements and possibly for authorization.","short":"The source of the data entry","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Practitioner"}]},{"comment":"Usually only for the request, but can be used in a response.","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.","id":"MessageHeader.author","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.author"},{"identity":"v2","map":"ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12"},{"identity":"rim","map":"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\"])"},{"identity":"w5","map":"who.author"}],"max":"1","min":0,"path":"MessageHeader.author","requirements":"Need to know for audit/traceback requirements and possibly for authorization.","short":"The source of the decision","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Practitioner"}]},{"constraint":[{"expression":"hasValue() | (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"Element","xpath":"@value|f:*|h:div"}],"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","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.actor"},{"identity":"rim","map":"unique(./communicationFunction[typeCode=\"SND\"])"},{"identity":"w5","map":"who.actor"}],"max":"1","min":1,"path":"MessageHeader.source","requirements":"Allows replies, supports audit.","short":"Message source application","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"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","mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"MessageHeader.source.id","representation":["xmlAttr"],"short":"xml:id (or equivalent in JSON)","type":[{"code":"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.","definition":"May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"MessageHeader.source.extension","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.","definition":"May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.","id":"MessageHeader.source.modifierExtension","isModifier":true,"isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"MessageHeader.source.modifierExtension","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"definition":"Human-readable name for the source system.","id":"MessageHeader.source.name","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,"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","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,"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","isSummary":true,"mapping":[{"identity":"v2","map":"SFT-2"},{"identity":"rim","map":"(Not supported)"}],"max":"1","min":0,"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","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,"path":"MessageHeader.source.contact","requirements":"Allows escalation of technical issues.","short":"Human contact for problems","type":[{"code":"ContactPoint"}]},{"comment":"The id 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","isSummary":true,"mapping":[{"identity":"v2","map":"MSH-24"},{"identity":"rim","map":"./telecom[isNormalDatatype()]"}],"max":"1","min":1,"path":"MessageHeader.source.endpoint","requirements":"Identifies where to send responses, may influence security permissions.","short":"Actual message source address or id","type":[{"code":"uri"}]},{"comment":"Usually only for the request, but can be used in a response.","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.","id":"MessageHeader.responsible","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.witness"},{"identity":"v2","map":"ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11"},{"identity":"rim","map":"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\"])"},{"identity":"w5","map":"who.witness"}],"max":"1","min":0,"path":"MessageHeader.responsible","requirements":"Need to know for audit/traceback requirements and possibly for authorization.","short":"Final responsibility for event","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Practitioner"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Organization"}]},{"binding":{"description":"Reason for event occurrence","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"EventReason"}],"strength":"example","valueSetReference":{"reference":"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","isSummary":true,"mapping":[{"identity":"w5","map":"FiveWs.why[x]"},{"identity":"v2","map":"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"},{"identity":"rim","map":"unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"},{"identity":"w5","map":"why"}],"max":"1","min":0,"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"}]},{"constraint":[{"expression":"hasValue() | (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"Element","xpath":"@value|f:*|h:div"}],"definition":"Information about the message that this message is a response to. Only present if this message is a response.","id":"MessageHeader.response","isSummary":true,"mapping":[{"identity":"v2","map":"MSA"},{"identity":"rim","map":"./conveyedAcknowledgement"}],"max":"1","min":0,"path":"MessageHeader.response","short":"If this is a reply to prior message","type":[{"code":"BackboneElement"}]},{"base":{"max":"1","min":0,"path":"Element.id"},"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","mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"MessageHeader.response.id","representation":["xmlAttr"],"short":"xml:id (or equivalent in JSON)","type":[{"code":"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.","definition":"May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","id":"MessageHeader.response.extension","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.","definition":"May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.","id":"MessageHeader.response.modifierExtension","isModifier":true,"isSummary":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"MessageHeader.response.modifierExtension","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"definition":"The MessageHeader.id of the message to which this message is a response.","id":"MessageHeader.response.identifier","isSummary":true,"mapping":[{"identity":"v2","map":"MSA-2"},{"identity":"rim","map":"./acknowledges.id[isNormalDatatype()]"}],"max":"1","min":1,"path":"MessageHeader.response.identifier","requirements":"Allows receiver to know what message is being responded to.","short":"Id of original message","type":[{"code":"id"}]},{"binding":{"description":"The kind of response to a message","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ResponseType"}],"strength":"required","valueSetReference":{"reference":"http://hl7.org/fhir/ValueSet/response-code"}},"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","isSummary":true,"mapping":[{"identity":"v2","map":"MSA-1"},{"identity":"rim","map":"./typeCode[isNormalDatatype()]"}],"max":"1","min":1,"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","isSummary":true,"mapping":[{"identity":"v2","map":"ERR"},{"identity":"rim","map":"AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"}],"max":"1","min":0,"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.","id":"MessageHeader.focus","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,"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","isSummary":true,"mapping":[{"identity":"rim","map":"Not directly supported."}],"max":"1","min":0,"path":"MessageHeader.definition","requirements":"Allows sender to define the expected contents of the message.","short":"Link to the definition for this message","type":[{"code":"uri"}]}]},"status":"draft","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
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" MessageHeader ΣTUDomainResourceA resource that describes a message that is exchanged between systems
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" event Σ1..1CodingCode for the event this message represents
MessageEvent (Example)
\".\"\".\"\".\" destination Σ0..*BackboneElementMessage destination application(s)
\".\"\".\"\".\"\".\" name Σ0..1stringName of system
\".\"\".\"\".\"\".\" target Σ0..1Reference(Device)Particular delivery destination within the destination
\".\"\".\"\".\"\".\" endpoint Σ1..1uriActual destination address or id
\".\"\".\"\".\"\".\" receiver Σ0..1Reference(Practitioner | Organization)Intended "real-world" recipient for the data
\".\"\".\"\".\" sender Σ0..1Reference(Practitioner | Organization)Real world sender of the message
\".\"\".\"\".\" enterer Σ0..1Reference(Practitioner)The source of the data entry
\".\"\".\"\".\" author Σ0..1Reference(Practitioner)The source of the decision
\".\"\".\"\".\" source Σ1..1BackboneElementMessage source application
\".\"\".\"\".\"\".\" 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
\".\"\".\"\".\"\".\" endpoint Σ1..1uriActual message source address or id
\".\"\".\"\".\" responsible Σ0..1Reference(Practitioner | Organization)Final responsibility for event
\".\"\".\"\".\" reason Σ0..1CodeableConceptCause of event
Example Message Reason Codes (Example)
\".\"\".\"\".\" response Σ0..1BackboneElementIf this is a reply to prior message
\".\"\".\"\".\"\".\" identifier Σ1..1idId of original message
\".\"\".\"\".\"\".\" code Σ1..1codeok | transient-error | fatal-error
ResponseType (Required)
\".\"\".\"\".\"\".\" details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
\".\"\".\"\".\" focus Σ0..*Reference(Any)The actual content of the message
\".\"\".\"\".\" definition Σ0..1uriLink to the definition for this message

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