Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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:

Formal Views of Profile Content

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

This structure is derived from CDAR2.SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration CDAR2.SubstanceAdministrationXML 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..1cs
... moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
..... extension 0..0
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... effectiveTime 1..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TSThe effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
... repeatNumber 0..1IVL_INTIn 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..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... unit 0..1csBinding: UnitsOfMeasureCaseSensitive (required)
... consumable 1..1InfrastructureRoot
.... manufacturedProduct 1..1ImmunizationMedicationInformationBase for all types and resources
... performer 0..*Performer2The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
... author 0..*AuthorParticipationThe author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned immunization activity.
Slice: Unordered, Open by profile:observation, profile:act
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the immunization activity.
..... typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... typeCode 1..1csFixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:pronditionForSubstanceAdmin 0..*Precondition
..... typeCode 1..1csFixed Value: PRCN
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubstanceAdministration.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.routeCoderequiredSPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.translationrequiredMedication Route
SubstanceAdministration.approachSiteCoderequiredBody Site Value Set
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministrationXML 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..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 1..1The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... repeatNumber 0..1IVL_INTIn 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..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... @unit 0..1csBinding: UnitsOfMeasureCaseSensitive (required)
... consumable 1..1InfrastructureRoot
.... manufacturedProduct 1..1ImmunizationMedicationInformationBase for all types and resources
... performer 0..*Performer2The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
... author 0..*AuthorParticipationThe author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned immunization activity.
Slice: Unordered, Open by profile:observation, profile:act
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the immunization activity.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:pronditionForSubstanceAdmin 0..*Precondition
..... @typeCode 1..1csBinding: ActRelationshipType (required)
Fixed Value: PRCN
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.routeCoderequiredSPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.translationrequiredMedication Route
SubstanceAdministration.approachSiteCoderequiredBody Site Value Set
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
SubstanceAdministration.entryRelationship:indication.typeCoderequiredFixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCoderequiredFixed Value: PRCN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministrationXML 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..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
... id 1..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn 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..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 0..1cs
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @unit 0..1csBinding: UnitsOfMeasureCaseSensitive (required)
.... @value 0..1real
.... @operator 0..1csBinding: SetOperator (required)
.... low 0..1IVXB_PQ
.... center 0..1PQ
.... width 0..1PQ
.... high 0..1IVXB_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ImmunizationMedicationInformationBase for all types and resources
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
... author 0..*AuthorParticipationThe 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..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned immunization activity.
Slice: Unordered, Open by profile:observation, profile:act
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the immunization activity.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:instruction 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:pronditionForSubstanceAdmin 0..*Precondition
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ActRelationshipType (required)
Fixed Value: PRCN
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.templateId:primary.nullFlavorrequiredNullFlavor
SubstanceAdministration.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCoderequiredSPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.routeCode.translationrequiredMedication Route
SubstanceAdministration.approachSiteCoderequiredBody Site Value Set
SubstanceAdministration.doseQuantity.nullFlavorrequiredNullFlavor
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.doseQuantity.operatorrequiredSetOperator
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
SubstanceAdministration.consumable.nullFlavorrequiredNullFlavor
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
SubstanceAdministration.entryRelationship:priorityPreference.nullFlavorrequiredNullFlavor
SubstanceAdministration.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
SubstanceAdministration.entryRelationship:indication.nullFlavorrequiredNullFlavor
SubstanceAdministration.entryRelationship:indication.typeCoderequiredFixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.nullFlavorrequiredNullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.nullFlavorrequiredNullFlavor
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCoderequiredFixed Value: PRCN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll 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:

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration CDAR2.SubstanceAdministrationXML 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..1cs
... moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
..... extension 0..0
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... effectiveTime 1..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TSThe effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
... repeatNumber 0..1IVL_INTIn 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..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... unit 0..1csBinding: UnitsOfMeasureCaseSensitive (required)
... consumable 1..1InfrastructureRoot
.... manufacturedProduct 1..1ImmunizationMedicationInformationBase for all types and resources
... performer 0..*Performer2The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
... author 0..*AuthorParticipationThe author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned immunization activity.
Slice: Unordered, Open by profile:observation, profile:act
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the immunization activity.
..... typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... typeCode 1..1csFixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:pronditionForSubstanceAdmin 0..*Precondition
..... typeCode 1..1csFixed Value: PRCN
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubstanceAdministration.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.routeCoderequiredSPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.translationrequiredMedication Route
SubstanceAdministration.approachSiteCoderequiredBody Site Value Set
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministrationXML 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..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 1..1The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... repeatNumber 0..1IVL_INTIn 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..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... @unit 0..1csBinding: UnitsOfMeasureCaseSensitive (required)
... consumable 1..1InfrastructureRoot
.... manufacturedProduct 1..1ImmunizationMedicationInformationBase for all types and resources
... performer 0..*Performer2The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
... author 0..*AuthorParticipationThe author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned immunization activity.
Slice: Unordered, Open by profile:observation, profile:act
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the immunization activity.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:pronditionForSubstanceAdmin 0..*Precondition
..... @typeCode 1..1csBinding: ActRelationshipType (required)
Fixed Value: PRCN
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.routeCoderequiredSPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.translationrequiredMedication Route
SubstanceAdministration.approachSiteCoderequiredBody Site Value Set
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
SubstanceAdministration.entryRelationship:indication.typeCoderequiredFixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCoderequiredFixed Value: PRCN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministrationXML 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..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
... id 1..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn 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..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 0..1cs
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @unit 0..1csBinding: UnitsOfMeasureCaseSensitive (required)
.... @value 0..1real
.... @operator 0..1csBinding: SetOperator (required)
.... low 0..1IVXB_PQ
.... center 0..1PQ
.... width 0..1PQ
.... high 0..1IVXB_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ImmunizationMedicationInformationBase for all types and resources
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
... author 0..*AuthorParticipationThe 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..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned immunization activity.
Slice: Unordered, Open by profile:observation, profile:act
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the immunization activity.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:instruction 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:pronditionForSubstanceAdmin 0..*Precondition
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ActRelationshipType (required)
Fixed Value: PRCN
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.templateId:primary.nullFlavorrequiredNullFlavor
SubstanceAdministration.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCoderequiredSPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.routeCode.translationrequiredMedication Route
SubstanceAdministration.approachSiteCoderequiredBody Site Value Set
SubstanceAdministration.doseQuantity.nullFlavorrequiredNullFlavor
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.doseQuantity.operatorrequiredSetOperator
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
SubstanceAdministration.consumable.nullFlavorrequiredNullFlavor
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
SubstanceAdministration.entryRelationship:priorityPreference.nullFlavorrequiredNullFlavor
SubstanceAdministration.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
SubstanceAdministration.entryRelationship:indication.nullFlavorrequiredNullFlavor
SubstanceAdministration.entryRelationship:indication.typeCoderequiredFixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.nullFlavorrequiredNullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.nullFlavorrequiredNullFlavor
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCoderequiredFixed Value: PRCN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll 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:

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