Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: Planned Immunization Activity

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedImmunizationActivity | Version: 2.1
Draft as of 2023-09-29 | Computable Name: PlannedImmunizationActivity
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.120

This template represents planned immunizations. Planned Immunization Activity is very similar to Planned Medication Activity with some key differences, for example, the drug code system is constrained to CVX codes. The priority of the immunization activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the immunization activity is intended to take place and authorTime indicates when the documentation of the plan occurred.

Usage:

- Use this Logical Model: Planned Intervention Act and Plan of Treatment Section

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from CDAR2.SubstanceAdministration

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
SubstanceAdministration |  |  | CDAR2.SubstanceAdministration | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
classCode |  | 1..1 | cs |
moodCode |  | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required)
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.120
extension |  | 0..0 |  |
id |  | 1..* | II |
statusCode |  | 1..1 | CS |
code |  | 1..1 | cs | Fixed Value: active
effectiveTime |  | 1..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
repeatNumber |  | 0..1 | IVL_INT | In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
routeCode |  | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required)
translation |  | 0..* | CD | Binding: Medication Route (required)
approachSiteCode |  | 0..* | CD | Binding: Body Site Value Set (required)
doseQuantity |  | 0..1 | IVL_PQ |
unit |  | 0..1 | cs | Binding: UnitsOfMeasureCaseSensitive (required)
consumable |  | 1..1 | InfrastructureRoot |
manufacturedProduct |  | 1..1 | ImmunizationMedicationInformation | Base for all types and resources
performer |  | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
author |  | 0..* | AuthorParticipation | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
Slices for entryRelationship |  | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act
entryRelationship:priorityPreference |  | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
typeCode |  | 1..1 | cs | Fixed Value: REFR
observation |  | 1..1 | PriorityPreference | Base for all types and resources
entryRelationship:indication |  | 0..* | EntryRelationship | The following entryRelationship represents the indication for the immunization activity.
typeCode |  | 1..1 | cs | Fixed Value: RSON
observation |  | 1..1 | Indication | Base for all types and resources
entryRelationship:instruction |  | 0..* | EntryRelationship |
typeCode |  | 1..1 | cs | Fixed Value: SUBJ
act |  | 1..1 | Instruction | Base for all types and resources
Slices for precondition |  | 0..* | Precondition | Slice: Unordered, Open by profile:criterion
precondition:pronditionForSubstanceAdmin |  | 0..* | Precondition |
typeCode |  | 1..1 | cs | Fixed Value: PRCN
criterion |  | 1..1 | PreconditionforSubstanceAdministration | Base for all types and resources
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
SubstanceAdministration.moodCode | required | Planned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.routeCode | required | SPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.translation | required | Medication Route
SubstanceAdministration.approachSiteCode | required | Body Site Value Set
SubstanceAdministration.doseQuantity.unit | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
SubstanceAdministration |  | 1..1 | CDAR2.SubstanceAdministration | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources
@classCode |  | 1..1 | cs | Binding: ActClass (required) Fixed Value: SBADM
@moodCode |  | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required)
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.120
id |  | 1..* | II |
statusCode |  | 1..1 | CS | Binding: ActStatus (required)
@code |  | 1..1 | cs | Fixed Value: active
effectiveTime |  | 1..1 |  | The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
effectiveTime |  |  | SXCM_TS |
effectiveTime |  |  | IVL_TS |
effectiveTime |  |  | EIVL_TS |
effectiveTime |  |  | PIVL_TS |
effectiveTime |  |  | SXPR_TS |
repeatNumber |  | 0..1 | IVL_INT | In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
routeCode |  | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required)
translation |  | 0..* | CD | Binding: Medication Route (required)
approachSiteCode |  | 0..* | CD | Binding: Body Site Value Set (required)
doseQuantity |  | 0..1 | IVL_PQ |
@unit |  | 0..1 | cs | Binding: UnitsOfMeasureCaseSensitive (required)
consumable |  | 1..1 | InfrastructureRoot |
manufacturedProduct |  | 1..1 | ImmunizationMedicationInformation | Base for all types and resources
performer |  | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
author |  | 0..* | AuthorParticipation | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
Slices for entryRelationship |  | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act
entryRelationship:priorityPreference |  | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR
observation |  | 1..1 | PriorityPreference | Base for all types and resources
entryRelationship:indication |  | 0..* | EntryRelationship | The following entryRelationship represents the indication for the immunization activity.
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON
observation |  | 1..1 | Indication | Base for all types and resources
entryRelationship:instruction |  | 0..* | EntryRelationship |
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ
act |  | 1..1 | Instruction | Base for all types and resources
Slices for precondition |  | 0..* | Precondition | Slice: Unordered, Open by profile:criterion
precondition:pronditionForSubstanceAdmin |  | 0..* | Precondition |
@typeCode |  | 1..1 | cs | Binding: ActRelationshipType (required) Fixed Value: PRCN
criterion |  | 1..1 | PreconditionforSubstanceAdministration | Base for all types and resources
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
SubstanceAdministration.classCode | required | Fixed Value: SBADM
SubstanceAdministration.moodCode | required | Planned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.statusCode | required | ActStatus
SubstanceAdministration.routeCode | required | SPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.translation | required | Medication Route
SubstanceAdministration.approachSiteCode | required | Body Site Value Set
SubstanceAdministration.doseQuantity.unit | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR
SubstanceAdministration.entryRelationship:indication.typeCode | required | Fixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode | required | Fixed Value: PRCN

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
SubstanceAdministration |  | 1..1 | CDAR2.SubstanceAdministration | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources
@classCode |  | 1..1 | cs | Binding: ActClass (required) Fixed Value: SBADM
@moodCode |  | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@assigningAuthorityName |  | 0..1 | st |
@displayable |  | 0..1 | bl |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.120
id |  | 1..* | II |
code |  | 0..1 | CD | Binding: ActSubstanceAdministrationCode (extensible)
@negationInd |  | 0..1 | bl |
text |  | 0..1 | ED |
statusCode |  | 1..1 | CS | Binding: ActStatus (required)
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@code |  | 1..1 | cs | Fixed Value: active
@sdtcValueSet |  | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion |  | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
effectiveTime |  | 1..1 |  | The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
effectiveTime |  |  | SXCM_TS |
effectiveTime |  |  | IVL_TS |
effectiveTime |  |  | EIVL_TS |
effectiveTime |  |  | PIVL_TS |
effectiveTime |  |  | SXPR_TS |
priorityCode |  | 0..1 | CE | Binding: ActPriority (extensible)
repeatNumber |  | 0..1 | IVL_INT | In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
routeCode |  | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required)
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@code |  | 0..1 | cs |
@codeSystem |  | 0..1 | oid, uuid, ruid |
@codeSystemName |  | 0..1 | st |
@codeSystemVersion |  | 0..1 | st |
@displayName |  | 0..1 | st |
@sdtcValueSet |  | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion |  | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText |  | 0..1 | ED |
translation |  | 0..* | CD | Binding: Medication Route (required)
approachSiteCode |  | 0..* | CD | Binding: Body Site Value Set (required)
doseQuantity |  | 0..1 | IVL_PQ |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@unit |  | 0..1 | cs | Binding: UnitsOfMeasureCaseSensitive (required)
@value |  | 0..1 | real |
@operator |  | 0..1 | cs | Binding: SetOperator (required)
low |  | 0..1 | IVXB_PQ |
center |  | 0..1 | PQ |
width |  | 0..1 | PQ |
high |  | 0..1 | IVXB_PQ |
rateQuantity |  | 0..1 | IVL_PQ |
maxDoseQuantity |  | 0..1 | RTO_PQ_PQ |
administrationUnitCode |  | 0..1 | CE | Binding: AdministrableDrugForm (extensible)
consumable |  | 1..1 | InfrastructureRoot |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: CSM
manufacturedProduct |  | 1..1 | ImmunizationMedicationInformation | Base for all types and resources
subject |  | 0..1 | Subject |
specimen |  | 0..* | Specimen |
performer |  | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
author |  | 0..* | AuthorParticipation | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
informant |  | 0..* | Informant |
participant |  | 0..* | Participant2 |
Slices for entryRelationship |  | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act
entryRelationship:priorityPreference |  | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR
@inversionInd |  | 0..1 | bl |
@contextConductionInd |  | 0..1 | bl |
@negationInd |  | 0..1 | bl |
sequenceNumber |  | 0..1 | INT |
seperatableInd |  | 0..1 | BL |
act |  | 0..1 | Act |
encounter |  | 0..1 | Encounter |
observation |  | 1..1 | PriorityPreference | Base for all types and resources
observationMedia |  | 0..1 | ObservationMedia |
organizer |  | 0..1 | Organizer |
procedure |  | 0..1 | Procedure |
regionOfInterest |  | 0..1 | RegionOfInterest |
substanceAdministration |  | 0..1 | SubstanceAdministration |
supply |  | 0..1 | Supply |
entryRelationship:indication |  | 0..* | EntryRelationship | The following entryRelationship represents the indication for the immunization activity.
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON
@inversionInd |  | 0..1 | bl |
@contextConductionInd |  | 0..1 | bl |
@negationInd |  | 0..1 | bl |
sequenceNumber |  | 0..1 | INT |
seperatableInd |  | 0..1 | BL |
act |  | 0..1 | Act |
encounter |  | 0..1 | Encounter |
observation |  | 1..1 | Indication | Base for all types and resources
observationMedia |  | 0..1 | ObservationMedia |
organizer |  | 0..1 | Organizer |
procedure |  | 0..1 | Procedure |
regionOfInterest |  | 0..1 | RegionOfInterest |
substanceAdministration |  | 0..1 | SubstanceAdministration |
supply |  | 0..1 | Supply |
entryRelationship:instruction |  | 0..* | EntryRelationship |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ
@inversionInd |  | 0..1 | bl |
@contextConductionInd |  | 0..1 | bl |
@negationInd |  | 0..1 | bl |
sequenceNumber |  | 0..1 | INT |
seperatableInd |  | 0..1 | BL |
act |  | 1..1 | Instruction | Base for all types and resources
encounter |  | 0..1 | Encounter |
observation |  | 0..1 | Observation |
observationMedia |  | 0..1 | ObservationMedia |
organizer |  | 0..1 | Organizer |
procedure |  | 0..1 | Procedure |
regionOfInterest |  | 0..1 | RegionOfInterest |
substanceAdministration |  | 0..1 | SubstanceAdministration |
supply |  | 0..1 | Supply |
reference |  | 0..* | Reference |
Slices for precondition |  | 0..* | Precondition | Slice: Unordered, Open by profile:criterion
precondition:pronditionForSubstanceAdmin |  | 0..* | Precondition |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@typeCode |  | 1..1 | cs | Binding: ActRelationshipType (required) Fixed Value: PRCN
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
criterion |  | 1..1 | PreconditionforSubstanceAdministration | Base for all types and resources
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
SubstanceAdministration.classCode | required | Fixed Value: SBADM
SubstanceAdministration.moodCode | required | Planned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.templateId:primary.nullFlavor | required | NullFlavor
SubstanceAdministration.code | extensible | ActSubstanceAdministrationCode
SubstanceAdministration.statusCode | required | ActStatus
SubstanceAdministration.statusCode.nullFlavor | required | NullFlavor
SubstanceAdministration.priorityCode | extensible | ActPriority
SubstanceAdministration.routeCode | required | SPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.nullFlavor | required | NullFlavor
SubstanceAdministration.routeCode.translation | required | Medication Route
SubstanceAdministration.approachSiteCode | required | Body Site Value Set
SubstanceAdministration.doseQuantity.nullFlavor | required | NullFlavor
SubstanceAdministration.doseQuantity.unit | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.doseQuantity.operator | required | SetOperator
SubstanceAdministration.administrationUnitCode | extensible | AdministrableDrugForm
SubstanceAdministration.consumable.nullFlavor | required | NullFlavor
SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSM
SubstanceAdministration.entryRelationship:priorityPreference.nullFlavor | required | NullFlavor
SubstanceAdministration.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR
SubstanceAdministration.entryRelationship:indication.nullFlavor | required | NullFlavor
SubstanceAdministration.entryRelationship:indication.typeCode | required | Fixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.nullFlavor | required | NullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.nullFlavor | required | NullFlavor
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode | required | Fixed Value: PRCN

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

