hl7:substanceAdministration
|
|
|
|
Prescription Item Entry Additional Template ID |
6.3..3.3 |
@classCode
|
cs |
1 … 1 |
F |
SBADM |
@moodCode
|
cs |
1 … 1 |
F |
INT |
hl7:templateId
|
II |
1 … 1 |
M |
CH-PHARM Prescription Item Entry Content Module |
6.3..3.3 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.4.43 |
hl7:templateId
|
II |
1 … 1 |
M |
Prescription Item Entry TemplateID |
6.3..3.2 |
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.9.1.3.2 |
hl7:templateId
|
II |
1 … 1 |
M |
CCD |
6.3..3.3 |
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.10.20.1.24 |
hl7:templateId
|
II |
1 … 1 |
M |
PCC Medication Entry Content Module |
6.3..3.3 |
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.4.7 |
Choice |
1 … |
|
Prescription Item Entry Additional Template ID Elements to choose from:
- hl7:templateId[@root='1.3.6.1.4.1.19376.1.5.3.1.4.7.1']
- hl7:templateId[@root='1.3.6.1.4.1.19376.1.5.3.1.4.8']
- hl7:templateId[@root='1.3.6.1.4.1.19376.1.5.3.1.4.9']
|
hl7:templateId
|
II |
0 … 1 |
|
A normal substanceAdministration act that may not contain any subordinate substanceAdministration
acts.
|
6.3..3.3 |
where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.7.1'] |
|
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.4.7.1 |
hl7:templateId
|
II |
0 … 1 |
|
A substanceAdministration act that records tapered dose information in subordinate. |
6.3..3.3 |
where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.8'] |
|
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.4.8 |
hl7:templateId
|
II |
0 … 1 |
|
A substanceAdministration act that records split dose information in subordinate substanceAdministration
acts.
|
6.3..3.3 |
where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.9'] |
|
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.4.9 |
hl7:id
|
|
1 … 1 |
M |
This ID represents the Prescription Item ID and SHALL be present. |
6.3..3.4 |
hl7:text
|
|
1 … 1 |
M |
Narrative Text |
6.3..3.6 |
hl7:reference
|
|
1 … 1 |
M |
This element SHALL be present. The URI given in the value attribute of the reference
element points to an element in the narrative content that contains the complete text
describing the medication dispensed.
|
6.3..3.6 |
hl7:statusCode
|
|
1 … 1 |
M |
|
6.3..3.7 |
@code
|
|
1 … 1 |
F |
completed |
Included |
|
|
from 2.16.756.5.30.1.1.10.4.35 Dosage Instructions Start/Stop, Frequency, Dose (DYNAMIC)
|
hl7:effectiveTime
|
IVL_TS.CH.TZ |
0 … 1 |
|
Dosage Instructions PCC 6.3.4.16.10 - Start and Stop |
6.3..3.8 |
where [@xsi:type='IVL_TS'] |
|
|
|
hl7:low
|
TS.CH.TZ |
1 … 1 |
R |
Start of Treatment. If Start of Treatment is unknown this element SHALL be set to
null flavor "UNK".
|
6.3..3.8 |
@nullFlavor
|
cs |
0 … 1 |
F |
UNK |
@value
|
ts |
0 … 1 |
|
|
|
Schematron assert |
role |
error
|
|
|
test |
(not(@nullFlavor) and @value) or (@nullFlavor and not(@value)) |
|
|
Message |
Either @value or @nullFlavor attribute shall be set. |
|
hl7:high
|
TS.CH.TZ |
1 … 1 |
R |
End of Treatment. If End of Treatment is unknown this element SHALL be set to null
flavor "UNK".
|
6.3..3.8 |
@nullFlavor
|
cs |
0 … 1 |
F |
UNK |
@value
|
ts |
0 … 1 |
|
|
|
Schematron assert |
role |
error
|
|
|
test |
(not(@nullFlavor) and @value) or (@nullFlavor and not(@value)) |
|
|
Message |
Either @value or @nullFlavor attribute shall be set. |
|
hl7:effectiveTime
|
EIVL_TS |
0 … 1 |
|
Dosage Instructions PCC 6.3.4.16.12 - Frequency: Event based time interval, where
the event is not a precise time, but is used for timing purposes (e.g., with meals,
between meals, before breakfast, before sleep).
|
6.3..3.8 |
where [@operator='A' and @xsi:type='EIVL_TS'] |
|
|
|
@operator
|
cs |
1 … 1 |
F |
A |
hl7:event
|
CS |
1 … 1 |
M |
|
6.3..3.8 |
@code
|
cs |
1 … 1 |
R |
|
|
CONF |
|
hl7:effectiveTime
|
SXPR_TS |
0 … 1 |
|
Dosage Instructions PCC 6.3.4.16.12 - Frequency: Multiple events within a day with
the same dosage
|
6.3..3.8 |
where [@operator='A' and @xsi:type='SXPR_TS'] |
|
|
|
@operator
|
cs |
1 … 1 |
F |
A |
@xsi:type
|
cs |
1 … 1 |
F |
SXPR_TS |
hl7:comp
|
|
1 … * |
M |
|
6.3..3.8 |
where [@xsi:type='EIVL_TS'] |
|
@xsi:type
|
cs |
1 … 1 |
F |
EIVL_TS |
hl7:event
|
CS |
1 … 1 |
M |
|
6.3..3.8 |
@code
|
cs |
1 … 1 |
R |
|
|
CONF |
|
hl7:comp
|
|
1 … * |
M |
|
6.3..3.8 |
where [@operator='I' and @xsi:type='EIVL_TS'] |
|
@operator
|
cs |
1 … 1 |
F |
I |
@xsi:type
|
cs |
1 … 1 |
F |
EIVL_TS |
hl7:event
|
CS |
1 … 1 |
M |
|
6.3..3.8 |
@code
|
cs |
1 … 1 |
R |
|
|
CONF |
|
hl7:repeatNumber
|
|
0 … 1 |
|
Number of repeats/refills. Either the @value or @nullFlavor attribute shall be set.
It's required in MTP, PRE and PADV (changed MTP, changed/recommended PRE) items ;
forbidden in DIS and PADV (changed dosage instructions) items.
|
6.3..3.9 |
|
|
@value
|
cs |
0 … 1 |
|
A value of 0 (zero) means that no repeat/refill is allowed, a positive value sets
the number of maximum repeats/refills (so the total number of dispenses could equal
this value plus one, as the first dispense is not counted). A negative value is forbidden.
|
@nullFlavor
|
cs |
0 … 1 |
F |
NI |
|
The NI null flavor means that unlimited repeats/refills are allowed.
|
|
Schematron assert |
role |
error
|
|
|
test |
not(@value) or @value >= 0 |
|
|
Message |
The value shall not be negative |
|
|
Schematron assert |
role |
error
|
|
|
test |
(not(@value) and @nullFlavor) or (@value and not(@nullFlavor)) |
|
|
Message |
Either the @value or @nullFlavor attribute shall be set |
|
hl7:routeCode
|
CE (required) |
0 … 1 |
|
|
6.3..3.3 |
|
|
|
CONF |
The value of @code shall be drawn from value set 2.16.756.5.30.1.1.11.2 RouteOfAdministration (EDQM) (DYNAMIC)
|
|
hl7:approachSiteCode
|
CD |
0 … * |
|
|
6.3..3.3 |
hl7:doseQuantity
|
IVL_PQ |
0 … 1 |
|
|
6.3..3.3 |
|
|
@unit
|
cs |
1 … 1 |
R |
|
|
CONF |
|
@value
|
real |
1 … 1 |
R |
|
hl7:rateQuantity
|
IVL_PQ |
0 … 1 |
|
|
6.3..3.3 |
hl7:repeatNumber
|
|
1 … 1 |
M |
Number of repeats/refills |
6.3..3.9 |
hl7:consumable
|
|
1 … 1 |
|
|
6.3.3.10 |
hl7:manufacturedProduct
|
|
1 … 1 |
M |
|
6.3.3.10 |
hl7:templateId
|
II |
1 … 1 |
M |
|
6.3..3.1 |
where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.7.2'] |
|
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.4.7.2 |
hl7:templateId
|
II |
1 … 1 |
M |
|
6.3..3.1 |
where [@root='2.16.840.1.113883.10.20.1.53'] |
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.10.20.1.53 |
Included |
1 … 1 |
M |
from 2.16.756.5.30.1.1.10.4.33 Manufactured Material Entry Content Module (DYNAMIC)
|
hl7:manufacturedMaterial
|
|
1 … 1 |
M |
|
6.3.3.10 |
@classCode
|
cs |
0 … 1 |
F |
MMAT |
@determinerCode
|
cs |
0 … 1 |
F |
KIND |
hl7:templateId
|
II |
1 … 1 |
M |
CH-PHARM Manufactured Material Content Module |
6.3.3.10 |
@root
|
uid |
1 … 1 |
F |
2.16.756.5.30.1.1.10.4.33 |
hl7:templateId
|
II |
1 … 1 |
M |
|
6.3.3.10 |
@root
|
uid |
1 … 1 |
F |
1.3.6.1.4.1.19376.1.9.1.3.1 |
hl7:code
|
CE |
1 … 1 |
R |
Must support. The element SHALL be present and describes the code of the medication package (GTIN)
or the drug classification (WHO ATC). The @nullFlavor "NA" for magistral preparations
is currently disallowed.
|
6.3.3.10 |
|
|
@nullFlavor
|
cs |
0 |
NP |
NP/not present |
@code
|
cs |
1 … 1 |
R |
|
@codeSystem
|
oid |
1 … 1 |
R |
GTIN (2.51.1.1) or ATC (2.16.840.1.113883.6.73). |
|
CONF |
@codeSystem shall be "2.51.1.1" |
or |
@codeSystem shall be "2.16.840.1.113883.6.73" |
|
hl7:originalText
|
ED |
0 … 1 |
|
|
6.3.3.10 |
hl7:reference
|
TEL |
1 … 1 |
R |
|
6.3.3.10 |
@nullFlavor
|
cs |
0 … 1 |
F |
NA |
|
Schematron assert |
role |
error
|
|
|
test |
(@code and @codeSystem) or (@nullFlavor='NA') |
|
|
Message |
Either a code with its code system or nullFlavor='NA' is required. |
|
hl7:name
|
EN |
1 … 1 |
R |
Must support. The element SHALL contain the name of the medication.
|
IHE PHARM PRE 6.3.4.1.3.4 |
|
|
@nullFlavor
|
cs |
0 |
NP |
NP/not present |
pharm:formCode
|
CE |
0 … 1 |
|
This code represents the pharmaceutical dose form (e.g., tablet, capsule, liquid)
and SHOULD be present, if not implied by the product.
|
6.3.3.10 |
|
|
|
CONF |
The value of @code shall be drawn from value set 2.16.756.5.30.1.1.11.3 Pharmaceutical Dose Form (EDQM) (DYNAMIC)
|
|
hl7:lotNumberText
|
ST |
0 … 1 |
|
|
IHE PHARM PRE 6.3.4.1.3.6 |
|
|
pharm:expirationTime
|
TS.CH.TZ |
0 … 1 |
|
|
IHE PHARM PRE 6.3.4.1.3.7 |
@value
|
|
1 … 1 |
R |
|
pharm:asContent
|
|
0 … 1 |
|
|
IHE PHARM PRE 6.3.4.1.3.8 |
@classCode
|
cs |
1 … 1 |
F |
CONT |
pharm:containerPackagedMedicine
|
|
1 … 1 |
M |
packaging of the medication |
IHE PHARM PRE 6.3.4.1.3.8 |
@classCode
|
cs |
1 … 1 |
F |
CONT |
@determinerCode
|
cs |
1 … 1 |
F |
INSTANCE |
pharm:code
|
CE |
0 … 1 |
|
Must support. In case the medicine describes a product, the GTIN code of the medication package
SHOULD be specified. If set, it shall be the same as the hl7:code.
|
IHE PHARM PRE 6.3.4.1.3.8 |
|
|
|
Variable let |
Name |
gtin |
|
|
Value |
./@code |
|
|
Schematron assert |
role |
error
|
|
|
test |
not(../../../hl7:code[@codeSystem = '2.51.1.1']) or ../../../hl7:code[@code = $gtin] |
|
|
Message |
If set, the GTIN shall be the same as the medication product. |
|
pharm:name
|
TN |
0 … 1 |
|
Must support. In case the package describes a product, and the package has a brand name, it SHOULD
be described.
|
IHE PHARM PRE 6.3.4.1.3.8 |
|
|
pharm:formCode
|
CE |
0 … 1 |
|
|
IHE PHARM PRE 6.3.4.1.3.8 |
|
|
pharm:capacityQuantity
|
PQ |
0 … 1 |
|
Must support. The element SHOULD be present and describes the capacity of the packaging.
|
IHE PHARM PRE 6.3.4.1.3.8 |
|
|
@nullFlavor
|
cs |
0 |
NP |
NP/not present |
@unit
|
cs |
1 … 1 |
R |
|
|
CONF |
|
@value
|
|
1 … 1 |
R |
|
pharm:ingredient
|
|
0 … * |
|
One or more active ingredients SHOULD be represented with this structure. |
6.3.3.10 |
@classCode
|
cs |
1 … 1 |
F |
ACTI |
pharm:quantity
|
RTO_PQ_PQ |
0 … 1 |
|
The medication strength is represented as the ratio of the active ingredient(s) to
a unit of medication
|
6.3.3.10 |
|
|
hl7:numerator
|
PQ |
1 … 1 |
M |
|
6.3.3.10 |
@unit
|
cs |
1 … 1 |
R |
|
|
CONF |
|
@value
|
real |
1 … 1 |
R |
|
hl7:denominator
|
PQ |
1 … 1 |
M |
|
6.3.3.10 |
@unit
|
cs |
1 … 1 |
R |
|
|
CONF |
|
@value
|
real |
1 … 1 |
R |
|
pharm:ingredient
|
|
1 … 1 |
R |
Ingredients SHALL be coded with SNOMED CT. |
6.3.3.10 |
@classCode
|
cs |
1 … 1 |
F |
MMAT |
@determinerCode
|
cs |
1 … 1 |
F |
KIND |
pharm:code
|
CE |
0 … 1 |
|
|
6.3.3.10 |
|
|
@code
|
cs |
1 … 1 |
R |
|
|
CONF |
|
@codeSystem
|
oid |
1 … 1 |
F |
2.16.840.1.113883.6.96 |
@codeSystemName
|
st |
1 … 1 |
F |
SNOMED CT |
pharm:name
|
TN |
1 … 1 |
R |
|
6.3.3.10 |
|
|
hl7:author
|
|
0 … 1 |
|
Prescriber |
6.3.3.11 |
hl7:time
|
|
1 … 1 |
M |
|
6.3.3.11 |
hl7:author
|
|
0 … 1 |
|
Community Prescription document author |
6.3.3.12 |
hl7:time
|
|
1 … 1 |
M |
|
6.3.3.12 |
Included |
|
|
from 2.16.756.5.30.1.1.10.4.36 Dosage Instructions Related Components (DYNAMIC)
|
hl7:entryRelationship
|
|
0 … * |
|
Dosage Instructions PCC 6.3.4.16.20 - Related components |
IHE PCC 6.3.4.16.20 |
where [@typeCode='COMP' and hl7:substanceAdministration and (../hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.8']
or ../hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.10'] or ../hl7:templateId
[@root='1.3.6.1.4.1.19376.1.5.3.1.4.9'] or ../hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.11'])
and not(hl7:substanceAdministration/hl7:templateId)] |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:sequenceNumber
|
INT |
1 … 1 |
M |
|
IHE PCC 6.3.4.16.20 |
hl7:substanceAdministration
|
|
1 … 1 |
M |
For split, tapered or conditional dosing, the subordinate component shall specify
only the changed <frequency> and/or <doseAmount> elements.
|
IHE PCC 6.3.4.16.20 |
@moodCode
|
cs |
1 … 1 |
R |
INT for an intent or EVN for an event. |
@classCode
|
cs |
1 … 1 |
F |
SBADM |
hl7:effectiveTime
|
EIVL_TS |
0 … 1 |
|
timing purpose |
IHE PCC 6.3.4.16.20 |
where [@xsi:type='EIVL_TS'] |
|
@xsi:type
|
cs |
1 … 1 |
F |
EIVL_TS |
hl7:event
|
CS |
1 … 1 |
M |
|
IHE PCC 6.3.4.16.20 |
@code
|
cs |
1 … 1 |
R |
|
|
CONF |
|
hl7:doseQuantity
|
IVL_PQ |
0 … 1 |
|
|
IHE PCC 6.3.4.16.20 |
@unit
|
cs |
1 … 1 |
R |
|
|
CONF |
|
@value
|
cs |
1 … 1 |
R |
|
hl7:rateQuantity
|
IVL_PQ |
0 … 1 |
|
|
IHE PCC 6.3.4.16.20 |
hl7:consumable
|
|
1 … 1 |
M |
|
IHE PCC 6.3.4.16.20 |
hl7:manufacturedProduct
|
|
1 … 1 |
M |
|
IHE PCC 6.3.4.16.20 |
hl7:manufacturedMaterial
|
|
1 … 1 |
R |
|
IHE PCC 6.3.4.16.20 |
@nullFlavor
|
cs |
1 … 1 |
F |
NA |
hl7:entryRelationship
|
|
0 … 1 |
|
Treatment Reason as text Contains 2.16.756.5.30.1.1.10.4.41 Treatment Reason Entry Content Module (DYNAMIC)
|
6.3..3.3 |
where [hl7:observation] |
|
@typeCode
|
cs |
1 … 1 |
F |
RSON |
hl7:entryRelationship
|
|
0 … 1 |
|
Reference to Medication Treatment Plan Item. If the Prescription Item is related to
a Medication Treatment Plan Item, the reference to it SHALL be present. Contains 2.16.756.5.30.1.1.10.4.45 MTP Reference Entry Content Module (DYNAMIC)
|
6.3.3.14 |
where [@typeCode='REFR'] |
|
@typeCode
|
cs |
1 … 1 |
F |
REFR |
hl7:entryRelationship
|
|
0 … 1 |
|
Patient Medication Instructions Contains 1.3.6.1.4.1.19376.1.5.3.1.4.3 IHE Patient Medication Instructions (DYNAMIC)
|
IHE PHARM PRE 6.3.4.2.3.16 |
where [hl7:act [hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.3']]] |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:entryRelationship
|
|
0 … 1 |
|
Fulfillment Instructions |
6.3.3.17 |
where [hl7:act [hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.3.1']]] |
|
@typeCode
|
|
1 … 1 |
F |
SUBJ |
@inversionInd
|
|
1 … 1 |
F |
true |
hl7:act
|
|
|
|
|
6.3.3.17 |
hl7:templateId
|
II |
1 … 1 |
M |
|
6.3.3.17 |
@root
|
|
1 … 1 |
F |
1.3.6.1.4.1.19376.1.5.3.1.4.3.1 |
hl7:entryRelationship
|
|
0 … 1 |
|
Amount of units of the consumable to dispense Contains 2.16.756.5.30.1.1.10.4.38 Prescribed Quantity Entry Content Module (DYNAMIC)
|
6.3.3.18 |
where [hl7:supply [hl7:templateId [@root='1.3.6.1.4.1.19376.1.9.1.3.8']]] |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:entryRelationship
|
|
0 … * |
|
Substitution permission Contains 1.3.6.1.4.1.19376.1.9.1.3.9.1 IHE Substitution Permission Content Module (DYNAMIC)
|
6.3.3.19 |
where [hl7:observation [hl7:templateId [@root='1.3.6.1.4.1.19376.1.9.1.3.9.1']]] |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:entryRelationship
|
|
0 … 1 |
|
Renewal Period Contains 1.3.6.1.4.1.19376.1.9.1.3.15 IHE Renewal Period Content Module (DYNAMIC)
|
6.3.3.20 |
where [hl7:supply [hl7:templateId [@root='1.3.6.1.4.1.19376.1.9.1.3.15']]] |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:entryRelationship
|
|
0 … 1 |
|
Contains 2.16.756.5.30.1.1.10.4.52 Dosage Instructions Non Structured Entry Content Module (DYNAMIC)
|
6.3..3.3 |
where [hl7:substanceAdministration [hl7:templateId [@root='2.16.756.5.30.1.1.10.4.52']]] |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:entryRelationship
|
|
0 … 1 |
|
Contains 2.16.756.5.30.1.1.10.4.37 Dosage Intake Mode Entry Content Module (DYNAMIC)
|
6.3..3.3 |
where [hl7:substanceAdministration [hl7:templateId [@root='2.16.756.5.30.1.1.10.4.37']]] |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:entryRelationship
|
|
0 … 1 |
|
Contains 2.16.756.5.30.1.1.10.4.2 Annotation Comments (DYNAMIC)
|
6.3..3.3 |
where [hl7:act [hl7:templateId [@root='2.16.756.5.30.1.1.10.4.2']]] |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:reference
|
|
0 … * |
|
|
6.3.3.21 |
@typeCode
|
|
1 … 1 |
F |
XCRPT |
hl7:externalDocument
|
|
1 … 1 |
|
|
6.3.3.21 |
hl7:id
|
|
1 … * |
|
|
6.3.3.21 |
hl7:precondition
|
|
0 … 1 |
|
Precondition Criterion |
6.3.3.22 |
hl7:criterion
|
|
1 … 1 |
|
|
6.3.3.22 |
hl7:text
|
|
1 … 1 |
|
|
6.3.3.22 |
hl7:reference
|
|
1 … 1 |
|
|
6.3.3.22 |
@value
|
|
1 … 1 |
R |
|