. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="messageheader-definitions.html#MessageHeader" title="The header for a message exchange that is either requesting or responding to an action. The resource(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."><b>MessageHeader</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --> <<a class="dict" href="messageheader-definitions.html#MessageHeader.identifier" title="The identifier of this message."><b>identifier</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#id">id</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Id of this message</span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.timestamp" title="The time that the message was sent."><b>timestamp</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#instant">instant</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Time that the message was sent</span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.event" title="Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/mes sage-type" (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>event</b></span></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Coding">Coding</a></span> <span style="color: navy"><a href="message-events.html" style="color: navy">Code for the event this message represents</a></span><span style="color: Gray"> --></span></event> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response" title="Information about the message that this message is a response to. Only present if this message is a response (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>response</b></span></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> If this is a reply to prior message --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.identifier" title="The id of the message that this message is a response to."><b>identifier</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#id">id</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Id of original message</span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.code" title="Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>code</b></span></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="response-code.html" style="color: navy">ok | transient-error | fatal-error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.response.details" title="Full details of any issues found in the message."><b>details</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="operationoutcome.html#OperationOutcome">OperationOutcome</a>)</span> <span style="color: navy">Specific list of hints/warnings/errors</span><span style="color: Gray"> --></span></details> </response> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source" title="The source application from which this message originated."><b>source</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>1..1</b></span> Message Source Application --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.name" title="Human-readable name for the target system."><b>name</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Name of system</span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.software" title="May include configuration or other information useful in debugging."><b>software</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Name of software running the system</span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.version" title="Can convey versions of multiple systems in situations where a message passes through multiple hands."><b>version</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Version of software running</span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.contact" title="An e-mail, phone, website or other contact point to use to resolve issues with message communications."><b>contact</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Contact">Contact</a></span> <span style="color: navy">Human contact for problems</span><span style="color: Gray"> --></span></contact> <<a class="dict" href="messageheader-definitions.html#MessageHeader.source.endpoint" title="Identifies the routing target to send acknowledgements to."><b>endpoint</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Actual message source address or id</span><span style="color: Gray"> --></span> </source> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination" title="The destination application which the message is intended for."><b>destination</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Message Destination Application(s) --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.name" title="Human-readable name for the source system."><b>name</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Name of system</span><span style="color: Gray"> --></span> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.target" title="Identifies the target end system in situations where the initial message transmission is to an intermediary system."><b>target</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="device.html#Device">Device</a>)</span> <span style="color: navy">Particular delivery destination within the destination</span><span style="color: Gray"> --></span></target> <<a class="dict" href="messageheader-definitions.html#MessageHeader.destination.endpoint" title="Indicates where the message should be routed to."><b>endpoint</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Actual destination address or id</span><span style="color: Gray"> --></span> </destination> <<a class="dict" href="messageheader-definitions.html#MessageHeader.enterer" title="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."><b>enterer</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="practitioner.html#Practitioner">Practitioner</a>)</span> <span style="color: navy">The source of the data entry</span><span style="color: Gray"> --></span></enterer> <<a class="dict" href="messageheader-definitions.html#MessageHeader.author" title="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."><b>author</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="practitioner.html#Practitioner">Practitioner</a>)</span> <span style="color: navy">The source of the decision</span><span style="color: Gray"> --></span></author> <<a class="dict" href="messageheader-definitions.html#MessageHeader.receiver" title="Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient."><b>receiver</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="practitioner.html#Practitioner">Practitioner</a>|<a href="organization.html#Organization">Organization</a>)</span> <span style="color: navy"> Intended "real-world" recipient for the data</span><span style="color: Gray"> --></span></receiver> <<a class="dict" href="messageheader-definitions.html#MessageHeader.responsible" title="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."><b>responsible</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="practitioner.html#Practitioner">Practitioner</a>|<a href="organization.html#Organization">Organization</a>)</span> <span style="color: navy"> Final responsibility for event</span><span style="color: Gray"> --></span></responsible> <<a class="dict" href="messageheader-definitions.html#MessageHeader.reason" title="Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message."><b>reason</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-message-reason-encounter.html" style="color: navy">Cause of event</a></span><span style="color: Gray"> --></span></reason> <<a class="dict" href="messageheader-definitions.html#MessageHeader.data" title="The actual data of the message - a reference to the root/focus class of the event."><b>data</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="resourcelist.html">Any</a>)</span> <span style="color: navy">The actual content of the message</span><span style="color: Gray"> --></span></data> </MessageHeader> </pre></div> </text> <name value="messageheader"/> <publisher value="FHIR Project"/> <description value="Basic Profile. The header for a message exchange that is either requesting or responding to an action. The resource(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."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage The MessageHeader resource is defined in order to support Messaging using FHIR resources. The principle usage of the MessageHeader resource is when messages are exchanged. However, as a resource that can be used with the RESTful framework, the MessageHeader resource has the normal resource end-point ([base-url]/Message), which is used to manage a set of static messages resources. This could be used to make an archive of past messages available. Creating or updating Message resources in this fashion does not represent the actual occurrence of any event, nor can it trigger any logic associated with the actual event. It is just for managing a set of message resources."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="MessageHeader"/> <publish value="true"/> <element> <path value="MessageHeader"/> <definition> <short value="A resource that describes a message that is exchanged between systems"/> <formal value="The header for a message exchange that is either requesting or responding to an action. The resource(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."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Message"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH / MSA / ERR"/> </mapping> </definition> </element> <element> <path value="MessageHeader.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal 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 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal 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 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal 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> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.contained"/> <definition> <short value="Contained, inline Resources"/> <formal 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> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.identifier"/> <definition> <short value="Id of this message"/> <formal 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> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Message.id"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-10-message control ID"/> </mapping> </definition> </element> <element> <path value="MessageHeader.timestamp"/> <definition> <short value="Time that the message was sent"/> <formal value="The time that the message was sent."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./creationTime[isNormalDatatype()]"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-7-message date/time"/> </mapping> </definition> </element> <element> <path value="MessageHeader.event"/> <definition> <short value="Code for the event this message represents"/> <formal value="Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/mes sage-type"."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="true"/> <binding> <name value="MessageEvent"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/message-events"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDa tatype()]/code"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-9.2-message type.trigger event"/> </mapping> </definition> </element> <element> <path value="MessageHeader.response"/> <definition> <short value="If this is a reply to prior message"/> <formal 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="rim"/> <map value="./conveyedAcknowledgement"/> </mapping> <mapping> <identity value="v2"/> <map value="MSA"/> </mapping> </definition> </element> <element> <path value="MessageHeader.response.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal 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 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.response.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal 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 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.response.identifier"/> <definition> <short value="Id of original message"/> <formal value="The id of the message that this message is a response to."/> <min value="1"/> <max value="1"/> <type> <code value="id"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./acknowledges.id[isNormalDatatype()]"/> </mapping> <mapping> <identity value="v2"/> <map value="MSA-2-message control ID"/> </mapping> </definition> </element> <element> <path value="MessageHeader.response.code"/> <definition> <short value="ok | transient-error | fatal-error"/> <formal 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."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <name value="ResponseType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/response-code"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./typeCode[isNormalDatatype()]"/> </mapping> <mapping> <identity value="v2"/> <map value="MSA-1-acknowledgment code"/> </mapping> </definition> </element> <element> <path value="MessageHeader.response.details"/> <definition> <short value="Specific list of hints/warnings/errors"/> <formal 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."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/OperationOutcome"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]"/> </mapping> <mapping> <identity value="v2"/> <map value="ERR"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source"/> <definition> <short value="Message Source Application"/> <formal value="The source application from which this message originated."/> <min value="1"/> <max value="1"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./communicationFunction[typeCode="SND"])"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal 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 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.source.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal 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 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.source.name"/> <definition> <short value="Name of system"/> <formal value="Human-readable name for the target system."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-3-sending application"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.software"/> <definition> <short value="Name of software running the system"/> <formal value="May include configuration or other information useful in debugging."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormal Datatype()])"/> </mapping> <mapping> <identity value="v2"/> <map value="SFT-3-software product name ( +SFT-1-software vendor organization)"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.version"/> <definition> <short value="Version of software running"/> <formal value="Can convey versions of multiple systems in situations where a message passes through multiple hands."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="(Not supported)"/> </mapping> <mapping> <identity value="v2"/> <map value="SFT-2-software certified version or release number"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.contact"/> <definition> <short value="Human contact for problems"/> <formal value="An e-mail, phone, website or other contact point to use to resolve issues with message communications."/> <min value="0"/> <max value="1"/> <type> <code value="Contact"/> </type> <isModifier value="false"/> <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> <mapping> <identity value="v2"/> <map value="(MSH-22?)"/> </mapping> </definition> </element> <element> <path value="MessageHeader.source.endpoint"/> <definition> <short value="Actual message source address or id"/> <formal 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."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./telecom[isNormalDatatype()]"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-24-sending network address"/> </mapping> </definition> </element> <element> <path value="MessageHeader.destination"/> <definition> <short value="Message Destination Application(s)"/> <formal 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."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./communicationFunction[typeCode="RCV"]"/> </mapping> </definition> </element> <element> <path value="MessageHeader.destination.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal 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 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.destination.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal 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 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="MessageHeader.destination.name"/> <definition> <short value="Name of system"/> <formal value="Human-readable name for the source system."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-5-receiving application"/> </mapping> </definition> </element> <element> <path value="MessageHeader.destination.target"/> <definition> <short value="Particular delivery destination within the destination"/> <formal value="Identifies the target end system in situations where the initial message transmission is to an intermediary system."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Device"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]"/> </mapping> </definition> </element> <element> <path value="MessageHeader.destination.endpoint"/> <definition> <short value="Actual destination address or id"/> <formal 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."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./telecom"/> </mapping> <mapping> <identity value="v2"/> <map value="MSH-25-receiving network address (or MSH-6-receiving facility by implication)"/> </mapping> </definition> </element> <element> <path value="MessageHeader.enterer"/> <definition> <short value="The source of the data entry"/> <formal 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."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <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> <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> </definition> </element> <element> <path value="MessageHeader.author"/> <definition> <short value="The source of the decision"/> <formal 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."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <isModifier value="false"/> <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> <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> </definition> </element> <element> <path value="MessageHeader.receiver"/> <definition> <short value="Intended "real-world" recipient for the data"/> <formal 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."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"/> </mapping> <mapping> <identity value="v2"/> <map value="PRT-5-Participation Person:PRT-4-Participation='WAYR' / PRT-8-Participation Organization:PRT-4-Parti cipation='WAYR'"/> </mapping> </definition> </element> <element> <path value="MessageHeader.responsible"/> <definition> <short value="Final responsibility for event"/> <formal 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."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Organization"/> </type> <isModifier value="false"/> <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> <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> </definition> </element> <element> <path value="MessageHeader.reason"/> <definition> <short value="Cause of event"/> <formal 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."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="EventReason"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/message-reason-encounter"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reas onCode[isNormalDatatype()])"/> </mapping> <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> </definition> </element> <element> <path value="MessageHeader.data"/> <definition> <short value="The actual content of the message"/> <formal 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."/> <min value="0"/> <max value="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <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> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> </structure> </Profile>
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change