This structure is derived from CDAR2.SubstanceAdministration

Summary

Mandatory: 7 elements (4 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

- Immunization Medication Information (http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationMedicationInformation)
- Author Participation (http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation)
- Priority Preference (http://hl7.org/cda/us/ccda/StructureDefinition/PriorityPreference)
- Indication (http://hl7.org/cda/us/ccda/StructureDefinition/Indication)
- Instruction (http://hl7.org/cda/us/ccda/StructureDefinition/Instruction)
- Precondition for Substance Administration (http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration)

Slices

This structure defines the following Slices:

- The element SubstanceAdministration.templateId is sliced based on the value of value:root
- The element SubstanceAdministration.entryRelationship is sliced based on the values of profile:observation, profile:act
- The element SubstanceAdministration.precondition is sliced based on the value of profile:criterion

Differential View

This structure is derived from CDAR2.SubstanceAdministration

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
SubstanceAdministration |  |  | CDAR2.SubstanceAdministration | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
classCode |  | 1..1 | cs |
moodCode |  | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required)
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.120
extension |  | 0..0 |  |
id |  | 1..* | II |
statusCode |  | 1..1 | CS |
code |  | 1..1 | cs | Fixed Value: active
effectiveTime |  | 1..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
repeatNumber |  | 0..1 | IVL_INT | In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
routeCode |  | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required)
translation |  | 0..* | CD | Binding: Medication Route (required)
approachSiteCode |  | 0..* | CD | Binding: Body Site Value Set (required)
doseQuantity |  | 0..1 | IVL_PQ |
unit |  | 0..1 | cs | Binding: UnitsOfMeasureCaseSensitive (required)
consumable |  | 1..1 | InfrastructureRoot |
manufacturedProduct |  | 1..1 | ImmunizationMedicationInformation | Base for all types and resources
performer |  | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
author |  | 0..* | AuthorParticipation | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
Slices for entryRelationship |  | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act
entryRelationship:priorityPreference |  | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
typeCode |  | 1..1 | cs | Fixed Value: REFR
observation |  | 1..1 | PriorityPreference | Base for all types and resources
entryRelationship:indication |  | 0..* | EntryRelationship | The following entryRelationship represents the indication for the immunization activity.
typeCode |  | 1..1 | cs | Fixed Value: RSON
observation |  | 1..1 | Indication | Base for all types and resources
entryRelationship:instruction |  | 0..* | EntryRelationship |
typeCode |  | 1..1 | cs | Fixed Value: SUBJ
act |  | 1..1 | Instruction | Base for all types and resources
Slices for precondition |  | 0..* | Precondition | Slice: Unordered, Open by profile:criterion
precondition:pronditionForSubstanceAdmin |  | 0..* | Precondition |
typeCode |  | 1..1 | cs | Fixed Value: PRCN
criterion |  | 1..1 | PreconditionforSubstanceAdministration | Base for all types and resources
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
SubstanceAdministration.moodCode | required | Planned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.routeCode | required | SPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.translation | required | Medication Route
SubstanceAdministration.approachSiteCode | required | Body Site Value Set
SubstanceAdministration.doseQuantity.unit | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
SubstanceAdministration |  | 1..1 | CDAR2.SubstanceAdministration | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources
@classCode |  | 1..1 | cs | Binding: ActClass (required) Fixed Value: SBADM
@moodCode |  | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required)
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.120
id |  | 1..* | II |
statusCode |  | 1..1 | CS | Binding: ActStatus (required)
@code |  | 1..1 | cs | Fixed Value: active
effectiveTime |  | 1..1 |  | The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
effectiveTime |  |  | SXCM_TS |
effectiveTime |  |  | IVL_TS |
effectiveTime |  |  | EIVL_TS |
effectiveTime |  |  | PIVL_TS |
effectiveTime |  |  | SXPR_TS |
repeatNumber |  | 0..1 | IVL_INT | In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
routeCode |  | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required)
translation |  | 0..* | CD | Binding: Medication Route (required)
approachSiteCode |  | 0..* | CD | Binding: Body Site Value Set (required)
doseQuantity |  | 0..1 | IVL_PQ |
@unit |  | 0..1 | cs | Binding: UnitsOfMeasureCaseSensitive (required)
consumable |  | 1..1 | InfrastructureRoot |
manufacturedProduct |  | 1..1 | ImmunizationMedicationInformation | Base for all types and resources
performer |  | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
author |  | 0..* | AuthorParticipation | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
Slices for entryRelationship |  | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act
entryRelationship:priorityPreference |  | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR
observation |  | 1..1 | PriorityPreference | Base for all types and resources
entryRelationship:indication |  | 0..* | EntryRelationship | The following entryRelationship represents the indication for the immunization activity.
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON
observation |  | 1..1 | Indication | Base for all types and resources
entryRelationship:instruction |  | 0..* | EntryRelationship |
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ
act |  | 1..1 | Instruction | Base for all types and resources
Slices for precondition |  | 0..* | Precondition | Slice: Unordered, Open by profile:criterion
precondition:pronditionForSubstanceAdmin |  | 0..* | Precondition |
@typeCode |  | 1..1 | cs | Binding: ActRelationshipType (required) Fixed Value: PRCN
criterion |  | 1..1 | PreconditionforSubstanceAdministration | Base for all types and resources
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
SubstanceAdministration.classCode | required | Fixed Value: SBADM
SubstanceAdministration.moodCode | required | Planned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.statusCode | required | ActStatus
SubstanceAdministration.routeCode | required | SPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.translation | required | Medication Route
SubstanceAdministration.approachSiteCode | required | Body Site Value Set
SubstanceAdministration.doseQuantity.unit | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR
SubstanceAdministration.entryRelationship:indication.typeCode | required | Fixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode | required | Fixed Value: PRCN

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
SubstanceAdministration |  | 1..1 | CDAR2.SubstanceAdministration | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources
@classCode |  | 1..1 | cs | Binding: ActClass (required) Fixed Value: SBADM
@moodCode |  | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@assigningAuthorityName |  | 0..1 | st |
@displayable |  | 0..1 | bl |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.120
id |  | 1..* | II |
code |  | 0..1 | CD | Binding: ActSubstanceAdministrationCode (extensible)
@negationInd |  | 0..1 | bl |
text |  | 0..1 | ED |
statusCode |  | 1..1 | CS | Binding: ActStatus (required)
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@code |  | 1..1 | cs | Fixed Value: active
@sdtcValueSet |  | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion |  | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
effectiveTime |  | 1..1 |  | The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
effectiveTime |  |  | SXCM_TS |
effectiveTime |  |  | IVL_TS |
effectiveTime |  |  | EIVL_TS |
effectiveTime |  |  | PIVL_TS |
effectiveTime |  |  | SXPR_TS |
priorityCode |  | 0..1 | CE | Binding: ActPriority (extensible)
repeatNumber |  | 0..1 | IVL_INT | In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
routeCode |  | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required)
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@code |  | 0..1 | cs |
@codeSystem |  | 0..1 | oid, uuid, ruid |
@codeSystemName |  | 0..1 | st |
@codeSystemVersion |  | 0..1 | st |
@displayName |  | 0..1 | st |
@sdtcValueSet |  | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion |  | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText |  | 0..1 | ED |
translation |  | 0..* | CD | Binding: Medication Route (required)
approachSiteCode |  | 0..* | CD | Binding: Body Site Value Set (required)
doseQuantity |  | 0..1 | IVL_PQ |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@unit |  | 0..1 | cs | Binding: UnitsOfMeasureCaseSensitive (required)
@value |  | 0..1 | real |
@operator |  | 0..1 | cs | Binding: SetOperator (required)
low |  | 0..1 | IVXB_PQ |
center |  | 0..1 | PQ |
width |  | 0..1 | PQ |
high |  | 0..1 | IVXB_PQ |
rateQuantity |  | 0..1 | IVL_PQ |
maxDoseQuantity |  | 0..1 | RTO_PQ_PQ |
administrationUnitCode |  | 0..1 | CE | Binding: AdministrableDrugForm (extensible)
consumable |  | 1..1 | InfrastructureRoot |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: CSM
manufacturedProduct |  | 1..1 | ImmunizationMedicationInformation | Base for all types and resources
subject |  | 0..1 | Subject |
specimen |  | 0..* | Specimen |
performer |  | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
author |  | 0..* | AuthorParticipation | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
informant |  | 0..* | Informant |
participant |  | 0..* | Participant2 |
Slices for entryRelationship |  | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act
entryRelationship:priorityPreference |  | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR
@inversionInd |  | 0..1 | bl |
@contextConductionInd |  | 0..1 | bl |
@negationInd |  | 0..1 | bl |
sequenceNumber |  | 0..1 | INT |
seperatableInd |  | 0..1 | BL |
act |  | 0..1 | Act |
encounter |  | 0..1 | Encounter |
observation |  | 1..1 | PriorityPreference | Base for all types and resources
observationMedia |  | 0..1 | ObservationMedia |
organizer |  | 0..1 | Organizer |
procedure |  | 0..1 | Procedure |
regionOfInterest |  | 0..1 | RegionOfInterest |
substanceAdministration |  | 0..1 | SubstanceAdministration |
supply |  | 0..1 | Supply |
entryRelationship:indication |  | 0..* | EntryRelationship | The following entryRelationship represents the indication for the immunization activity.
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON
@inversionInd |  | 0..1 | bl |
@contextConductionInd |  | 0..1 | bl |
@negationInd |  | 0..1 | bl |
sequenceNumber |  | 0..1 | INT |
seperatableInd |  | 0..1 | BL |
act |  | 0..1 | Act |
encounter |  | 0..1 | Encounter |
observation |  | 1..1 | Indication | Base for all types and resources
observationMedia |  | 0..1 | ObservationMedia |
organizer |  | 0..1 | Organizer |
procedure |  | 0..1 | Procedure |
regionOfInterest |  | 0..1 | RegionOfInterest |
substanceAdministration |  | 0..1 | SubstanceAdministration |
supply |  | 0..1 | Supply |
entryRelationship:instruction |  | 0..* | EntryRelationship |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
@typeCode |  | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ
@inversionInd |  | 0..1 | bl |
@contextConductionInd |  | 0..1 | bl |
@negationInd |  | 0..1 | bl |
sequenceNumber |  | 0..1 | INT |
seperatableInd |  | 0..1 | BL |
act |  | 1..1 | Instruction | Base for all types and resources
encounter |  | 0..1 | Encounter |
observation |  | 0..1 | Observation |
observationMedia |  | 0..1 | ObservationMedia |
organizer |  | 0..1 | Organizer |
procedure |  | 0..1 | Procedure |
regionOfInterest |  | 0..1 | RegionOfInterest |
substanceAdministration |  | 0..1 | SubstanceAdministration |
supply |  | 0..1 | Supply |
reference |  | 0..* | Reference |
Slices for precondition |  | 0..* | Precondition | Slice: Unordered, Open by profile:criterion
precondition:pronditionForSubstanceAdmin |  | 0..* | Precondition |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@typeCode |  | 1..1 | cs | Binding: ActRelationshipType (required) Fixed Value: PRCN
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
templateId |  | 0..* | II |
criterion |  | 1..1 | PreconditionforSubstanceAdministration | Base for all types and resources
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
SubstanceAdministration.classCode | required | Fixed Value: SBADM
SubstanceAdministration.moodCode | required | Planned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.templateId:primary.nullFlavor | required | NullFlavor
SubstanceAdministration.code | extensible | ActSubstanceAdministrationCode
SubstanceAdministration.statusCode | required | ActStatus
SubstanceAdministration.statusCode.nullFlavor | required | NullFlavor
SubstanceAdministration.priorityCode | extensible | ActPriority
SubstanceAdministration.routeCode | required | SPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.nullFlavor | required | NullFlavor
SubstanceAdministration.routeCode.translation | required | Medication Route
SubstanceAdministration.approachSiteCode | required | Body Site Value Set
SubstanceAdministration.doseQuantity.nullFlavor | required | NullFlavor
SubstanceAdministration.doseQuantity.unit | required | UnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.doseQuantity.operator | required | SetOperator
SubstanceAdministration.administrationUnitCode | extensible | AdministrableDrugForm
SubstanceAdministration.consumable.nullFlavor | required | NullFlavor
SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSM
SubstanceAdministration.entryRelationship:priorityPreference.nullFlavor | required | NullFlavor
SubstanceAdministration.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR
SubstanceAdministration.entryRelationship:indication.nullFlavor | required | NullFlavor
SubstanceAdministration.entryRelationship:indication.typeCode | required | Fixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.nullFlavor | required | NullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.nullFlavor | required | NullFlavor
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode | required | Fixed Value: PRCN

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

This structure is derived from CDAR2.SubstanceAdministration

Summary

Mandatory: 7 elements (4 nested mandatory elements)
Fixed Value: 5 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

- Immunization Medication Information (http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationMedicationInformation)
- Author Participation (http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation)
- Priority Preference (http://hl7.org/cda/us/ccda/StructureDefinition/PriorityPreference)
- Indication (http://hl7.org/cda/us/ccda/StructureDefinition/Indication)
- Instruction (http://hl7.org/cda/us/ccda/StructureDefinition/Instruction)
- Precondition for Substance Administration (http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration)

Slices

This structure defines the following Slices:

- The element SubstanceAdministration.templateId is sliced based on the value of value:root
- The element SubstanceAdministration.entryRelationship is sliced based on the values of profile:observation, profile:act
- The element SubstanceAdministration.precondition is sliced based on the value of profile:criterion

Other representations of profile: CSV, Excel