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 |
|
| |
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 |
|
| |
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] |
|
|
| |
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'] |
|
|
| |
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'] |
|
|
| |
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 |
|
hl7:effectiveTime
|
SXPR_TS |
0 … 1 |
R |
|
IPSSBADM |
|
|
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.
|
IPSSBADM |
@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
Draft
