3.12.8 Extension: Referenced Business identifier - XML Profile
XML representation of the ext-reference-identifier Extension
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="ext-reference-identifier"/>
<text>
<status value="extensions"/>
<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="extension-ext-reference-identifier-definitions.html#Extension" title="Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL">Extension</a><a name="Extension"> </a></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"><span style="opacity: 0.5">0</span>..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 href="http://hl7.org/fhir/2016may/fake-extension-for-r3.html">Reference.identifier DSTU2 extension</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Referenced identifier</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.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_extension_simple.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Simple Extension" class="hierarchy"/> <span style="text-decoration:line-through">extension</span><a name="Extension.extension"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="text-decoration:line-through"/><span style="text-decoration:line-through">0</span><span style="text-decoration:line-through">..</span><span style="text-decoration:line-through">0</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; 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_bck10.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="extension-ext-reference-identifier-definitions.html#Extension.url">url</a><a name="Extension.url"> </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" 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..<span style="opacity: 0.5">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.5" 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="color: darkgreen">"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.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_datatype.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="extension-ext-reference-identifier-definitions.html#Extension.value[x]" title="Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL">value[x]</a><a name="Extension.value_x_"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="dtprofile-identifier.html" title="Identifier">Shared Health Identifier</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Referenced identifier</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/ext-reference-identifier"/>
<version value="5.0"/>
<name value="Referenced Business identifier"/>
<status value="draft"/>
<date value="2016-03-30T17:01:25-04:00"/>
<description
value="Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL"/>
<fhirVersion value="1.4.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM"/>
</mapping>
<kind value="datatype"/>
<abstract value="false"/>
<contextType value="datatype"/>
<context value="Reference"/>
<baseType value="Extension"/>
<baseDefinition
value="http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"/>
<derivation value="constraint"/>
<snapshot>
<element id="Extension">
<path value="Extension"/>
<short value="Referenced identifier"/>
<definition
value="Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL"/>
<comments
value="When this is present, the reference is typically omitted.
Usage Note: This provides the medication order identifier that the dispense is associated with
Usage Note: In the context of p160 and p200, PMS's will populate this identifier value with the appropriate value
Usage Note: In the context of p200, EMRs need to use this value to find the corresponding medication order in their local system in order to associate the incoming dispense it to.
Usage Note: In the context of p160, EMRs can use either this value or the MedicationOrder.identifier:EMR-id to find the corresponding medication order in their local system which is related to the medication order which is asking to be renewed.
Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the [Shared Health implementation Guide](../common/common.html#pre-adopted-extensions) for more information."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Extension"/>
<min value="0"/>
<max value="*"/>
</base>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Extension.id">
<path value="Extension.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="1"/>
</base>
<type>
<code value="id"/>
</type>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Extension.extension">
<path value="Extension.extension"/>
<short value="Extension"/>
<definition value="An Extension"/>
<min value="0"/>
<max value="0"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Extension.url">
<path value="Extension.url"/>
<representation value="xmlAttr"/>
<short value="identifies the meaning of the extension"/>
<definition
value="Source of the definition for the extension code - a logical name or a URL."/>
<comments
value="Fixed value: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.url"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<fixedUri
value="http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]"/>
<slicing>
<discriminator value="$this/@type"/>
<ordered value="false"/>
<rules value="closed"/>
</slicing>
<short value="Referenced identifier"/>
<definition
value="Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL"/>
<comments
value="When this is present, the reference is typically omitted.
Comments:
In the context of a p200 this will represent the mediation order identifier of the original electronic prescription (e110, e120, e162, e163, e180) which the dispense is associated with.
In the context of a p160 this will represent either the mediation order identifier of the original electronic prescription (e110, e120, e162, e163, e180) which is the dispense is associated with or it will be the pharmacies own medication order identifier when the dispense is associated with a previous non-electronic order (i.e. paper or fax).
Usage: EMR's should use the identifier.system and identifier.value to determine whether medication order relates to an order within the local application. The identifier.system value represents the application (application instance id) that assigned the identifier and identifier.value represents the actual medication order value. When the system value does NOT match the local application then this identifier was assigned by another application and should be treated like a non-electronic (i.e. paper or fax) order. When the system value matches the local application then this identifier was assigned by this application and the system should then proceed to find the value. If the value cannot be found it should be treated like a non-electronic (i.e. paper or fax) order. Only when both the system and value match a local medication order can the application treat it as a electronic medication order."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.value[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Identifier"/>
<profile
value="http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier"/>
</type>
<maxLength value="0"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="v2"/>
<map
value="CX / EI (occasionally, more often EI maps to a resource id or a URL)"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="Identifier"/>
</mapping>
</element>
<element id="Extension.value[x]:valueIdentifier">
<path value="Extension.value[x]"/>
<name value="valueIdentifier"/>
<short value="Value of extension"/>
<definition
value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.value[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Identifier"/>
</type>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Extension">
<path value="Extension"/>
<short value="Referenced identifier"/>
<definition
value="Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL"/>
<comments
value="When this is present, the reference is typically omitted.
Usage Note: This provides the medication order identifier that the dispense is associated with
Usage Note: In the context of p160 and p200, PMS's will populate this identifier value with the appropriate value
Usage Note: In the context of p200, EMRs need to use this value to find the corresponding medication order in their local system in order to associate the incoming dispense it to.
Usage Note: In the context of p160, EMRs can use either this value or the MedicationOrder.identifier:EMR-id to find the corresponding medication order in their local system which is related to the medication order which is asking to be renewed.
Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the [Shared Health implementation Guide](../common/common.html#pre-adopted-extensions) for more information."/>
<max value="1"/>
</element>
<element id="Extension.extension">
<path value="Extension.extension"/>
<max value="0"/>
<mustSupport value="false"/>
</element>
<element id="Extension.url">
<path value="Extension.url"/>
<comments
value="Fixed value: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"/>
<min value="1"/>
<fixedUri
value="http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"/>
<mustSupport value="true"/>
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]"/>
<short value="Referenced identifier"/>
<definition
value="Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL"/>
<comments
value="When this is present, the reference is typically omitted.
Comments:
In the context of a p200 this will represent the mediation order identifier of the original electronic prescription (e110, e120, e162, e163, e180) which the dispense is associated with.
In the context of a p160 this will represent either the mediation order identifier of the original electronic prescription (e110, e120, e162, e163, e180) which is the dispense is associated with or it will be the pharmacies own medication order identifier when the dispense is associated with a previous non-electronic order (i.e. paper or fax).
Usage: EMR's should use the identifier.system and identifier.value to determine whether medication order relates to an order within the local application. The identifier.system value represents the application (application instance id) that assigned the identifier and identifier.value represents the actual medication order value. When the system value does NOT match the local application then this identifier was assigned by another application and should be treated like a non-electronic (i.e. paper or fax) order. When the system value matches the local application then this identifier was assigned by this application and the system should then proceed to find the value. If the value cannot be found it should be treated like a non-electronic (i.e. paper or fax) order. Only when both the system and value match a local medication order can the application treat it as a electronic medication order."/>
<min value="1"/>
<type>
<code value="Identifier"/>
<profile
value="http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier"/>
</type>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>