Back To Index  <<  Back To Templates

ref Template  IPS Subordinate SubstanceAdministration

Id 2.16.840.1.113883.10.22.4.33 Effective Date valid from 2017‑06‑15
Status draft Draft Version Label
Name IPSSubordinateSubstanceAdministration Display Name IPS Subordinate SubstanceAdministration
Description This entry is used by a main substanceAdministration act to provide dosage information as the frequency of intakes or the amount of the medication given.
Context Parent nodes of template element with id 2.16.840.1.113883.10.22.4.33
Label IPSSubordSBADM
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 3 templates, Uses 0 templates
Used by as Name Version
2.16.840.1.113883.10.22.4.4 Containment draft IPS Medication Entry 2016‑11‑11
2.16.840.1.113883.10.22.3.1 link draft IPS Medication Summary Section 2016‑11‑11
2.16.840.1.113883.10.22.1.1 link draft International Patient Summary 2017‑04‑11
Relationship Specialization: template 2.16.840.1.113883.10.12.308 (2005‑09‑07)
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.22.4.33"/>  <statusCode code="completed"/>  <!-- choice: 1..1
element hl7:effectiveTime[@value or @nullFlavor]
element hl7:effectiveTime[@xsi:type='PIVL_TS']
element hl7:effectiveTime[@xsi:type='EIVL_TS']
element hl7:effectiveTime[@xsi:type='SXPR_TS']
-->
  <doseQuantity unit="cs">
    <low value="1"/>  </doseQuantity>
  <rateQuantity>
    <low value="1"/>  </rateQuantity>
  <consumable>
    <manufacturedProduct>
      <manufacturedMaterial nullFlavor="NA"/>    </manufacturedProduct>
  </consumable>
</substanceAdministration>
Item DT Card Conf Description Label
hl7:substanceAdministration
IPSS…BADM
@classCode
cs 1 … 1 F SBADM
@moodCode
cs 1 … 1 R If the statement refers to a prescribed medication then a <substanceAdministration> intent (moodCode='INT') is used; otherwise, to record medications which are stated to have taken, the moodCode shall be set to 'EVN'.
  CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.20.9.18 MoodCodeEvnInt (DYNAMIC)
  Constraint The moodCode of this subordinate <substanceAdministration> SHALL be the same of the parent <substanceAdministration> .
hl7:templateId
II 1 … 1 M IPSS…BADM
@root
uid 1 … 1 F 2.16.840.1.113883.10.22.4.33
hl7:statusCode
CS 1 … 1 M IPSS…BADM
  Constraint The statusCode of this subordinate <substanceAdministration> SHALL be the same of that of the parent <substanceAdministration>.
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.12 ActStatusActiveCompletedAbortedSuspended (2017‑03‑30)
  Example <statusCode code="active"/>
Choice 1 … 1 Elements 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']
hl7:effectiveTime
TS 0 … 1 C This required element describes the frequency of intakes. If not known it shall be valued with the nullflavor "UNK"
IPSS…BADM
treeblank treeblank where [@value or @nullFlavor]
  Example
Once (known date)
<effectiveTime value="20170404"/>
  Example
Unknown
<effectiveTime nullFlavor="UNK"/>
hl7:effectiveTime
PIVL_TS 0 … 1 C IPSS…BADM
treeblank treeblank 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>
hl7:effectiveTime
EIVL_TS 0 … 1 C IPSS…BADM
treeblank treeblank 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>
hl7:event
EIVL.event 0 … 1 C IPSS…BADM
@code
cs 0 … 1  
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10706 TimingEvent (DYNAMIC)
hl7:effectiveTime
SXPR_TS 0 … 1 R IPSS…BADM
treeblank treeblank where [@xsi:type='SXPR_TS']
hl7:doseQuantity
IVL_PQ 0 … 1 R The <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.

IPSS…BADM
@unit
cs 0 … 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>
hl7:rateQuantity
IVL_PQ 0 … 1 IPSS…BADM
hl7:consumable
1 … 1 R IPSS…BADM
hl7:manufacturedProduct
1 … 1 R IPSS…BADM
hl7:manufacturedMaterial
1 … 1 R IPSS…BADM
@nullFlavor
cs 1 … 1 F NA