2.16.840.1.113883.10.21.4.6/static-2017-04-30T000000

From HL7 IPS
Jump to: navigation, search
Id2.16.840.1.113883.10.21.4.6Effective Date2017‑04‑30
Other versions this id:
  • Kblank.png UVSubordinateadministration as of 2023‑01‑30 09:36:00
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVSubordinateadministrationDisplay NameUV Subordinate Substance Administration
DescriptionUniversal Subordinate Substance Administration to convey information about dosages
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.6
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipSpecialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.6"/>  <statusCode code="active"/>  <effectiveTime xsi:type="PIVL_TS" institutionSpecified="true">
    <period value="12" unit="h"/>  </effectiveTime>
  <doseQuantity xsi:type="IVL_PQ" value="2" unit="{puff}"/>  <consumable>
    <manufacturedProduct>
      <manufacturedMaterial nullFlavor="NA"/>    </manufacturedProduct>
  </consumable>
</substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
1 … 1R(UVS...ion)
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1RIf the subordinate substance administration refers to Medication Order then a substance administration request (moodCode is 'RQO') is used.
If it refers to a Medication Statement, the moodCode shall be set to event/intent (moodCode is 'EVN' or 'INT').
 CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.21.4 Mood Code Evn Int Rqo (DYNAMIC)
 ConstraintThe moodCode of this subordinate substance administration SHALL be the same of the parent substance administration
Treetree.pnghl7:templateId
II1 … 1M(UVS...ion)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.6
Treetree.pnghl7:statusCode
CS1 … 1M(UVS...ion)
 ConstraintThe statusCode of this subordinate substance administration SHALL be the same of that of the parent substance administration.
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.21.2 ActStatusActiveCompletedAbortedSuspended (DYNAMIC)
Choice1 … 1Elements to choose from:
  • hl7:effectiveTime[@value or @nullFlavor]
  • hl7:effectiveTime[@xsi:type='PIVL_TS']
  • hl7:effectiveTime[@xsi:type='EIVL_TS']
  • hl7:effectiveTime[@xsi:type='SXPR_TS']
Treeblank.pngTreetree.pnghl7:effectiveTime
TS0 … 1CThis required element describes the frequency of intakes. If not known it shall be valued with the nullflavor "UNK"(UVS...ion)
where [@value or @nullFlavor]
 Example
Once (known date)
<effectiveTime value="20170404"/>
 Example
Unknown
<effectiveTime nullFlavor="UNK"/>
Treeblank.pngTreetree.pnghl7:effectiveTime
PIVL_TS0 … 1CPeriodic Time Interval(UVS...ion)
where [@xsi:type='PIVL_TS']
 Example
Every 4 hours
<effectiveTime xsi:type="PIVL_TS" institutionSpecified="false">
  <period value="4" unit="h"/></effectiveTime>
 Example
Twice a day
<effectiveTime xsi:type="PIVL_TS" institutionSpecified="true">
  <period value="12" unit="h"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:effectiveTime
EIVL_TS0 … 1CEvent Related Time Interval(UVS...ion)
where [@xsi:type='EIVL_TS']
 Example
After meal
<effectiveTime xsi:type="EIVL_TS">
  <event code="PC" codeSystem="2.16.840.1.113883.5.139"/></effectiveTime>
 Example
One hour before breakfast
<effectiveTime xsi:type="EIVL_TS">
  <event code="ACM" codeSystem="2.16.840.1.113883.5.139"/>  <offset>
    <low value="1" unit="h"/>  </offset>
</effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:event
EIVL.event0 … 1C(UVS...ion)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@code
cs0 … 1 
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10706 TimingEvent (DYNAMIC)
Treeblank.pngTreetree.pnghl7:effectiveTime
SXPR_TS0 … 1RCombined Time Interval(UVS...ion)
where [@xsi:type='SXPR_TS']
Treetree.pnghl7:doseQuantity
IVL_PQ0 … 1RThe doseQuantity describes the amount of the medication given (the dosage).

If a dose range is given (e.g., 1-2 tablets, or 325-750mg), then the <low> and <high> bounds are specified in their respective elements; otherwise only one physical quantity is specified (e.g. 2 drops)

The dose can be in some known and measurable unit, such as grams, milligrams,or described in "administration" units (unit of presentation, such as capsules).

If the dose is in countable items (tablets, caplets, "eaches"), then the unit could be omitted or valorized using the UCUM annotations for describing the type of countable items (e.g. .{tablet}, {puff},..).

The unit attribute – when expresses unit of measures- shall be derived from the UCUM code system.
The used elements should contain a <translation> element that provides a reference to the originalText found in the narrative body of the document.
(UVS...ion)
Treeblank.pngTreetree.png@unit
cs0 … 1 
 Example
Not pre-coordinated consumable
<doseQuantity value="25" unit="mg"/>
 Example
Pre-coordinated consumable - Dose Range
<doseQuantity>
  <low value="1" unit="{tablet}"/>  <high value="2" unit="{tablet}"/></doseQuantity>
 Example
Pre-coordinated consumable
<doseQuantity value="2" unit="{puff}"/>
 Example
Pre-coordinated consumable with text reference
<doseQuantity value="2" unit="{puff}">
  <translation>
    <originalText>
      <reference value="#text-ref-1"/>    </originalText>
  </translation>
</doseQuantity>
 Example
Textual dosage
<doseQuantity nullFlavor="OTH">
  <translation>
    <originalText>
      <reference value="#text-ref-1"/>    </originalText>
  </translation>
</doseQuantity>
Treetree.pnghl7:rateQuantity
IVL_PQ0 … 1(UVS...ion)
Treetree.pnghl7:maxDoseQuantity
RTO_PQ_PQ0 … 1(UVS...ion)
Treetree.pnghl7:administrationUnitCode
CE0 … 1(UVS...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.14570 AdministrableDrugForm (DYNAMIC)
Treetree.pnghl7:consumable
1 … 1R(UVS...ion)
Treeblank.pngTreetree.pnghl7:manufacturedProduct
1 … 1R(UVS...ion)
Treeblank.pngTreeblank.pngTreetree.pnghl7:manufactured​Material
1 … 1R(UVS...ion)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs1 … 1FNA