Template 2.16.840.1.113883.10.22.4.33 - IPSSubordinateSubstanceAdministration

Template IPS Subordinate SubstanceAdministration

Id 2.16.840.1.113883.10.22.4.33 Effective Date 2017‑06‑15

Status Under pre-publication review Version Label STU1

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)

Associated with

Associated with 3 concepts

Used by / Uses

Used by 0 transactions and 3 templates, Uses 0 templates

Relationship Specialization: template 2.16.840.1.113883.10.21.4.6 (DYNAMIC)

Example

<hl7:substanceAdministration classCode="SBADM" moodCode="EVN"> <hl7:templateId root="2.16.840.1.113883.10.22.4.33"/> <hl7:statusCode code="active"/>  <hl7:effectiveTime xsi:type="PIVL_TS" institutionSpecified="true"> <hl7:period value="12" unit="h"/> </hl7:effectiveTime> <hl7:doseQuantity xsi:type="IVL_PQ" value="2" unit="{puff}"/> <hl7:consumable> <hl7:manufacturedProduct> <hl7:manufacturedMaterial nullFlavor="NA"/> </hl7:manufacturedProduct> </hl7:consumable></hl7:substanceAdministration>

Item DT Card Conf Description Label

hl7:substanceAdministration IPSSBADM


	hl7ips-dataelement-119	Dose Instruction	CEN/TC 251 prEN 17269

@classCode cs 1 … 1 F SBADM

@moodCode cs 1 … 1 R If the statement refers to a prescribed medication then a 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 IPSSBADM

@root uid 1 … 1 F 2.16.840.1.113883.10.22.4.33

hl7:statusCode CS 1 … 1 M IPSSBADM

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" IPSSBADM

where [@value or @nullFlavor]


	hl7ips-dataelement-224	Frequency of intake	CEN/TC 251 prEN 17269

Example

Once (known date)

<effectiveTime value="20170404"/>

Example

Unknown

<effectiveTime nullFlavor="UNK"/>

hl7:effectiveTime PIVL_TS 0 … 1 C IPSSBADM

where [@xsi:type='PIVL_TS']


	hl7ips-dataelement-224	Frequency of intake	CEN/TC 251 prEN 17269

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 IPSSBADM

where [@xsi:type='EIVL_TS']


	hl7ips-dataelement-224	Frequency of intake	CEN/TC 251 prEN 17269

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 IPSSBADM

@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 IPSSBADM

where [@xsi:type='SXPR_TS']


	hl7ips-dataelement-224	Frequency of intake	CEN/TC 251 prEN 17269

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


	hl7ips-dataelement-223	Number of units per intake	CEN/TC 251 prEN 17269

@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 IPSSBADM

hl7:consumable 1 … 1 R IPSSBADM

hl7:manufacturedProduct 1 … 1 R IPSSBADM

hl7:manufacturedMaterial 1 … 1 R IPSSBADM

@nullFlavor cs 1 … 1 F NA

Template IPS Subordinate SubstanceAdministration