3.62.9 StructureDefinition: Interaction Message Header 999 - eRx Asynchronous Message Rejection - XML Profile
XML representation of the interaction-messageheader-999 Profile.
Narrative view of the profile
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="interaction-messageheader-999"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="interaction-messageheader-999-definitions.html#MessageHeader" title="null">MessageHeader</a><a name="MessageHeader"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red; opacity: 0.4" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="interaction-messageheader-999-definitions.html#MessageHeader.meta" title="null">meta</a><a name="MessageHeader.meta"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red; opacity: 0.4" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/2016may/resource.html#meta">Meta</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck112.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_slice.png" alt="." style="background-color: white; background-color: inherit" title="Slice Definition" class="hierarchy"/> <a style="font-style: italic" href="interaction-messageheader-999-definitions.html#MessageHeader.meta.profile" title="null">profile</a><a name="MessageHeader.meta.profile"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red; opacity: 0.4; font-style: italic" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4; font-style: italic" href="http://hl7.org/fhir/2016may/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold; font-style: italic">Slice: </span><span style="font-style: italic">Unordered, Open by value:value</span></td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck104.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="interaction-messageheader-999-definitions.html#MessageHeader.meta.profile:Profile" title="Slice Profile: null">profile</a><a name="MessageHeader.meta.profile"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red; opacity: 0.4" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/2016may/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Fixed Value: </span><span style="color: darkgreen">http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-999</span></td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="interaction-messageheader-999-definitions.html#MessageHeader.event" title="null">event</a><a name="MessageHeader.event"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red; opacity: 0.4" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/2016may/datatypes.html#Coding">Coding</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="interaction-messageheader-999-definitions.html#MessageHeader.event.code" title="null">code</a><a name="MessageHeader.event.code"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red; opacity: 0.4" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/2016may/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Fixed Value: </span><span style="color: darkgreen">999</span></td></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-999"/> <version value="2.0 Revision F"/> <name value="Interaction Message Header 999 - eRx Asynchronous Message Rejection"/> <status value="draft"/> <date value="2016-03-30T17:01:25-04:00"/> <description value="Message Header for the asynchronous rejection of an e-prescribing message (due to parsing or processing error) from the end recipient."/> <fhirVersion value="1.4.0"/> <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> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <baseType value="MessageHeader"/> <baseDefinition value="http://sharedhealth.exchange/fhir/StructureDefinition/profile-messageheader-9xx"/> <derivation value="constraint"/> <snapshot> <element id="MessageHeader"> <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."/> <min value="0"/> <max value="*"/> <base> <path value="MessageHeader"/> <min value="0"/> <max value="*"/> </base> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="MSH / MSA / ERR"/> </mapping> <mapping> <identity value="rim"/> <map value="Message"/> </mapping> <mapping> <identity value="w5"/> <map value="infrastructure.exchange"/> </mapping> </element> <element id="MessageHeader.id"> <path value="MessageHeader.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comments value="Usage Note: This value is assigned by the system that creates a bundle and is unique to the specific message instance of the bundle and the uniqueness of this value will be validated by the PrescribeIT™ service. This value is sometimes referenced in error messages."/> <min value="1"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="MessageHeader.meta"> <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."/> <comments value="See children"/> <min value="1"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Meta"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="MessageHeader.meta.id"> <path value="MessageHeader.meta.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"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.meta.extension"> <path value="MessageHeader.meta.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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.meta.versionId"> <path value="MessageHeader.meta.versionId"/> <short value="Version specific identifier"/> <definition value="The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted."/> <comments value="The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes."/> <min value="0"/> <max value="1"/> <base> <path value="Meta.versionId"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="MessageHeader.meta.lastUpdated"> <path value="MessageHeader.meta.lastUpdated"/> <short value="When the resource version last changed"/> <definition value="When the resource last changed - e.g. when the version changed."/> <comments value="This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant."/> <min value="0"/> <max value="1"/> <base> <path value="Meta.lastUpdated"/> <min value="0"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="MessageHeader.meta.profile"> <path value="MessageHeader.meta.profile"/> <slicing> <discriminator value="value"/> <rules value="open"/> </slicing> <short value="Profiles this resource claims to conform to"/> <definition value="A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]."/> <comments value="It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set."/> <min value="1"/> <max value="*"/> <base> <path value="Meta.profile"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="MessageHeader.meta.profile:Profile"> <path value="MessageHeader.meta.profile"/> <name value="Profile"/> <short value="Profiles this resource claims to conform to"/> <definition value="A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]."/> <comments value="Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-999"/> <min value="1"/> <max value="1"/> <base> <path value="Meta.profile"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-999"/> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="MessageHeader.meta.security"> <path value="MessageHeader.meta.security"/> <short value="Security Labels applied to this resource"/> <definition value="Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure."/> <comments value="The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored."/> <min value="0"/> <max value="*"/> <base> <path value="Meta.security"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="Security Labels from the Healthcare Privacy and Security Classification System."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/security-labels"/> </valueSetReference> </binding> </element> <element id="MessageHeader.meta.tag"> <path value="MessageHeader.meta.tag"/> <short value="Tags applied to this resource"/> <definition value="Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource."/> <comments value="The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored."/> <min value="0"/> <max value="*"/> <base> <path value="Meta.tag"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <strength value="example"/> <description value="Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones""/> </binding> </element> <element id="MessageHeader.implicitRules"> <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"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="MessageHeader.language"> <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"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="*"/> </base> <type> <code value="code"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <strength value="required"/> <description value="A human language."/> <valueSetReference> <reference value="http://tools.ietf.org/html/bcp47"/> </valueSetReference> </binding> </element> <element id="MessageHeader.text"> <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."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Narrative"/> </type> <maxLength value="0"/> <condition value="dom-1"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="MessageHeader.contained"> <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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="MessageHeader.extension"> <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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="MessageHeader.modifierExtension"> <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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="true"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="MessageHeader.timestamp"> <path value="MessageHeader.timestamp"/> <short value="Time that the message was sent"/> <definition value="Time and date the transaction was created"/> <comments value="Conformance Rule: Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ)."/> <requirements value="Allows limited detection of out-of-order and delayed transmission. Also supports audit."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.timestamp"/> <min value="0"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="MSH-7"/> </mapping> <mapping> <identity value="rim"/> <map value="./creationTime[isNormalDatatype()]"/> </mapping> <mapping> <identity value="w5"/> <map value="when.init"/> </mapping> </element> <element id="MessageHeader.event"> <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."/> <requirements value="Drives the behavior associated with this message."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.event"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="preferred"/> <valueSetReference> <reference value="https://fhir.infoway-inforoute.ca/ValueSet/sharedmessageevents|20170626"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="MSH-9.2"/> </mapping> <mapping> <identity value="rim"/> <map value="./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code"/> </mapping> <mapping> <identity value="w5"/> <map value="what"/> </mapping> </element> <element id="MessageHeader.event.id"> <path value="MessageHeader.event.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"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.event.extension"> <path value="MessageHeader.event.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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.event.system"> <path value="MessageHeader.event.system"/> <short value="Identity of the terminology system"/> <definition value="The identification of the code system that defines the meaning of the symbol in the code."/> <comments value="Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/> <requirements value="Need to be unambiguous about the source of the definition of the symbol."/> <min value="1"/> <max value="1"/> <base> <path value="Coding.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="orim"/> <map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"/> </mapping> <mapping> <identity value="v2"/> <map value="C*E.3"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystem"/> </mapping> </element> <element id="MessageHeader.event.version"> <path value="MessageHeader.event.version"/> <short value="Version of the system - if relevant"/> <definition value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged."/> <comments value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="orim"/> <map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"/> </mapping> <mapping> <identity value="v2"/> <map value="C*E.7"/> </mapping> <mapping> <identity value="rim"/> <map value="./codeSystemVersion"/> </mapping> </element> <element id="MessageHeader.event.code"> <path value="MessageHeader.event.code"/> <short value="Symbol in syntax defined by the system"/> <definition value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)."/> <comments value="Fixed value: 999"/> <requirements value="Need to refer to a particular code in the system."/> <min value="1"/> <max value="1"/> <base> <path value="Coding.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <fixedCode value="999"/> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="orim"/> <map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"/> </mapping> <mapping> <identity value="v2"/> <map value="C*E.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> </element> <element id="MessageHeader.event.display"> <path value="MessageHeader.event.display"/> <short value="Representation defined by the system"/> <definition value="A representation of the meaning of the code in the system, following the rules of the system."/> <requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="orim"/> <map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"/> </mapping> <mapping> <identity value="v2"/> <map value="C*E.2 - but note this is not well followed"/> </mapping> <mapping> <identity value="rim"/> <map value="CV.displayName"/> </mapping> </element> <element id="MessageHeader.event.userSelected"> <path value="MessageHeader.event.userSelected"/> <short value="If this coding was chosen directly by the user"/> <definition value="Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays)."/> <comments value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely."/> <requirements value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing."/> <min value="0"/> <max value="1"/> <base> <path value="Coding.userSelected"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="orim"/> <map value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]"/> </mapping> <mapping> <identity value="v2"/> <map value="Sometimes implied by being first"/> </mapping> <mapping> <identity value="rim"/> <map value="CD.codingRationale"/> </mapping> </element> <element id="MessageHeader.response"> <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="1"/> <max value="1"/> <base> <path value="MessageHeader.response"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="MSA"/> </mapping> <mapping> <identity value="rim"/> <map value="./conveyedAcknowledgement"/> </mapping> </element> <element id="MessageHeader.response.id"> <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"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.response.extension"> <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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.response.modifierExtension"> <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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="MessageHeader.response.identifier"> <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."/> <comments value="Conformance Rule: This should be populated with the MessageHeader.id from the message that is being rejected. Upon receipt, vendors will use this identfier to discover the message that is being rejected."/> <requirements value="Allows receiver to know what message is being responded to."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.response.identifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="MSA-2"/> </mapping> <mapping> <identity value="rim"/> <map value="./acknowledges.id[isNormalDatatype()]"/> </mapping> </element> <element id="MessageHeader.response.code"> <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"/> <base> <path value="MessageHeader.response.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <valueSetReference> <reference value="https://fhir.infoway-inforoute.ca/ValueSet/sharedmessageheaderresponsecodeerror|20170626"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="MSA-1"/> </mapping> <mapping> <identity value="rim"/> <map value="./typeCode[isNormalDatatype()]"/> </mapping> </element> <element id="MessageHeader.response.details"> <path value="MessageHeader.response.details"/> <short value="A reference from one resource to another"/> <definition value="A reference from one resource to another."/> <comments value="-"/> <requirements value="Allows the sender of the message to determine what the specific issues are."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.response.details"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://sharedhealth.exchange/fhir/StructureDefinition/profile-operationoutcome"/> <aggregation value="bundled"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)"/> </mapping> </element> <element id="MessageHeader.source"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name"> <valueString value="MessageSource"/> </extension> <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"/> <base> <path value="MessageHeader.source"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="unique(./communicationFunction[typeCode="SND"])"/> </mapping> <mapping> <identity value="w5"/> <map value="who.actor"/> </mapping> </element> <element id="MessageHeader.source.id"> <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"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.source.extension"> <path value="MessageHeader.source.extension"/> <slicing id="1"> <discriminator value="url"/> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="MessageHeader.source.extension:applicationId"> <path value="MessageHeader.source.extension"/> <name value="applicationId"/> <short value="Sending application id"/> <definition value="Unique identifier for the application responsible for sending a message."/> <comments value="Conformance Rule: This identifier must be an OID [Vendor Application OID].[Application Instance ID] expressed as a uri (e.g. urn:oid:2.16.840.1.113883.3.368.1234). Vendors will be assigned this identifier upon registration by PrescribeIT™ technical support."/> <min value="1"/> <max value="1"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-application-id"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="MessageHeader.source.extension:conformanceVersion"> <path value="MessageHeader.source.extension"/> <name value="conformanceVersion"/> <short value="Conformance version"/> <definition value="String identifying the version of the sending software application that was most recently subjected to conformance testing"/> <comments value="This is the version number of the software that underwent conformance testing. It may be earlier than the source.version in cases where the application has since undergone changes that do not affect the communication interface. Usage Note: This version must be registered with the Shared Services Hub and will be validated by the Hub at runtime."/> <min value="1"/> <max value="1"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://sharedhealth.exchange/fhir/StructureDefinition/ext-messageheader-conformance-version"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="MessageHeader.source.modifierExtension"> <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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="MessageHeader.source.name"> <path value="MessageHeader.source.name"/> <short value="Name of system"/> <definition value="Human-readable name for the source system."/> <comments value="Usage Note: The name of the Vendor."/> <requirements value="May be used to support audit."/> <min value="0"/> <max value="1"/> <base> <path value="MessageHeader.source.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="MSH-3"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])"/> </mapping> </element> <element id="MessageHeader.source.software"> <path value="MessageHeader.source.software"/> <short value="Name of software running the system"/> <definition value="May include configuration or other information useful in debugging."/> <comments value="Usage Note: The name of the Vendor's software creating the message. Conformance Rule: This must be a known value that is registered on Shared Services Hub. This will be validated at run time."/> <requirements value="Supports audit and possibly interface engine behavior."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.source.software"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="SFT-3 ( +SFT-1)"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])"/> </mapping> </element> <element id="MessageHeader.source.version"> <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."/> <comments value="Conformance Rule: This must convey the build version of the vendor application. This is the version of the application that created the message. Usage Note: This version number is issued by the software vendor and will be used primarily for audit and troubleshooting purposes. This may or may not be the same as the conformance version."/> <requirements value="Supports audit and possibly interface engine behavior."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.source.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="SFT-2"/> </mapping> <mapping> <identity value="rim"/> <map value="(Not supported)"/> </mapping> </element> <element id="MessageHeader.source.contact"> <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"/> <base> <path value="MessageHeader.source.contact"/> <min value="0"/> <max value="1"/> </base> <type> <code value="ContactPoint"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <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 id="MessageHeader.source.endpoint"> <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="This is the Provider Registry 'id' of the sending organization."/> <requirements value="Identifies where to send responses, may influence security permissions."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.source.endpoint"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="MSH-24"/> </mapping> <mapping> <identity value="rim"/> <map value="./telecom[isNormalDatatype()]"/> </mapping> </element> <element id="MessageHeader.destination"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name"> <valueString value="MessageDestination"/> </extension> <path value="MessageHeader.destination"/> <short value="Message Destination Application(s)"/> <definition value="The destination application which the message is intended for."/> <comments value="Usage Note: This is used to specify the destination system."/> <requirements value="Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient"."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.destination"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./communicationFunction[typeCode="RCV"]"/> </mapping> <mapping> <identity value="w5"/> <map value="who.focus"/> </mapping> </element> <element id="MessageHeader.destination.id"> <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"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.destination.extension"> <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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="MessageHeader.destination.modifierExtension"> <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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="MessageHeader.destination.name"> <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"/> <base> <path value="MessageHeader.destination.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="MSH-5"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])"/> </mapping> </element> <element id="MessageHeader.destination.target"> <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"/> <base> <path value="MessageHeader.destination.target"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]"/> </mapping> </element> <element id="MessageHeader.destination.endpoint"> <path value="MessageHeader.destination.endpoint"/> <short value="Actual destination address or id"/> <definition value="Indicates where the message should be routed to."/> <comments value="This will be the endpoint of the sender of the original message that is being rejected"/> <requirements value="Identifies where to route the message."/> <min value="1"/> <max value="1"/> <base> <path value="MessageHeader.destination.endpoint"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="MSH-25 (or MSH-6)"/> </mapping> <mapping> <identity value="rim"/> <map value="./telecom"/> </mapping> </element> <element id="MessageHeader.enterer"> <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"/> <base> <path value="MessageHeader.enterer"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="EVN-5 / ORC-10 / PRT-5:PRT-4='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()]/participation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])"/> </mapping> <mapping> <identity value="w5"/> <map value="who.author"/> </mapping> </element> <element id="MessageHeader.author"> <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"/> <base> <path value="MessageHeader.author"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ORC-19 / PRT-5:PRT-4='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()]/participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])"/> </mapping> <mapping> <identity value="w5"/> <map value="who.author"/> </mapping> </element> <element id="MessageHeader.receiver"> <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"/> <base> <path value="MessageHeader.receiver"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'"/> </mapping> <mapping> <identity value="rim"/> <map value="Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"/> </mapping> <mapping> <identity value="w5"/> <map value="who.focus"/> </mapping> </element> <element id="MessageHeader.responsible"> <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"/> <base> <path value="MessageHeader.responsible"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='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()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode="PSN" and determinerCode="INST"] or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/scoper[isNormalEntity() and classCode="ORG" and determinerCode="INST"])"/> </mapping> <mapping> <identity value="w5"/> <map value="who.witness"/> </mapping> </element> <element id="MessageHeader.reason"> <path value="MessageHeader.reason"/> <short value="Cause of event"/> <definition value="Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message."/> <requirements 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"/> <base> <path value="MessageHeader.reason"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <strength value="example"/> <description value="Reason for event occurrence"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/message-reason-encounter"/> </valueSetReference> </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()]/reasonCode[isNormalDatatype()])"/> </mapping> <mapping> <identity value="w5"/> <map value="why"/> </mapping> </element> <element id="MessageHeader.data"> <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="0"/> <base> <path value="MessageHeader.data"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ" and isNormalActRelatoinship]/target)"/> </mapping> </element> </snapshot> <differential> <element id="MessageHeader"> <path value="MessageHeader"/> <mustSupport value="true"/> </element> <element id="MessageHeader.meta"> <path value="MessageHeader.meta"/> <min value="1"/> <mustSupport value="true"/> </element> <element id="MessageHeader.meta.profile"> <path value="MessageHeader.meta.profile"/> <slicing> <discriminator value="value"/> <rules value="open"/> </slicing> <min value="1"/> <mustSupport value="true"/> </element> <element id="MessageHeader.meta.profile:Profile"> <path value="MessageHeader.meta.profile"/> <name value="Profile"/> <comments value="Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-999"/> <min value="1"/> <max value="1"/> <fixedUri value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-messageheader-999"/> <mustSupport value="true"/> </element> <element id="MessageHeader.event"> <path value="MessageHeader.event"/> <min value="1"/> <mustSupport value="true"/> </element> <element id="MessageHeader.event.code"> <path value="MessageHeader.event.code"/> <comments value="Fixed value: 999"/> <fixedCode value="999"/> <mustSupport value="true"/> </element> </differential> </StructureDefinition>