2.16.840.1.113883.10.21.4.11/static-2017-05-10T000000

Id	2.16.840.1.113883.10.21.4.11	Effective Date	valid from 2017‑05‑10
Status	Draft	Version Label
Name	UVMedicationInformationdetail	Display Name	UV Medication Information (detail)
Description	Universal Medication Information (detail)
Context	Parent nodes of template element with id 2.16.840.1.113883.10.21.4.11
Classification	CDA Entry Level Template
Open/Closed	Open (other than defined elements are allowed)
Used by / Uses	Used by 0 transactions and 2 templates, Uses 0 templates Used by as Name Version 2.16.840.1.113883.10.21.4.1 Containment UV Medication Order () 2015‑10‑07 2.16.840.1.113883.10.21.4.7 Containment UV Medication Statement () 2017‑05‑01
Relationship	Specialization: template 2.16.840.1.113883.10.12.312 CDA ManufacturedProduct (2005‑09‑07) ref (from repository: ad1bbr-) Adaptation: template 1.3.6.1.4.1.19376.1.9.1.3.1 Medicine Entry Content Module (DYNAMIC) ref (from repository: iheptv-)
Item DT Card Conf Description Label hl7:manufactured​Material UVMe...tail @classCode cs 0 … 1 F MMAT @determiner​Code cs 0 … 1 F KIND hl7:templateId II 1 … 1 M UVMe...tail @root uid 1 … 1 F 2.16.840.1.113883.10.21.4.11 hl7:code CE 1 … 1 R The code element element SHALL be present and describes the code of the medication. The medication may be either<ul> <li>a brand/product or</li> <li>described as a generic/scientific name or</li> <li>a descriptor of a magistral preparation/compound medicine</li> </ul>If the medicine has no name, nullFlavor="NA" shall be used. The originalText shall contain a reference whose URI value points to the name and strength of the medication, or just the name alone if strength is not relevant. If the medicine is uncoded (e.g., magistral preparations, compound medicine, ...) nullFlavor="NA" SHALL be used. UVMe...tail hl7:originalText ED 1 … 1 R In the case of magistral preparation, the name is populated in original text UVMe...tail hl7:reference TEL 1 … 1 R UVMe...tail @nullFlavor cs 0 … 1 F NA hl7:translation CE 0 … * UVMe...tail   CONF shall be drawn from concept domain "Product Code" hl7:name EN 1 … 1 R The element SHALL contain the name of the medication (e.g.,“Adol 500mg Caplet”).The medication may be either<ul> <li>a brand/product or</li> <li>described as a generic/scientific name or</li> <li>a descriptor of a magistral preparation/compound medicine</li> </ul>If the medicine has no brand name (e.g., magistral preparations, compound medicine, ...) nullFlavor="NA" SHALL be used. UVMe...tail @nullFlavor cs 0 … 1 F NA pharm:formCode CE 0 … * This code represents the pharmaceutical dose form (e.g., tablet, capsule, liquid) and SHOULD be present, if not implied by the product. It MAY be present if implied by the product. The value of this code may affect the units used in the substance administration quantity element. UVMe...tail hl7:lotNumberText ST 0 … 1 The lotNumberText element MAY be present and is a string representation of a lot number of this specific instance of the product. The provided lot number SHALL refer to the primary packaged item described in the Packaging element. UVMe...tail pharm:expirationTime TS 0 … 1 The pharm:expirationTime element MAY be present and SHALL contain a value attribute containing the date (e.g., specific date, specific date including time) of expiration of this specific instance of the product. The value given in the pharm:expirationTime element SHALL refer to the primary packaged item described in the Medicine Packaging element. UVMe...tail @value 1 … 1 R pharm:asContent 0 … * This structure describes the packaging of the medication and MAY be present. It represents the primary description of the packaging of the medicine (e.g., the medicine is packaged in ampoules of 50ml volume each) and may include additional packaging information of how many of the primary packaged items are within an outer package (e.g., 5 ampoules are packaged in a box). <br/>The primary description of the package SHOULD be consistent with the given pharmaceutical dose form (pharm:formCode of the medication, see chapter “Medication Form Code”). Example: a consistent pharmaceutical dose form to the package form “Ampoules” would be e.g., “Solution for injection”. <br/>In case the package describes a product, the pharm:code element provides the code for the product and SHOULD be present. <br/>In case the package describes a product, and the package has a brand name, it SHOULD be described in the pharm:name element (e.g., Xylocaine 1% with Adrenaline Inj, 5 injections package). <br/>The pharm:formCode element represents the form of the package (e.g., tablet container, bottle, ...) and SHOULD be present, if not implied by the product. It MAY be present if implied by the product. It SHALL be present if the asSuperContent element is present. <br/>The pharm:capacity​Quantity element SHALL be present and describes the capacity of the packaging. <br/>If the capacityQuantity is given in countable units, the unit attribute SHALL NOT be present. If the capacityQuantity is given in non-countable units, the unit attribute SHALL be present and the value SHALL be out of the UCUM code system. <br/>A pharm:asSuperContent element MAY be present to represent the quantity of the given primary packaged item (e.g., ampoule of 50ml) within an outer package (e.g., 5 ampoules in a box). It SHALL contain a pharm:container​Packaged​Medicine element which SHALL contain a pharm:capacity​Quantity element describing the quantity of the given primary packaged item present in the outer package. If the capacityQuantity is given in countable units, the unit attribute SHALL NOT be present. If the capacityQuantity is given in non-countable units, the unit attribute SHALL be present and the value SHALL be out of the UCUM code system. UVMe...tail @classCode cs 1 … 1 F CONT   Example General example <pharm:asContent classCode="CONT">   <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">     <!-- Medicinal product code (package-level) -->     <pharm:code code=" " displayName=" " codeSystem=" " codeSystemName=" "/>    <!-- Brand name (package) -->     <pharm:name> . . . </pharm:name>    <pharm:formCode code=" " displayName=" " codeSystem=" " codeSystemName=" "/>    <pharm:capacityQuantity value=" " unit=" "/>    <pharm:asSuperContent>       <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">         <pharm:capacityQuantity value=" " unit=" "/>      </pharm:containerPackagedMedicine>    </pharm:asSuperContent>  </pharm:containerPackagedMedicine></pharm:asContent>   Example Medicinal product with pharmaceutical dose form ”Tablets”, available as a “Tablet container” with 30 tablets <pharm:asContent classCode="CONT">   <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">     <!-- .. -->     <pharm:formCode code=" " displayName="Tablet container" codeSystem=" " codeSystemName=" "/>    <!-- 30 tablets in the package -->     <pharm:capacityQuantity value="30"/>  </pharm:containerPackagedMedicine></pharm:asContent>   Example Medicinal product with pharmaceutical dose form 'Solution for injection', available as “Ampoules” with 50ml volume, packaged as 5 ampoules per box <pharm:asContent classCode="CONT">   <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">     <!-- .. -->     <pharm:formCode code=" " displayName="Ampoules" codeSystem=" " codeSystemName=" "/>    <pharm:capacityQuantity value="50" unit="ml"/>    <!-- 50ml per ampoule -->     <pharm:asSuperContent>       <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">         <!-- 5 ampoules in a box -->         <pharm:capacityQuantity value="5"/>      </pharm:containerPackagedMedicine>    </pharm:asSuperContent>  </pharm:containerPackagedMedicine></pharm:asContent> pharm:containerPackagedProduct 1 … * R UVMe...tail @classCode cs 1 … 1 F CONT @determiner​Code cs 1 … 1 F INSTANCE pharm:code CE 0 … * UVMe...tail pharm:name EN 0 … * UVMe...tail pharm:formCode CE 0 … 1 UVMe...tail   Schematron assert role  error     test not(pharm:capacity​Quantity) or pharm:formCode     Message pharm:formCode SHALL be present if pharm:asSuperContent present   pharm:capacity​Quantity PQ 1 … 1 M UVMe...tail @value 1 … 1 R @unit cs 0 … 1   pharm:asSuperContent 0 … * UVMe...tail pharm:container​Packaged​Medicine 1 … * R UVMe...tail @classCode cs 1 … 1 F CONT @determiner​Code cs 1 … 1 F INSTANCE pharm:capacity​Quantity PQ 1 … 1 M UVMe...tail @value 1 … 1 R @unit cs 0 … 1   pharm:asContent 0 … * R In case of multiple layers of packaging (5 vials 10 ml; box with 2 blisters of 20 tablets)&#160;this element can be used for describing the intermediate Packaged Medicinal Product Item&#160;or the Packaged Medicinal Product.<br clear="none"/> <br clear="none"/>For example in the case&#160;<br clear="none"/>&#160; \--Box&#160;<br clear="none"/>&#160; \-----2&#160;blisters&#160;<br clear="none"/>&#160; \--------20 tablets&#160;<br clear="none"/>it describes the "2 blisters"&#160;<br clear="none"/> <br clear="none"/>In the case of&#160;<br clear="none"/>&#160; \--Box&#160;<br clear="none"/>&#160; \-----5 vials<br clear="none"/>it represents the&#160;Packaged Medicinal Product.&#160; UVMe...tail @classCode cs 1 … 1 F CONT pharm:containerPackagedProduct 1 … * R It represents the intermediate Package Item or the Packaged Medicinal Product UVMe...tail @classCode cs 1 … 1 F CONT @determiner​Code cs 1 … 1 F INSTANCE pharm:code CD 0 … 1 UVMe...tail pharm:name ST 0 … 1 R UVMe...tail pharm:formCode CE 1 … 1 R UVMe...tail pharm:asContent 0 … * R In case of multiple layers of packaging (box with 2 blisters of 20 tablets)&#160;this element is used for describing the most outer Packaged Medicinal Product Item&#160;or the Packaged Medicinal Product.<br clear="none"/> <br clear="none"/>For example in the case&#160;<br clear="none"/>&#160; \--Box&#160;<br clear="none"/>&#160; \-----2&#160;blisters&#160;<br clear="none"/>&#160; \--------20 tablets&#160;<br clear="none"/>it describes the Packaged Medicinal Product.&#160;<br clear="none"/> UVMe...tail @classCode cs 1 … 1 F CONT pharm:containerPackagedProduct 1 … * R When present, it represents the the Packaged Medicinal Product UVMe...tail @classCode cs 1 … 1 F CONT @determiner​Code cs 1 … 1 F INSTANCE pharm:code CD 0 … * UVMe...tail pharm:name ST 0 … * R When present, it can be used for the representing the brand name. UVMe...tail pharm:formCode CE 1 … 1 R UVMe...tail pharm:quantity PQ 0 … * UVMe...tail pharm:asSpecializedKind 0 … * R UVMe...tail @classCode cs 1 … 1 F GRIC   Example <pharm:asSpecializedKind classCode="GRIC">   <pharm:generalizedMedicineClass classCode="MMAT">     <pharm:code code=" " displayName=" " codeSystem=" " codeSystemName=" "/>  </pharm:generalizedMedicineClass></pharm:asSpecializedKind> pharm:generalizedMedicineClass 0 … * UVMe...tail @classCode cs 1 … 1 F MMAT pharm:code 1 … 1 R UVMe...tail pharm:name 0 … * UVMe...tail pharm:ingredient 0 … * UVMe...tail @classCode cs 1 … 1 F ACTI   Example <pharm:ingredient classCode="ACTI">   <pharm:quantity>     <numerator xsi:type="PQ" value=" " unit=" "/>    <denominator xsi:type="PQ" value=" " unit=" "/>  </pharm:quantity>  <pharm:ingredient classCode="MMAT" determinerCode="KIND">     <pharm:code code=" " displayName=" " codeSystem="2.16.840.1.113883.6.73" codeSystemName="ATC WHO"/>  </pharm:ingredient></pharm:ingredient> pharm:quantity 0 … 1 UVMe...tail   Example 10 mg of the ingredient per ml <pharm:quantity>   <numerator xsi:type="PQ" value="10" unit="mg"/>  <denominator xsi:type="PQ" value="1" unit="ml"/></pharm:quantity>   Example 2% of the ingredient <pharm:quantity>   <numerator xsi:type="PQ" value="2" unit="%"/>  <denominator xsi:type="PQ" value="1"/></pharm:quantity>   Example 5mg of the ingredient <pharm:quantity>   <numerator xsi:type="PQ" value="5" unit="mg"/>  <denominator xsi:type="PQ" value="1"/></pharm:quantity> pharm:numerator 0 … 1 UVMe...tail pharm:denominator 0 … 1 UVMe...tail pharm:ingredientSubstance 0 … * UVMe...tail @classCode cs 1 … 1 F MMAT @determiner​Code cs 1 … 1 F KIND pharm:code 0 … 1 UVMe...tail pharm:name 1 … 1 R UVMe...tail