Item | DT | Card | Conf | Description | Label |
---|
hl7:substanceAdministration
| | | R | | 6.3..3.1 |
@classCode
| cs | 1 … 1 | F | SBADM |
@moodCode
| cs | 1 … 1 | F | EVN |
hl7:templateId
| II | 1 … 1 | M | CCD templateId | 6.3..3.2 |
where [@root='2.16.840.1.113883.10.20.1.24'] | |
@root
| uid | 1 … 1 | F | 2.16.840.1.113883.10.20.1.24 |
hl7:templateId
| II | 1 … 1 | R | IHE PCC templateId | 6.3..3.2 |
@root
| uid | 1 … 1 | F | 1.3.6.1.4.1.19376.1.5.3.1.4.7 |
hl7:templateId
| II | 1 … 1 | R | | 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 | 1 … 1 | M | | 6.3..3.2 |
@root
| uid | 1 … 1 | F | 1.3.6.1.4.1.19376.1.9.1.3.16 |
hl7:id
| II | 1 … 1 | M | | 6.3..3.4 |
hl7:code
| CD | 1 … 1 | R | | 6.3..3.5 |
| CONF | @code shall be "completed" | @codeSystem shall be "2.16.840.1.113883.4.642.1.101" | @codeSystemName shall be "HL7 EventStatus" | or | @code shall be "aborted" | @codeSystem shall be "2.16.840.1.113883.4.642.1.101" | @codeSystemName shall be "HL7 EventStatus" | or | @code shall be "in-progress" | @codeSystem shall be "2.16.840.1.113883.4.642.1.101" | @codeSystemName shall be "HL7 EventStatus" |
|
hl7:text
| ED | 1 … 1 | R | | 6.3..3.6 |
hl7:reference
| | 1 … 1 | R | | 6.3..3.6 |
hl7:statusCode
| CS | 1 … 1 | M | | 6.3..3.7 |
@code
| CONF | 1 … 1 | F | completed |
hl7:effectiveTime
| IVL_TS | 1 … 1 | R | The first <effectiveTime> element, indicating the start and stop time of the medication regimen according to the parent IHE PCC Medications template (1.3.6.1.4.1.19376.1.5.3.1.4.7), SHALL be present and represent the time of the administration depending on the administration type: • “Single point of time” administration • “Simple interval” administration • “Complex interval” administration Note: See Volume 1 of this profile for further information on administration types. In case of “single point of time” administrations, the <low> element and <high> element SHALL equally be set to the date/time of the administration. In case of “interval” administrations (simple or complex), the <low> and <high> element indicate the start and stop date/time of the administration interval documented. Note: In case of „Complex interval administrations“, this element contains the start and stop date/time of the current “partial interval” of the overall “Complex interval administration”. | 6.3..3.8 |
hl7:low
| IVXB_TS | 1 … 1 | R | | 6.3..3.8 |
hl7:high
| IVXB_TS | 1 … 1 | R | | 6.3..3.8 |
hl7:routeCode
| CE | 0 … 1 | | 6.3.4.E1.3.10 Route of Administration <routeCode code=' ' displayName=' ' codeSystem=' ' codeSystemName=' '/> This element SHALL be present IF KNOWN. Note: In case of „Complex interval administrations“, this element contains the route code of the current “partial interval” of the overall “Complex interval administration”. The constraints defined for this element in PCC TF2, Medication Entry Module (1.3.6.1.4.1.19376.1.5.3.1.4.7) specification apply to this element. | 6.3.3.10 |
hl7:approachSiteCode
| | 0 … * | | 6.3.4.E1.3.11 Approach Site Code <approachSiteCode code=' ' displayName=' ' codeSystem=' ' codeSystemName=' '> This element MAY be present. Note: In case of „Complex interval administrations“, this element contains the approach site code of the current “partial interval” of the overall “Complex interval administration”. The constraints defined for this element in PCC TF2, Medication Entry Module (1.3.6.1.4.1.19376.1.5.3.1.4.7) specification apply to this element. | 6.3.3.11 |
hl7:doseQuantity
| | 0 … 1 | | 6.3.4.E1.3.12 Dose Quantity <doseQuantity value=' ' unit=' '/> This element SHALL be present IF KNOWN. Note: In case of „Complex interval administrations“, this element contains the dose quantity of the current “partial interval” of the overall “Complex interval administration”. The constraints defined for this element in PCC TF2, Medication Entry Module (1.3.6.1.4.1.19376.1.5.3.1.4.7) specification apply to this element. | 6.3.3.12 |
hl7:rateQuantity
| | 0 … 1 | | 6.3.4.E1.3.13 Rate Quantity <rateQuantity value=' ' unit=' '/> This element SHALL be present IF KNOWN. Note: In case of „Complex interval administrations“, this element contains the rate quantity of the current “partial interval” of the overall “Complex interval administration”. The constraints defined for this element in PCC TF2, Medication Entry Module (1.3.6.1.4.1.19376.1.5.3.1.4.7) specification apply to this element. | 6.3.3.13 |
hl7:consumable
| | 1 … 1 | R | 6.3.4.E1.3.14 Consumable <consumable> <manufacturedProduct" classCode="MANU"> <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.7.2"/> <templateId root="2.16.840.1.113883.10.20.1.53"/> <manufacturedMaterial classCode="MMAT" determinerCode="KIND"> : <!-- Medicine Entry Content Module (1.3.6.1.4.1.19376.1.9.1.3.1) --> : </manufacturedMaterial> </manufacturedProduct> </consumable> The <consumable> element SHALL be present, and shall contain a medication entry, conforming to the Medicine Entry template (1.3.6.1.4.1.19376.1.9.1.3.1). The <consumable> element of a Community Medication Administration describes the medication that is administered to the patient. See PHARM-TF3, Medicine Entry Module (1.3.6.1.4.1.19376.1.9.1.3.1) specification. | 6.3.3.14 |
hl7:manufacturedProduct
| | 1 … 1 | R | Contains 1.3.6.1.4.1.19376.1.9.1.3.1 Medicine Entry Content Module (DYNAMIC) | 6.3.3.14 |
@classCode
| cs | 0 … 1 | F | MANU |
hl7:templateId
| II | 1 … 1 | M | | 6.3.3.14 |
@root
| uid | 0 … 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.14 |
@root
| uid | 0 … 1 | F | 2.16.840.1.113883.10.20.1.53 |
hl7:author
| | 0 … 1 | | 6.3.4.E1.3.15 Medication Administration Author <author>…</author> In the case that the Medication Administration Item is used within a Community Medication Administration document according to the “Community Medication Administration” (CMA) Profile this element SHALL NOT be present. In all other cases (e.g., when used in a “Community Medication List” document according to the PML Profile or in medication sections of other documents as for example Discharge Summaries, etc.) this element SHOULD be present and represent the author and timestamp of the Medication Administration Item. This first author element SHALL be present in case that the “Community Medication Administration document author” is present (see Section 6.3.4.E1.3.16). The table below shows the meaning of the data elements of this <author> element. It SHOULD be corresponding to the <author> element of the Community Medication Administration document or, if given, the <author> element of the Medication Administration section within the Community Medication Administration document. ... Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC) | 6.3.3.15 |
hl7:author
| | 0 … 1 | | 6.3.4.E1.3.16 Community Medication Administration document author <author>…</author> In the case that the Medication Administration Item is used within a Community Medication Administration document according to the “Community Medication Administration” (CMA) Profile this element SHALL NOT be present. If the author of the Community Medication Administration document is already present in the “Medication Administration Author” element (see section above) this element SHALL NOT be present. In all other cases (e.g., when used in a “Community Medication List” document according to the PML Profile or in medication sections of other documents as for example Discharge Summaries, etc.) this element MAY be present and represent the author and timestamp of the Community Medication Administration document. The table below shows the meaning of the data elements of this <author> element. It SHALL be corresponding to the <author> element of the Community Medication Administration document header. Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC) | 6.3.3.16 |
hl7:entryRelationship
| | 0 … * | | Contains 1.3.6.1.4.1.19376.1.5.3.1.4.4.1 IHE Internal Reference Entry (DYNAMIC) | 6.3.3.17 |
@typeCode
| cs | 1 … 1 | F | RSON |
| Schematron assert | role | error | |
| test | hl7:act@classCode='ACT' and hl7:act@moodCode='EVN' | |
| Message | classCode attribute SHALL have the value 'ACT' AND moodCode SHALL have the value 'EVN' | |
hl7:entryRelationship
| | 0 … 1 | | 6.3.4.E1.3.20 Fulfillment Notes <entryRelationship typeCode='SUBJ' inversionInd='true'> <act classCode='ACT' moodCode='INT'> <templateId root='2.16.840.1.113883.10.20.1.43'/> <templateId root='1.3.6.1.4.1.19376.1.5.3.1.4.3.1'/> <code code='FINSTRUCT' codeSystem='1.3.6.1.4.1.19376.1.5.3.2' codeSystemName='IHEActCode' /> ... </entryRelationship> At most one fulfillment note MAY be provided for each <substanceAdministration> entry. When present, this entry relationship SHALL contain a Medication Fulfillment Instructions (1.3.6.1.4.1.19376.1.5.3.1.4.3.1) entry. Fulfillment Notes (used in a Medication Administration Item) are comments from the administering person regarding issues happened during the administration act or up until the creation of the CMA report. Due to the nature of the Medication Fulfillment Instructions (1.3.6.1.4.1.19376.1.5.3.1.4.3.1) Content Module, these comments are limited to narrative text only. Examples: • The patient reacted on the administration by fainting • The infusion device had a minor malfunction, but was repaired without influencing the administration Note: Comments regarding the administration act about issues happening after the creation of the CMA report (e.g., an allergy to the medication recognized after the administration act, etc.) should be documented by a Pharmaceutical Advice (PADV) related to this administration. PADV may also be used for comments regarding the administration act happened during the administration act or up until the creation of the CMA report, e.g., in case narrative description of the issue is not sufficient. | 6.3.3.20 |
@inversionInd
| cs | 1 … 1 | F | true |
@typeCode
| cs | 1 … 1 | F | SUBJ |
hl7:act
| | | | | 6.3.3.20 |
@moodCode
| cs | 1 … 1 | F | INT |
@classCode
| cs | 1 … 1 | F | ACT |
hl7:templateId
| II | 1 … 1 | M | | 6.3.3.20 |
@root
| uid | 1 … 1 | F | 2.16.840.1.113883.10.20.1.43 |
hl7:templateId
| II | 1 … 1 | M | | 6.3.3.20 |
@root
| uid | 1 … 1 | F | 1.3.6.1.4.1.19376.1.5.3.1.4.3.1 |
hl7:code
| CD | 1 … 1 | R | | 6.3.3.20 |
@code
| CONF | 0 … 1 | F | FINSTRUCT |
@codeSystem
| 0 … 1 | F | 1.3.6.1.4.1.19376.1.5.3.2 |
@codeSystemName
| 0 … 1 | F | IHEActCode |
hl7:entryRelationship
| | 1 … 1 | R | 6.3.4.E1.3.21 Amount of units of the consumable administered <entryRelationship typeCode='COMP'> <supply classCode='SPLY' moodCode='RQO'> … </supply> </entryRelationship> This element SHALL be present and describes the amount of units administered. If present, it SHALL contain a quantity conforming to the Amount of units of the consumable Entry template (1.3.6.1.4.1.19376.1.9.1.3.8). See PHARM-TF3, Amount of units of the consumable Entry Module (1.3.6.1.4.1.19376.1.9.1.3.8) specification. Note: If no medication has been administered for any reason, but the act is still considered as completed (non-administration) this SHALL be recorded with the value of quantity set to zero and unit being not present. Reasons for the non-administration can be described in Fulfillment Notes. Contains 1.3.6.1.4.1.19376.1.9.1.3.8 Amount of units of the consumable Content Module (DYNAMIC) | 6.3.3.21 |
@typeCode
| cs | 1 … 1 | F | COMP |
hl7:entryrelationship
| | 0 … 1 | | 6.3.4.E1.3.22 Reference to Medication Treatment Plan Item <entryRelationship typeCode='REFR'> <substanceAdministration classCode='SBADM' moodCode='INT'> <templateId root='1.3.6.1.4.1.19376.1.9.1.3.10'/> <!-- PHARM --> … </substanceAdministration> </entryRelationship> The reference to a related Medication Treatment Plan Item SHALL be present IF KNOWN and SHALL contain a reference to a Medication Treatment Plan Item, conforming to the Reference to Medication Treatment Plan Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.10). See PHARM-TF3, Reference to Medication Treatment Plan Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.10) specification. Contains 1.3.6.1.4.1.19376.1.9.1.3.10 Reference to Medication Treatment Plan Item Entry (DYNAMIC) | 6.3.3.22 |
@typeCode
| cs | 1 … 1 | F | REFR |
hl7:entryRelationship
| | 1 … 1 | R | 6.3.4.E1.3.23 Reference to Prescription Item <entryRelationship typeCode='REFR'> <substanceAdministration classCode='SBADM' moodCode='INT'> <templateId root='1.3.6.1.4.1.19376.1.9.1.3.11'/> <!-- PHARM --> … </substanceAdministration> </entryRelationship> The reference to the Prescription Item this administration is related to SHALL be present IF KNOWN and SHALL contain a reference to a Prescription Item Entry, conforming to the Reference to Prescription Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.11). See PHARM-TF3, Reference to Prescription Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.11) specification. Contains 1.3.6.1.4.1.19376.1.9.1.3.11 Reference to Prescription Item Content Module (DYNAMIC) | 6.3.3.23 |
@typeCode
| cs | 1 … 1 | F | REFR |
hl7:entryRelationship
| | 1 … 1 | R | 6.3.4.E1.3.24 Reference to Dispense Item <entryRelationship typeCode='REFR'> <supply classCode='SPLY' moodCode='EVN'> <templateId root='1.3.6.1.4.1.19376.1.9.1.3.12'/> … </supply> </entryRelationship> The reference to the Dispense Item this administration is related to SHALL be present IF KNOWN and SHALL contain a reference to a Dispense Item, conforming to the Reference to Dispense Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.12). See PHARM-TF3, Reference to Dispense Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.12) specification. Contains 1.3.6.1.4.1.19376.1.9.1.3.12 Reference to Dispense Item Content Module (DYNAMIC) | 6.3.3.24 |
@typeCode
| cs | 1 … 1 | F | REFR |
hl7:entryRelationship
| | 1 … 1 | R | 6.3.4.E1.3.25 Reference to Pharmaceutical Advice Item <entryRelationship typeCode='REFR'> <observation classCode='OBS' moodCode='EVN'> <templateId root='1.3.6.1.4.1.19376.1.9.1.3.13'/> … </observation> </entryRelationship> An administration may be related to a Pharmaceutical Advice, which was given on one of the items on higher (e.g., PADV on underlying prescription or dispense) or equal (e.g., PADVs on previous administrations) steps of this administration act. Example: a Pharmaceutical Advice to the underlying dispense of this administration, indicating that the dosage instructions have changed since the last administration of the dispensed medication. The reference to a Pharmaceutical Advice Item this administration is related to SHOULD be present IF KNOWN and SHALL contain a reference to a Pharmaceutical Advice Item, conforming to the Reference to Pharmaceutical Advice Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.13). See PHARM-TF3, Reference to Pharmaceutical Advice Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.13) specification. Contains 1.3.6.1.4.1.19376.1.9.1.3.13 Reference to Pharmaceutical Advice Item Content Module (DYNAMIC) | 6.3.3.25 |
@typeCode
| cs | 1 … 1 | F | REFR |
hl7:entryRelationship
| | 1 … 1 | R | 6.3.4.E1.3.26 Reference to preceding Medication Administration Item <entryRelationship typeCode='REFR'> <substanceAdministration classCode='SBADM' moodCode='EVN'> <templateId root='1.3.6.1.4.1.19376.1.9.1.3.14'/> … </substanceAdministration> </entryRelationship> An administration may be related to a preceding Medication Administration Item to indicate that this “chain of administrations” shall be seen as one „complex interval” administration. For more information on the usage of this element see Use-case section of Volume 1 of this profile. The reference to a preceding Medication Administration Item this administration is related to SHALL be present IF KNOWN and SHALL contain a reference to a Medication Administration Item, conforming to the Reference to Medication Administration Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.14). See PHARM-TF3, Reference to Medication Administration Item Content Module (1.3.6.1.4.1.19376.1.9.1.3.14) specification. Contains 1.3.6.1.4.1.19376.1.9.1.3.14 Reference to Medication Administration Item Content Module (DYNAMIC) | 6.3.3.26 |
@typeCode
| cs | 1 … 1 | F | REFR |
hl7:reference
| | | NP | 6.3.4.E1.3.27 ID of parent container (Community Medication Administration document) <reference typeCode='XCRPT'> <externalDocument> <id root=' ' extension=' '/> </externalDocument> </reference> In the case that the Medication Administration Item is used within a Community Medication Administration document according to the “Community Medication Administration” (CMA) Profile this element SHALL NOT be present. In all other cases (e.g., when used in a “Community Medication List” document according to the PML Profile or in medication sections of other documents as for example Discharge Summaries, etc.) this element SHOULD be present and contain the identifier of the Community Medication Administration document, the Medication Administration Item initially has been created. | 6.3..3.1 |
| Schematron assert | role | error | |
| test | @moodCode='INT' or @moodCode='EVN' | |
| Message | moodCode attribute SHALL have the value INT or EVN | |