2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
Profile for messageheader
<Profile xmlns="http://hl7.org/fhir"> <id value="MessageHeader"/> <meta> <lastUpdated value="2015-02-23T09:07:27.665+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/Profile/MessageHeader"/> <name value="MessageHeader"/> <publisher value="HL7 FHIR Project (FHIR Management Group)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/> </telecom> </contact> <description value="Base Profile for MessageHeader Resource"/> <status value="draft"/> <date value="2015-02-23T09:07:27+11:00"/> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <type value="MessageHeader"/> <snapshot> <element> <path value="MessageHeader"/> <short value="A resource that describes a message that is exchanged between systems"/> <definition value="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."/> <requirements value="Many implementations are not prepared to use REST and need a messaging based infrastructure."/> <min value="1"/> <max value="1"/> <mapping> <identity value="v2"/> <map value="MSH / MSA / ERR"/> </mapping> <mapping> <identity value="rim"/> <map value="Message"/> </mapping> </element> <element> <path value="MessageHeader.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="MessageHeader.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="MessageHeader.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="MessageHeader.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <isExtensible value="false"/> <conformance value="required"/> <description value="A human language"/> <referenceUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="MessageHeader.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="MessageHeader.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comments value="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."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="MessageHeader.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="MessageHeader.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="MessageHeader.identifier"/> <short value="Id of this message"/> <definition value="The identifier of this message."/> <comments value="This SHALL be unique within the scope of this stream of messages."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="v2"/> <map value="MSH-10-message control ID"/> </mapping> <mapping> <identity value="rim"/> <map value="Message.id"/> </mapping> </element> <element> <path value="MessageHeader.timestamp"/> <short value="Time that the message was sent"/> <definition value="The time that the message was sent."/> <requirements value="Allows limited detection of out-of-order and delayed transmission. Also supports audit."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <mapping> <identity value="v2"/> <map value="MSH-7-message date/time"/> </mapping> <mapping> <identity value="rim"/> <map value="./creationTime[isNormalDatatype()]"/> </mapping> </element> <element> <path value="MessageHeader.event"/> <short value="Code for the event this message represents"/> <definition value="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/mes sage-type"."/> <requirements value="Drives the behavior associated with this message."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="true"/> <binding> <name value="MessageEvent"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="One of the message events defined as part of FHIR"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/message-events"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="MSH-9.2-message type.trigger event"/> </mapping> <mapping> <identity value="rim"/> <map value="./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDa tatype()]/code"/> </mapping> </element> <element> <path value="MessageHeader.response"/> <short value="If this is a reply to prior message"/> <definition value="Information about the message that this message is a response to. Only present if this message is a response."/> <min value="0"/> <max value="1"/> <isModifier value="true"/> <mapping> <identity value="v2"/> <map value="MSA"/> </mapping> <mapping> <identity value="rim"/> <map value="./conveyedAcknowledgement"/> </mapping> </element> <element> <path value="MessageHeader.response.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="MessageHeader.response.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="MessageHeader.response.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="MessageHeader.response.identifier"/> <short value="Id of original message"/> <definition value="The id of the message that this message is a response to."/> <requirements value="Allows receiver to know what message is being responded to."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="v2"/> <map value="MSA-2-message control ID"/> </mapping> <mapping> <identity value="rim"/> <map value="./acknowledges.id[isNormalDatatype()]"/> </mapping> </element> <element> <path value="MessageHeader.response.code"/> <short value="ok | transient-error | fatal-error"/> <definition value="Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not."/> <comments value="This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data."/> <requirements value="Allows the sender of the acknowledge message to know if the request was successful or if action is needed."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ResponseType"/> <isExtensible value="false"/> <conformance value="required"/> <description value="The kind of response to a message"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/response-code"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="MSA-1-acknowledgment code"/> </mapping> <mapping> <identity value="rim"/> <map value="./typeCode[isNormalDatatype()]"/> </mapping> </element> <element> <path value="MessageHeader.response.details"/> <short value="Specific list of hints/warnings/errors"/> <definition value="Full details of any issues found in the message."/> <comments value="This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error."/> <requirements value="Allows the sender of the message to determine what the specific issues are."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/OperationOutcome"/> </type> <mapping> <identity value="v2"/> <map value="ERR"/> </mapping> <mapping> <identity value="rim"/> <map value="AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]"/> </mapping> </element> <element> <path value="MessageHeader.source"/> <short value="Message Source Application"/> <definition value="The source application from which this message originated."/> <requirements value="Allows replies, supports audit."/> <min value="1"/> <max value="1"/> <mapping> <identity value="rim"/> <map value="unique(./communicationFunction[typeCode="SND"])"/> </mapping> </element> <element> <path value="MessageHeader.source.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="MessageHeader.source.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="MessageHeader.source.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="MessageHeader.source.name"/> <short value="Name of system"/> <definition value="Human-readable name for the source system."/> <requirements value="May be used to support audit."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="MSH-3-sending application"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])"/> </mapping> </element> <element> <path value="MessageHeader.source.software"/> <short value="Name of software running the system"/> <definition value="May include configuration or other information useful in debugging."/> <requirements value="Supports audit and possibly interface engine behavior."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="SFT-3-software product name ( +SFT-1-software vendor organization)"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormal Datatype()])"/> </mapping> </element> <element> <path value="MessageHeader.source.version"/> <short value="Version of software running"/> <definition value="Can convey versions of multiple systems in situations where a message passes through multiple hands."/> <requirements value="Supports audit and possibly interface engine behavior."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="SFT-2-software certified version or release number"/> </mapping> <mapping> <identity value="rim"/> <map value="(Not supported)"/> </mapping> </element> <element> <path value="MessageHeader.source.contact"/> <short value="Human contact for problems"/> <definition value="An e-mail, phone, website or other contact point to use to resolve issues with message communications."/> <requirements value="Allows escalation of technical issues."/> <min value="0"/> <max value="1"/> <type> <code value="ContactPoint"/> </type> <mapping> <identity value="v2"/> <map value="(MSH-22?)"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole () and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])"/> </mapping> </element> <element> <path value="MessageHeader.source.endpoint"/> <short value="Actual message source address or id"/> <definition value="Identifies the routing target to send acknowledgements to."/> <comments value="The id may be a non-resolvable URI for systems that do not use standard network-based addresses."/> <requirements value="Identifies where to send responses, may influence security permissions."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <mapping> <identity value="v2"/> <map value="MSH-24-sending network address"/> </mapping> <mapping> <identity value="rim"/> <map value="./telecom[isNormalDatatype()]"/> </mapping> </element> <element> <path value="MessageHeader.destination"/> <short value="Message Destination Application(s)"/> <definition value="The destination application which the message is intended for."/> <comments value="there SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system."/> <requirements value="Indicates where message is to be sent to for routing purposes. Allows verification of "am I the intended recipient"."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value="./communicationFunction[typeCode="RCV"]"/> </mapping> </element> <element> <path value="MessageHeader.destination.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="MessageHeader.destination.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="MessageHeader.destination.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="MessageHeader.destination.name"/> <short value="Name of system"/> <definition value="Human-readable name for the target system."/> <requirements value="May be used for routing of response and/or to support audit."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="MSH-5-receiving application"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])"/> </mapping> </element> <element> <path value="MessageHeader.destination.target"/> <short value="Particular delivery destination within the destination"/> <definition value="Identifies the target end system in situations where the initial message transmission is to an intermediary system."/> <requirements value="Supports multi-hop routing."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Device"/> </type> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]"/> </mapping> </element> <element> <path value="MessageHeader.destination.endpoint"/> <short value="Actual destination address or id"/> <definition value="Indicates where the message should be routed to."/> <comments value="The id may be a non-resolvable URI for systems that do not use standard network-based addresses."/> <requirements value="Identifies where to route the message."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <mapping> <identity value="v2"/> <map value="MSH-25-receiving network address (or MSH-6-receiving facility by implication)"/> </mapping> <mapping> <identity value="rim"/> <map value="./telecom"/> </mapping> </element> <element> <path value="MessageHeader.enterer"/> <short value="The source of the data entry"/> <definition value="The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions."/> <comments value="Usually only for the request, but can be used in a response."/> <requirements value="Need to know for audit/traceback requirements and possibly for authorization."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Practitioner"/> </type> <mapping> <identity value="v2"/> <map value="EVN-5-operator ID / ORC-10-entered by / PRT-5-Participation Person:PRT-4-Participation='EP' / ROL where ROL.3 is EP or ORC.10"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])"/> </mapping> </element> <element> <path value="MessageHeader.author"/> <short value="The source of the decision"/> <definition value="The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions."/> <comments value="Usually only for the request, but can be used in a response."/> <requirements value="Need to know for audit/traceback requirements and possibly for authorization."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Practitioner"/> </type> <mapping> <identity value="v2"/> <map value="ORC-19-action by / PRT-5-Participation Person:PRT-4-Participation='AUT' / ROL where ROL.3 is IP or ORC.12"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classC ode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])"/> </mapping> </element> <element> <path value="MessageHeader.receiver"/> <short value="Intended "real-world" recipient for the data"/> <definition value="Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient."/> <requirements value="Allows routing beyond just the application level."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Organization"/> </type> <mapping> <identity value="v2"/> <map value="PRT-5-Participation Person:PRT-4-Participation='WAYR' / PRT-8-Participation Organization:PRT-4-Parti cipation='WAYR'"/> </mapping> <mapping> <identity value="rim"/> <map value="Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"/> </mapping> </element> <element> <path value="MessageHeader.responsible"/> <short value="Final responsibility for event"/> <definition value="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."/> <comments value="Usually only for the request, but can be used in a response."/> <requirements value="Need to know for audit/traceback requirements and possibly for authorization."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Organization"/> </type> <mapping> <identity value="v2"/> <map value="ORC-12-ordering provider / PRT-5-Participation Person:PRT-4-Participation='OP' / PRT-8-Participati on Organization:PRT-4-Participation='OP' / ROL where ROL.3 is RO or ORC.11"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[class Code="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[isNormalEn tity() and classCode="ORG" and determinerCode="INST"])"/> </mapping> </element> <element> <path value="MessageHeader.reason"/> <short value="Cause of event"/> <definition value="Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message."/> <requirements value="Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="EventReason"/> <isExtensible value="true"/> <conformance value="example"/> <description value="Reason for event occurrence"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/message-reason-encounter"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="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"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reas onCode[isNormalDatatype()])"/> </mapping> </element> <element> <path value="MessageHeader.data"/> <short value="The actual content of the message"/> <definition value="The actual data of the message - a reference to the root/focus class of the event."/> <comments value="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."/> <requirements value="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."/> <min value="0"/> <max value="*"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Any"/> </type> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="C ACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ&qu ot; and isNormalActRelatoinship]/target)"/> </mapping> </element> </snapshot> <differential> <element> <path value="MessageHeader"/> <short value="A resource that describes a message that is exchanged between systems"/> <definition value="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."/> <requirements value="Many implementations are not prepared to use REST and need a messaging based infrastructure."/> <min value="1"/> <max value="1"/> <mapping> <identity value="v2"/> <map value="MSH / MSA / ERR"/> </mapping> <mapping> <identity value="rim"/> <map value="Message"/> </mapping> </element> <element> <path value="MessageHeader.identifier"/> <short value="Id of this message"/> <definition value="The identifier of this message."/> <comments value="This SHALL be unique within the scope of this stream of messages."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="v2"/> <map value="MSH-10-message control ID"/> </mapping> <mapping> <identity value="rim"/> <map value="Message.id"/> </mapping> </element> <element> <path value="MessageHeader.timestamp"/> <short value="Time that the message was sent"/> <definition value="The time that the message was sent."/> <requirements value="Allows limited detection of out-of-order and delayed transmission. Also supports audit."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <mapping> <identity value="v2"/> <map value="MSH-7-message date/time"/> </mapping> <mapping> <identity value="rim"/> <map value="./creationTime[isNormalDatatype()]"/> </mapping> </element> <element> <path value="MessageHeader.event"/> <short value="Code for the event this message represents"/> <definition value="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/mes sage-type"."/> <requirements value="Drives the behavior associated with this message."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="true"/> <binding> <name value="MessageEvent"/> <isExtensible value="true"/> <conformance value="preferred"/> <description value="One of the message events defined as part of FHIR"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/message-events"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="MSH-9.2-message type.trigger event"/> </mapping> <mapping> <identity value="rim"/> <map value="./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDa tatype()]/code"/> </mapping> </element> <element> <path value="MessageHeader.response"/> <short value="If this is a reply to prior message"/> <definition value="Information about the message that this message is a response to. Only present if this message is a response."/> <min value="0"/> <max value="1"/> <isModifier value="true"/> <mapping> <identity value="v2"/> <map value="MSA"/> </mapping> <mapping> <identity value="rim"/> <map value="./conveyedAcknowledgement"/> </mapping> </element> <element> <path value="MessageHeader.response.identifier"/> <short value="Id of original message"/> <definition value="The id of the message that this message is a response to."/> <requirements value="Allows receiver to know what message is being responded to."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="v2"/> <map value="MSA-2-message control ID"/> </mapping> <mapping> <identity value="rim"/> <map value="./acknowledges.id[isNormalDatatype()]"/> </mapping> </element> <element> <path value="MessageHeader.response.code"/> <short value="ok | transient-error | fatal-error"/> <definition value="Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not."/> <comments value="This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data."/> <requirements value="Allows the sender of the acknowledge message to know if the request was successful or if action is needed."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ResponseType"/> <isExtensible value="false"/> <conformance value="required"/> <description value="The kind of response to a message"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/response-code"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="MSA-1-acknowledgment code"/> </mapping> <mapping> <identity value="rim"/> <map value="./typeCode[isNormalDatatype()]"/> </mapping> </element> <element> <path value="MessageHeader.response.details"/> <short value="Specific list of hints/warnings/errors"/> <definition value="Full details of any issues found in the message."/> <comments value="This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error."/> <requirements value="Allows the sender of the message to determine what the specific issues are."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/OperationOutcome"/> </type> <mapping> <identity value="v2"/> <map value="ERR"/> </mapping> <mapping> <identity value="rim"/> <map value="AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]"/> </mapping> </element> <element> <path value="MessageHeader.source"/> <short value="Message Source Application"/> <definition value="The source application from which this message originated."/> <requirements value="Allows replies, supports audit."/> <min value="1"/> <max value="1"/> <mapping> <identity value="rim"/> <map value="unique(./communicationFunction[typeCode="SND"])"/> </mapping> </element> <element> <path value="MessageHeader.source.name"/> <short value="Name of system"/> <definition value="Human-readable name for the source system."/> <requirements value="May be used to support audit."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="MSH-3-sending application"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])"/> </mapping> </element> <element> <path value="MessageHeader.source.software"/> <short value="Name of software running the system"/> <definition value="May include configuration or other information useful in debugging."/> <requirements value="Supports audit and possibly interface engine behavior."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="SFT-3-software product name ( +SFT-1-software vendor organization)"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormal Datatype()])"/> </mapping> </element> <element> <path value="MessageHeader.source.version"/> <short value="Version of software running"/> <definition value="Can convey versions of multiple systems in situations where a message passes through multiple hands."/> <requirements value="Supports audit and possibly interface engine behavior."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="SFT-2-software certified version or release number"/> </mapping> <mapping> <identity value="rim"/> <map value="(Not supported)"/> </mapping> </element> <element> <path value="MessageHeader.source.contact"/> <short value="Human contact for problems"/> <definition value="An e-mail, phone, website or other contact point to use to resolve issues with message communications."/> <requirements value="Allows escalation of technical issues."/> <min value="0"/> <max value="1"/> <type> <code value="ContactPoint"/> </type> <mapping> <identity value="v2"/> <map value="(MSH-22?)"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole () and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])"/> </mapping> </element> <element> <path value="MessageHeader.source.endpoint"/> <short value="Actual message source address or id"/> <definition value="Identifies the routing target to send acknowledgements to."/> <comments value="The id may be a non-resolvable URI for systems that do not use standard network-based addresses."/> <requirements value="Identifies where to send responses, may influence security permissions."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <mapping> <identity value="v2"/> <map value="MSH-24-sending network address"/> </mapping> <mapping> <identity value="rim"/> <map value="./telecom[isNormalDatatype()]"/> </mapping> </element> <element> <path value="MessageHeader.destination"/> <short value="Message Destination Application(s)"/> <definition value="The destination application which the message is intended for."/> <comments value="there SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system."/> <requirements value="Indicates where message is to be sent to for routing purposes. Allows verification of "am I the intended recipient"."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value="./communicationFunction[typeCode="RCV"]"/> </mapping> </element> <element> <path value="MessageHeader.destination.name"/> <short value="Name of system"/> <definition value="Human-readable name for the target system."/> <requirements value="May be used for routing of response and/or to support audit."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="MSH-5-receiving application"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])"/> </mapping> </element> <element> <path value="MessageHeader.destination.target"/> <short value="Particular delivery destination within the destination"/> <definition value="Identifies the target end system in situations where the initial message transmission is to an intermediary system."/> <requirements value="Supports multi-hop routing."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Device"/> </type> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]"/> </mapping> </element> <element> <path value="MessageHeader.destination.endpoint"/> <short value="Actual destination address or id"/> <definition value="Indicates where the message should be routed to."/> <comments value="The id may be a non-resolvable URI for systems that do not use standard network-based addresses."/> <requirements value="Identifies where to route the message."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <mapping> <identity value="v2"/> <map value="MSH-25-receiving network address (or MSH-6-receiving facility by implication)"/> </mapping> <mapping> <identity value="rim"/> <map value="./telecom"/> </mapping> </element> <element> <path value="MessageHeader.enterer"/> <short value="The source of the data entry"/> <definition value="The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions."/> <comments value="Usually only for the request, but can be used in a response."/> <requirements value="Need to know for audit/traceback requirements and possibly for authorization."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Practitioner"/> </type> <mapping> <identity value="v2"/> <map value="EVN-5-operator ID / ORC-10-entered by / PRT-5-Participation Person:PRT-4-Participation='EP' / ROL where ROL.3 is EP or ORC.10"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])"/> </mapping> </element> <element> <path value="MessageHeader.author"/> <short value="The source of the decision"/> <definition value="The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions."/> <comments value="Usually only for the request, but can be used in a response."/> <requirements value="Need to know for audit/traceback requirements and possibly for authorization."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Practitioner"/> </type> <mapping> <identity value="v2"/> <map value="ORC-19-action by / PRT-5-Participation Person:PRT-4-Participation='AUT' / ROL where ROL.3 is IP or ORC.12"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classC ode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])"/> </mapping> </element> <element> <path value="MessageHeader.receiver"/> <short value="Intended "real-world" recipient for the data"/> <definition value="Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient."/> <requirements value="Allows routing beyond just the application level."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Organization"/> </type> <mapping> <identity value="v2"/> <map value="PRT-5-Participation Person:PRT-4-Participation='WAYR' / PRT-8-Participation Organization:PRT-4-Parti cipation='WAYR'"/> </mapping> <mapping> <identity value="rim"/> <map value="Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"/> </mapping> </element> <element> <path value="MessageHeader.responsible"/> <short value="Final responsibility for event"/> <definition value="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."/> <comments value="Usually only for the request, but can be used in a response."/> <requirements value="Need to know for audit/traceback requirements and possibly for authorization."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Organization"/> </type> <mapping> <identity value="v2"/> <map value="ORC-12-ordering provider / PRT-5-Participation Person:PRT-4-Participation='OP' / PRT-8-Participati on Organization:PRT-4-Participation='OP' / ROL where ROL.3 is RO or ORC.11"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[class Code="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[isNormalEn tity() and classCode="ORG" and determinerCode="INST"])"/> </mapping> </element> <element> <path value="MessageHeader.reason"/> <short value="Cause of event"/> <definition value="Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message."/> <requirements value="Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="EventReason"/> <isExtensible value="true"/> <conformance value="example"/> <description value="Reason for event occurrence"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/message-reason-encounter"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="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"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reas onCode[isNormalDatatype()])"/> </mapping> </element> <element> <path value="MessageHeader.data"/> <short value="The actual content of the message"/> <definition value="The actual data of the message - a reference to the root/focus class of the event."/> <comments value="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."/> <requirements value="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."/> <min value="0"/> <max value="*"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Any"/> </type> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/part icipation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="C ACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ&qu ot; and isNormalActRelatoinship]/target)"/> </mapping> </element> </differential> </Profile>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:21+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change