| Name | Flags | Card. | Type |
Description & Constraints
|
|---|---|---|---|---|
SubstanceAdministration
|
CDAR2.SubstanceAdministration |
XML Namespace:
urn:hl7-org:v3 This logical model cannot be the target of a reference |
||
classCode
|
1..1 | |||
|
moodCode
|
1..1 | Binding: MoodCodeEvnInt ( required ) | ||
Slices for templateId
|
1 .. | Slice: Unordered, Open by value:root, value:extension | ||
templateId:primary
|
1..1 | |||
root
|
1..1 | Required Pattern: 2.16.840.1.113883.10.20.22.4.52 | ||
extension
|
1..1 | Required Pattern: 2015-08-01 | ||
|
id
|
1..* | |||
|
code
|
0..1 | SubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set. | ||
|
negationInd
|
1..1 | Use negationInd="true" to indicate that the immunization was not given. | ||
|
statusCode
|
1..1 | |||
code
|
1..1 | Binding: ActStatus ( required ) | ||
|
effectiveTime
|
1..1 | |||
|
repeatNumber
|
0..1 | In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. | ||
|
routeCode
|
0..1 | Binding: SPL Drug Route of Administration Terminology ( required ) | ||
|
translation
|
0..* |
Binding:
Medication Route
( required
) |
||
|
approachSiteCode
|
0..1 | Binding: Body Site Value Set ( required ) | ||
|
doseQuantity
|
0..1 | |||
|
unit
|
0..1 | Binding: UnitsOfMeasureCaseSensitive ( required ) | ||
|
administrationUnitCode
|
0..1 | Binding: AdministrationUnitDoseForm ( required ) | ||
|
consumable
|
1..1 | |||
manufacturedProduct
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct | ||
|
performer
|
0..1 | |||
|
author
|
0..* | http://hl7.org/cda/stds/core/StructureDefinition/Author | ||
|
Slices for participant
|
Slice: Unordered, Open by value:typeCode, profile:participantRole | |||
|
participant:drugVehicle
|
0..* | |||
|
typeCode
|
1..1 | Fixed Value: CSM | ||
|
participantRole
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole | ||
|
Slices for entryRelationship
|
Slice: Unordered, Open by profile:act, profile:observation, profile:supply | |||
entryRelationship:indication
|
0..* | |||
typeCode
|
1..1 | Fixed Value: RSON | ||
|
observation
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/Observation | ||
|
entryRelationship:instruction
|
0..1 | |||
|
typeCode
|
1..1 | Fixed Value: SUBJ | ||
|
inversionInd
|
1..1 | Fixed Value: true | ||
|
act
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/Act | ||
|
entryRelationship:medSupplyOrder
|
0..1 | |||
|
typeCode
|
1..1 | Fixed Value: REFR | ||
|
supply
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/Supply | ||
|
entryRelationship:medDispense
|
0..1 | |||
|
typeCode
|
1..1 | Fixed Value: REFR | ||
|
supply
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/Supply | ||
|
entryRelationship:reactionObs
|
0..1 | |||
|
typeCode
|
1..1 | Fixed Value: CAUS | ||
|
observation
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/Observation | ||
|
entryRelationship:immunizationRefusal
|
0..1 | |||
|
typeCode
|
1..1 | Fixed Value: RSON | ||
|
observation
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/Observation | ||
|
entryRelationship:substanceAdmin
|
0..* |
The following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series. |
||
|
typeCode
|
1..1 | Fixed Value: COMP | ||
|
inversionInd
|
1..1 | Fixed Value: true | ||
|
sequenceNumber
|
0..1 | |||
|
act
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/Act | ||
|
Slices for precondition
|
Slice: Unordered, Open by profile:criterion | |||
|
precondition:substanceAdmin
|
0..* | |||
|
typeCode
|
1..1 | Fixed Value: PRCN | ||
|
criterion
|
1..1 | http://hl7.org/cda/stds/core/StructureDefinition/Criterion | ||
|
Documentation for this format
|
||||