2.16.840.1.113883.10.21.4.11/static-2017-05-10T000000

From HL7 IPS
Revision as of 17:42, 22 July 2017 by ADbot (talk | contribs) (Automated ADBot page content)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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)
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 1 template, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.10.21.4.1ContainmentKyellow.png UV Medication Order2015‑10‑07
RelationshipSpecialization: template 2.16.840.1.113883.10.12.312 (2005‑09‑07)
Adaptation: template 1.3.6.1.4.1.19376.1.9.1.3.1 (DYNAMIC)
ItemDTCardConfDescriptionLabel
hl7:manufactured​Material
(UVM…ail)
Treetree.png@classCode
0 … 1FMMAT
Treetree.png@determiner​Code
0 … 1FKIND
Treetree.pnghl7:templateId
II1 … 1M(UVM…ail)
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
  • a brand/product or
  • described as a generic/scientific name or
  • a descriptor of a magistral preparation/compound medicine
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.
(UVM…ail)
Treeblank.pngTreetree.pnghl7:originalText
ED0 … 1(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.pnghl7:reference
TEL1 … 1R(UVM…ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1FNA
Treetree.pnghl7:name
EN1 … 1RThe element SHALL contain the name of the medication (e.g.,“Adol 500mg Caplet”).The medication may be either
  • a brand/product or
  • described as a generic/scientific name or
  • a descriptor of a magistral preparation/compound medicine
If the medicine has no brand name (e.g., magistral preparations, compound medicine, ...) nullFlavor="NA" SHALL be used.
(UVM…ail)
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 affects the units used in the substance administration quantity element.(UVM…ail)
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 605 element.(UVM…ail)
Treetree.pngpharm:expirationTime
TS0 … *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 610 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.(UVM…ail)
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).

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”.

In case the package describes a product, the pharm:code element provides the code for the product and SHOULD be present.

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).

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.

The pharm:capacity​Quantity element SHALL be present and describes the capacity of the packaging.

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.

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.
(UVM…ail)
Treeblank.pngTreetree.png@classCode
1 … 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:container​Packaged​Medicine
1 … *R(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
1 … 1FCONT
Treeblank.pngTreeblank.pngTreetree.png@determiner​Code
1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … *(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … *(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1(UVM…ail)
 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 … 1M(UVM…ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreetree.pngpharm:asSuperContent
0 … *(UVM…ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:container​Packaged​Medicine
1 … *R(UVM…ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ1 … 1M(UVM…ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treetree.pngpharm:asSpecializedKind
0 … *R(UVM…ail)
Treeblank.pngTreetree.png@classCode
1 … 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 … *(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
1 … 1FMMAT
Treeblank.pngTreeblank.pngTreetree.pngpharm:code
1 … 1R(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:name
0 … *(UVM…ail)
Treetree.pngpharm:ingredient
0 … *(UVM…ail)
Treeblank.pngTreetree.png@classCode
1 … 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 … 1(UVM…ail)
 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 … 1(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:denominator
0 … 1(UVM…ail)
Treeblank.pngTreetree.pngpharm:ingredient
0 … *(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
1 … 1FMMAT
Treeblank.pngTreeblank.pngTreetree.png@determiner​Code
1 … 1FKIND
Treeblank.pngTreeblank.pngTreetree.pngpharm:code
0 … 1(UVM…ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:name
1 … 1R(UVM…ail)