3.28.8 Extension: Medication Code is Representative - XML Profile
XML representation of the ext-medication-code-representative Extension
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="ext-medication-code-representative"/>
<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-medication-code-representative-definitions.html#Extension" title="If set to true, indicates that the medication code sent was chosen as a "representative" code of a drug picked at a more general level. I.e. The user didn't actually choose this specific code. The intended constraints around what drug should be supplied are conveyed by the request's substitution rules.">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/extensibility.html#Extension">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">Representative Drug</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-medication-code-representative-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://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative"</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_primitive.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="extension-ext-medication-code-representative-definitions.html#Extension.value[x]" title="If set to true, indicates that the medication code sent was chosen as a "representative" code of a drug picked at a more general level. I.e. The user didn't actually choose this specific code. The intended constraints around what drug should be supplied are conveyed by the request's substitution rules.">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="http://hl7.org/fhir/2016may/datatypes.html#boolean">boolean</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Representative Drug</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://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative"/>
<version value="5.0"/>
<name value="Medication Code is Representative"/>
<status value="draft"/>
<date value="2016-03-30T17:01:25-04:00"/>
<description
value="If set to true, indicates that the medication code sent was chosen as a "representative" code of a drug picked at a more general level. I.e. The user didn't actually choose this specific code. The intended constraints around what drug should be supplied are conveyed by the request's substitution rules."/>
<requirements
value="The ability to add extensions in a structured way is what keeps FHIR resources simple."/>
<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="resource"/>
<context value="Medication.code.coding"/>
<baseType value="Extension"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/>
<derivation value="constraint"/>
<snapshot>
<element id="Extension">
<path value="Extension"/>
<short value="Representative Drug"/>
<definition
value="If set to true, indicates that the medication code sent was chosen as a "representative" code of a drug picked at a more general level. I.e. The user didn't actually choose this specific code. The intended constraints around what drug should be supplied are conveyed by the request's substitution rules."/>
<comments
value="Usage Note: Below the Grid View, we have provided a business scenario to provide further guidance and clarity on the intended use.
Conformance Rule: If prescribing by Generic Name, a (representative) DIN must be present in the message and this boolean must be 'true'.
Usage Note: ONLY the ingredients are to be interpreted from the DIN when it is a Representative DIN. The strength and the form may be supplied as separate fields. If the strength is not supplied, then the prescriber must specify the dosage.
Usage Note: Upon receipt of a prescription, the PMS will look at this field. If 'true', then this is a representative DIN. The PMS my choose to use this as a means to automatically filter and present a list of possible DINs/ appropriate medication . The prescribed dosage (e.g. 20 mg) and route will also be considered. Once presented with a list, the pharmacist can select a medication from this list or may select another generic equivalent with the same prescribed dosage.
Usage in the EMR: The representative DIN is chosen by the EMR (not the prescriber) based on the drug and route that is entered by the prescriber.
Usage Notes: The representative DIN is NOT intended for display to the pharmacist, as this is ONLY used for filtering. It would be appropriate to show the pharmacist the generic name (HICL or GCN) associated with the representative DIN. The drug name MUST be shown to the pharmacist.
Note: This concept does NOT exist today; pharmacists dispense based on the generic name. Its use within ePrescribing is to allow for automation as it provides a codified value to represent what the prescriber wants. This may assist the pharmacist in dispensing.
Usage Note: If the form and route are not supplied in the message, then the prescriber must specify the dosage."/>
<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://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative"/>
<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://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative"/>
<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]"/>
<short value="Representative Drug"/>
<definition
value="If set to true, indicates that the medication code sent was chosen as a "representative" code of a drug picked at a more general level. I.e. The user didn't actually choose this specific code. The intended constraints around what drug should be supplied are conveyed by the request's substitution rules."/>
<comments
value="If this is present, a corresponding substitution code should also be present"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.value[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
<mustSupport value="true"/>
<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="Representative Drug"/>
<definition
value="If set to true, indicates that the medication code sent was chosen as a "representative" code of a drug picked at a more general level. I.e. The user didn't actually choose this specific code. The intended constraints around what drug should be supplied are conveyed by the request's substitution rules."/>
<comments
value="Usage Note: Below the Grid View, we have provided a business scenario to provide further guidance and clarity on the intended use.
Conformance Rule: If prescribing by Generic Name, a (representative) DIN must be present in the message and this boolean must be 'true'.
Usage Note: ONLY the ingredients are to be interpreted from the DIN when it is a Representative DIN. The strength and the form may be supplied as separate fields. If the strength is not supplied, then the prescriber must specify the dosage.
Usage Note: Upon receipt of a prescription, the PMS will look at this field. If 'true', then this is a representative DIN. The PMS my choose to use this as a means to automatically filter and present a list of possible DINs/ appropriate medication . The prescribed dosage (e.g. 20 mg) and route will also be considered. Once presented with a list, the pharmacist can select a medication from this list or may select another generic equivalent with the same prescribed dosage.
Usage in the EMR: The representative DIN is chosen by the EMR (not the prescriber) based on the drug and route that is entered by the prescriber.
Usage Notes: The representative DIN is NOT intended for display to the pharmacist, as this is ONLY used for filtering. It would be appropriate to show the pharmacist the generic name (HICL or GCN) associated with the representative DIN. The drug name MUST be shown to the pharmacist.
Note: This concept does NOT exist today; pharmacists dispense based on the generic name. Its use within ePrescribing is to allow for automation as it provides a codified value to represent what the prescriber wants. This may assist the pharmacist in dispensing.
Usage Note: If the form and route are not supplied in the message, then the prescriber must specify the dosage."/>
<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://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative"/>
<min value="1"/>
<fixedUri
value="http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative"/>
<mustSupport value="true"/>
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]"/>
<short value="Representative Drug"/>
<definition
value="If set to true, indicates that the medication code sent was chosen as a "representative" code of a drug picked at a more general level. I.e. The user didn't actually choose this specific code. The intended constraints around what drug should be supplied are conveyed by the request's substitution rules."/>
<comments
value="If this is present, a corresponding substitution code should also be present"/>
<min value="1"/>
<type>
<code value="boolean"/>
</type>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>