2.16.840.1.113883.10.21.4.11/static-2017-05-10T000000

From HL7 IPS
Revision as of 17:37, 26 March 2018 by ADbot (talk | contribs) (Automated ADBot page content)
Jump to: navigation, search
Id2.16.840.1.113883.10.21.4.11Effective Date valid from 2017‑05‑10
StatusKyellow.png DraftVersion Label
NameUVMedicationInformationdetailDisplay NameUV Medication Information (detail)
DescriptionUniversal Medication Information (detail)
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.11
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 2 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.10.21.4.1ContainmentKyellow.png UV Medication Order ()2015‑10‑07
2.16.840.1.113883.10.21.4.7ContainmentKyellow.png UV Medication Statement ()2017‑05‑01
RelationshipSpecialization: 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-)
ItemDTCardConfDescriptionLabel
hl7:manufactured​Material
UVMe...tail
Treetree.png@classCode
cs0 … 1FMMAT
Treetree.png@determiner​Code
cs0 … 1FKIND
Treetree.pnghl7:templateId
II1 … 1MUVMe...tail
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.11
Treetree.pnghl7:code
CE1 … 1RThe 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
Treeblank.pngTreetree.pnghl7:originalText
ED1 … 1RIn the case of magistral preparation, the name is populated in original textUVMe...tail
Treeblank.pngTreeblank.pngTreetree.pnghl7:reference
TEL1 … 1RUVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1FNA
Treeblank.pngTreetree.pnghl7:translation
CE0 … *UVMe...tail
 CONF
shall be drawn from concept domain "Product Code"
Treetree.pnghl7:name
EN1 … 1RThe 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
Treeblank.pngTreetree.png@nullFlavor
cs0 … 1FNA
Treetree.pngpharm:formCode
CE0 … *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
Treetree.pnghl7:lotNumberText
ST0 … 1The 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
Treetree.pngpharm:expirationTime
TS0 … 1The 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
Treeblank.pngTreetree.png@value
1 … 1R
Treetree.pngpharm: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
Treeblank.pngTreetree.png@classCode
cs1 … 1FCONT
 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>
Treeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … *RUVMe...tail
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … *UVMe...tail
Treeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … *UVMe...tail
Treeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1UVMe...tail
 Schematron assertroleKred.png error 
 testnot(pharm:capacity​Quantity) or pharm:formCode 
 Messagepharm:formCode SHALL be present if pharm:asSuperContent present 
Treeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ1 … 1MUVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreetree.pngpharm:asSuperContent
0 … *UVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:container​Packaged​Medicine
1 … *RUVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ1 … 1MUVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreetree.pngpharm:asContent
0 … *RIn 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
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … *RIt represents the intermediate Package Item or the Packaged Medicinal ProductUVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1UVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … 1RUVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1RUVMe...tail
Treeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *RIn 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
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … *RWhen present, it represents the the Packaged Medicinal ProductUVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … *UVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … *RWhen present, it can be used for the representing the brand name.UVMe...tail
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1RUVMe...tail
Treetree.pngpharm:quantity
PQ0 … *UVMe...tail
Treetree.pngpharm:asSpecializedKind
0 … *RUVMe...tail
Treeblank.pngTreetree.png@classCode
cs1 … 1FGRIC
 Example<pharm:asSpecializedKind classCode="GRIC">
  <pharm:generalizedMedicineClass classCode="MMAT">
    <pharm:code code=" " displayName=" " codeSystem=" " codeSystemName=" "/>  </pharm:generalizedMedicineClass>
</pharm:asSpecializedKind>
Treeblank.pngTreetree.pngpharm:generalizedMedicineClass
0 … *UVMe...tail
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreetree.pngpharm:code
1 … 1RUVMe...tail
Treeblank.pngTreeblank.pngTreetree.pngpharm:name
0 … *UVMe...tail
Treetree.pngpharm:ingredient
0 … *UVMe...tail
Treeblank.pngTreetree.png@classCode
cs1 … 1FACTI
 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>
Treeblank.pngTreetree.pngpharm:quantity
0 … 1UVMe...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>
Treeblank.pngTreeblank.pngTreetree.pngpharm:numerator
0 … 1UVMe...tail
Treeblank.pngTreeblank.pngTreetree.pngpharm:denominator
0 … 1UVMe...tail
Treeblank.pngTreetree.pngpharm:ingredientSubstance
0 … *UVMe...tail
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreetree.pngpharm:code
0 … 1UVMe...tail
Treeblank.pngTreeblank.pngTreetree.pngpharm:name
1 … 1RUVMe...tail