Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ 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: 4.0.0
Draft as of 2025-10-02 Computable Name: PlannedImmunizationActivity
Other Identifiers: 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.

Templates Used

Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:

Optional EntryRelationships: Indication, InstructionObservation, PriorityPreference

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 3.0.0:

  • New Content

    • Formal Views of Template Content

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

    This structure is derived from SubstanceAdministration

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. SubstanceAdministration C 1..1 SubstanceAdministration XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:planned-immunization-activity 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.120
    ..... @extension 0..0
    ... @classCode 1..1 cs
    ... @moodCode 1..1 cs Binding: Planned moodCode (SubstanceAdministration/Supply) . (required)
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    ... 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 C 0..1 CE Binding: SPL Drug Route of Administration Terminology . (required)
    Constraints: should-translation
    .... translation 0..* CD Binding: Medication Route . (preferred)
    ... approachSiteCode 0..* CD Binding: Body Site Value Set . (required)
    ... doseQuantity C 0..1 IVL_PQ Constraints: should-unit
    .... @unit 0..1 cs NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
    Binding: UnitsOfMeasureCaseSensitive (preferred)
    ... consumable 1..1 InfrastructureRoot
    .... manufacturedProduct 1..1 ImmunizationMedicationInformation
    ... 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
    .... 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
    .... entryRelationship:instruction 0..* EntryRelationship
    ..... @typeCode 1..1 cs Fixed Value: SUBJ
    ..... observation 1..1 InstructionObservation
    ... Slices for precondition 0..* Precondition Slice: Unordered, Open by profile:criterion
    .... precondition:pronditionForSubstanceAdmin 0..* Precondition
    ..... @typeCode 1..1 cs
    ..... criterion 1..1 PreconditionforSubstanceAdministration

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    SubstanceAdministration.​moodCode Base required Planned moodCode (SubstanceAdministration/Supply) . 📦20240606 VSAC v0.23
    SubstanceAdministration.​routeCode Base required SPL Drug Route of Administration Terminology . 📦20240716 VSAC v0.23
    SubstanceAdministration.​routeCode.translation Base preferred Medication Route . 📦20240606 VSAC v0.23
    SubstanceAdministration.​approachSiteCode Base required Body Site Value Set . 📦20240606 VSAC v0.23
    SubstanceAdministration.​doseQuantity.unit Base preferred UnitsOfMeasureCaseSensitive 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    should-text-ref-value warning SubstanceAdministration SHOULD contain text/reference/@value text.reference.value.exists()
    should-translation warning SubstanceAdministration.routeCode SHOULD contain translation translation.exists()
    should-unit warning SubstanceAdministration.doseQuantity SHOULD contain @unit nullFlavor.exists() or unit.exists()
    value-starts-octothorpe error SubstanceAdministration.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. SubstanceAdministration C 1..1 SubstanceAdministration XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:planned-immunization-activity 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (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
    ... @classCode 1..1 cs Binding: CDAActClass (required)
    Fixed Value: SBADM
    ... @moodCode 1..1 cs Binding: Planned moodCode (SubstanceAdministration/Supply) . (required)
    ... id 1..* II
    ... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (example)
    ... @negationInd 0..1 bl
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (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 (example)
    ... 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 C 0..1 CE Binding: SPL Drug Route of Administration Terminology . (required)
    Constraints: should-translation
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (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 . (preferred)
    ... approachSiteCode 0..* CD Binding: Body Site Value Set . (required)
    ... doseQuantity C 0..1 IVL_PQ Constraints: should-unit
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @unit 0..1 cs NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
    Binding: UnitsOfMeasureCaseSensitive (preferred)
    .... @value 0..1 real
    .... translation 0..* PQR
    .... @operator 0..1 cs Binding: CDASetOperator (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 (example)
    ... consumable 1..1 InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAParticipationType (required)
    Fixed Value: CSM
    .... manufacturedProduct 1..1 ImmunizationMedicationInformation
    ... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 InstructionObservation
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: PRCN
    ..... criterion 1..1 PreconditionforSubstanceAdministration
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    SubstanceAdministration.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​templateId:planned-immunization-activity.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​classCode Base required CDAActClass 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​moodCode Base required Planned moodCode (SubstanceAdministration/Supply) . 📦20240606 VSAC v0.23
    SubstanceAdministration.​code Base example CDAActSubstanceAdministrationCode 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    SubstanceAdministration.​text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    SubstanceAdministration.​text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​statusCode Base required ActStatus 📦3.0.0 THO v6.5
    SubstanceAdministration.​statusCode.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    SubstanceAdministration.​routeCode Base required SPL Drug Route of Administration Terminology . 📦20240716 VSAC v0.23
    SubstanceAdministration.​routeCode.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​routeCode.translation Base preferred Medication Route . 📦20240606 VSAC v0.23
    SubstanceAdministration.​approachSiteCode Base required Body Site Value Set . 📦20240606 VSAC v0.23
    SubstanceAdministration.​doseQuantity.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​doseQuantity.unit Base preferred UnitsOfMeasureCaseSensitive 📦3.0.0 THO v6.5
    SubstanceAdministration.​doseQuantity.operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​administrationUnitCode Base example AdministrableDrugForm 📦3.0.0 THO v6.5
    SubstanceAdministration.​consumable.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​consumable.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​consumable.typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​entryRelationship:indication.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:indication.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:indication.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​entryRelationship:instruction.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:instruction.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:instruction.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.entryRelationship:priorityPreference.typeId, SubstanceAdministration.entryRelationship:indication.typeId, SubstanceAdministration.entryRelationship:instruction.typeId, SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-text-ref-value warning SubstanceAdministration SHOULD contain text/reference/@value text.reference.value.exists()
    should-translation warning SubstanceAdministration.routeCode SHOULD contain translation translation.exists()
    should-unit warning SubstanceAdministration.doseQuantity SHOULD contain @unit nullFlavor.exists() or unit.exists()
    value-starts-octothorpe error SubstanceAdministration.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. SubstanceAdministration C 1..1 SubstanceAdministration XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:planned-immunization-activity 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (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
    ... @classCode 1..1 cs Binding: CDAActClass (required)
    Fixed Value: SBADM
    ... @moodCode 1..1 cs Binding: Planned moodCode (SubstanceAdministration/Supply) . (required)
    ... id 1..* II
    ... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (example)
    ... @negationInd 0..1 bl
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (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 (example)
    ... 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 C 0..1 CE Binding: SPL Drug Route of Administration Terminology . (required)
    Constraints: should-translation
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (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 . (preferred)
    ... approachSiteCode 0..* CD Binding: Body Site Value Set . (required)
    ... doseQuantity C 0..1 IVL_PQ Constraints: should-unit
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @unit 0..1 cs NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
    Binding: UnitsOfMeasureCaseSensitive (preferred)
    .... @value 0..1 real
    .... translation 0..* PQR
    .... @operator 0..1 cs Binding: CDASetOperator (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 (example)
    ... consumable 1..1 InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAParticipationType (required)
    Fixed Value: CSM
    .... manufacturedProduct 1..1 ImmunizationMedicationInformation
    ... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 InstructionObservation
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: PRCN
    ..... criterion 1..1 PreconditionforSubstanceAdministration
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    SubstanceAdministration.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​templateId:planned-immunization-activity.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​classCode Base required CDAActClass 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​moodCode Base required Planned moodCode (SubstanceAdministration/Supply) . 📦20240606 VSAC v0.23
    SubstanceAdministration.​code Base example CDAActSubstanceAdministrationCode 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    SubstanceAdministration.​text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    SubstanceAdministration.​text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​statusCode Base required ActStatus 📦3.0.0 THO v6.5
    SubstanceAdministration.​statusCode.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    SubstanceAdministration.​routeCode Base required SPL Drug Route of Administration Terminology . 📦20240716 VSAC v0.23
    SubstanceAdministration.​routeCode.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​routeCode.translation Base preferred Medication Route . 📦20240606 VSAC v0.23
    SubstanceAdministration.​approachSiteCode Base required Body Site Value Set . 📦20240606 VSAC v0.23
    SubstanceAdministration.​doseQuantity.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​doseQuantity.unit Base preferred UnitsOfMeasureCaseSensitive 📦3.0.0 THO v6.5
    SubstanceAdministration.​doseQuantity.operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​administrationUnitCode Base example AdministrableDrugForm 📦3.0.0 THO v6.5
    SubstanceAdministration.​consumable.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​consumable.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​consumable.typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​entryRelationship:indication.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:indication.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:indication.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​entryRelationship:instruction.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:instruction.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:instruction.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.entryRelationship:priorityPreference.typeId, SubstanceAdministration.entryRelationship:indication.typeId, SubstanceAdministration.entryRelationship:instruction.typeId, SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-text-ref-value warning SubstanceAdministration SHOULD contain text/reference/@value text.reference.value.exists()
    should-translation warning SubstanceAdministration.routeCode SHOULD contain translation translation.exists()
    should-unit warning SubstanceAdministration.doseQuantity SHOULD contain @unit nullFlavor.exists() or unit.exists()
    value-starts-octothorpe error SubstanceAdministration.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from SubstanceAdministration

    Summary

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

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of SubstanceAdministration.templateId
    • The element 2 is sliced based on the values of SubstanceAdministration.entryRelationship
    • The element 1 is sliced based on the value of SubstanceAdministration.precondition

    Differential View

    This structure is derived from SubstanceAdministration

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. SubstanceAdministration C 1..1 SubstanceAdministration XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:planned-immunization-activity 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.120
    ..... @extension 0..0
    ... @classCode 1..1 cs
    ... @moodCode 1..1 cs Binding: Planned moodCode (SubstanceAdministration/Supply) . (required)
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    ... 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 C 0..1 CE Binding: SPL Drug Route of Administration Terminology . (required)
    Constraints: should-translation
    .... translation 0..* CD Binding: Medication Route . (preferred)
    ... approachSiteCode 0..* CD Binding: Body Site Value Set . (required)
    ... doseQuantity C 0..1 IVL_PQ Constraints: should-unit
    .... @unit 0..1 cs NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
    Binding: UnitsOfMeasureCaseSensitive (preferred)
    ... consumable 1..1 InfrastructureRoot
    .... manufacturedProduct 1..1 ImmunizationMedicationInformation
    ... 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
    .... 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
    .... entryRelationship:instruction 0..* EntryRelationship
    ..... @typeCode 1..1 cs Fixed Value: SUBJ
    ..... observation 1..1 InstructionObservation
    ... Slices for precondition 0..* Precondition Slice: Unordered, Open by profile:criterion
    .... precondition:pronditionForSubstanceAdmin 0..* Precondition
    ..... @typeCode 1..1 cs
    ..... criterion 1..1 PreconditionforSubstanceAdministration

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    SubstanceAdministration.​moodCode Base required Planned moodCode (SubstanceAdministration/Supply) . 📦20240606 VSAC v0.23
    SubstanceAdministration.​routeCode Base required SPL Drug Route of Administration Terminology . 📦20240716 VSAC v0.23
    SubstanceAdministration.​routeCode.translation Base preferred Medication Route . 📦20240606 VSAC v0.23
    SubstanceAdministration.​approachSiteCode Base required Body Site Value Set . 📦20240606 VSAC v0.23
    SubstanceAdministration.​doseQuantity.unit Base preferred UnitsOfMeasureCaseSensitive 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    should-text-ref-value warning SubstanceAdministration SHOULD contain text/reference/@value text.reference.value.exists()
    should-translation warning SubstanceAdministration.routeCode SHOULD contain translation translation.exists()
    should-unit warning SubstanceAdministration.doseQuantity SHOULD contain @unit nullFlavor.exists() or unit.exists()
    value-starts-octothorpe error SubstanceAdministration.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. SubstanceAdministration C 1..1 SubstanceAdministration XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:planned-immunization-activity 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (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
    ... @classCode 1..1 cs Binding: CDAActClass (required)
    Fixed Value: SBADM
    ... @moodCode 1..1 cs Binding: Planned moodCode (SubstanceAdministration/Supply) . (required)
    ... id 1..* II
    ... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (example)
    ... @negationInd 0..1 bl
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (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 (example)
    ... 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 C 0..1 CE Binding: SPL Drug Route of Administration Terminology . (required)
    Constraints: should-translation
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (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 . (preferred)
    ... approachSiteCode 0..* CD Binding: Body Site Value Set . (required)
    ... doseQuantity C 0..1 IVL_PQ Constraints: should-unit
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @unit 0..1 cs NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
    Binding: UnitsOfMeasureCaseSensitive (preferred)
    .... @value 0..1 real
    .... translation 0..* PQR
    .... @operator 0..1 cs Binding: CDASetOperator (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 (example)
    ... consumable 1..1 InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAParticipationType (required)
    Fixed Value: CSM
    .... manufacturedProduct 1..1 ImmunizationMedicationInformation
    ... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 InstructionObservation
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: PRCN
    ..... criterion 1..1 PreconditionforSubstanceAdministration
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    SubstanceAdministration.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​templateId:planned-immunization-activity.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​classCode Base required CDAActClass 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​moodCode Base required Planned moodCode (SubstanceAdministration/Supply) . 📦20240606 VSAC v0.23
    SubstanceAdministration.​code Base example CDAActSubstanceAdministrationCode 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    SubstanceAdministration.​text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    SubstanceAdministration.​text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​statusCode Base required ActStatus 📦3.0.0 THO v6.5
    SubstanceAdministration.​statusCode.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    SubstanceAdministration.​routeCode Base required SPL Drug Route of Administration Terminology . 📦20240716 VSAC v0.23
    SubstanceAdministration.​routeCode.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​routeCode.translation Base preferred Medication Route . 📦20240606 VSAC v0.23
    SubstanceAdministration.​approachSiteCode Base required Body Site Value Set . 📦20240606 VSAC v0.23
    SubstanceAdministration.​doseQuantity.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​doseQuantity.unit Base preferred UnitsOfMeasureCaseSensitive 📦3.0.0 THO v6.5
    SubstanceAdministration.​doseQuantity.operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​administrationUnitCode Base example AdministrableDrugForm 📦3.0.0 THO v6.5
    SubstanceAdministration.​consumable.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​consumable.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​consumable.typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​entryRelationship:indication.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:indication.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:indication.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​entryRelationship:instruction.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:instruction.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:instruction.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.entryRelationship:priorityPreference.typeId, SubstanceAdministration.entryRelationship:indication.typeId, SubstanceAdministration.entryRelationship:instruction.typeId, SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-text-ref-value warning SubstanceAdministration SHOULD contain text/reference/@value text.reference.value.exists()
    should-translation warning SubstanceAdministration.routeCode SHOULD contain translation translation.exists()
    should-unit warning SubstanceAdministration.doseQuantity SHOULD contain @unit nullFlavor.exists() or unit.exists()
    value-starts-octothorpe error SubstanceAdministration.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. SubstanceAdministration C 1..1 SubstanceAdministration XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:planned-immunization-activity 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (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
    ... @classCode 1..1 cs Binding: CDAActClass (required)
    Fixed Value: SBADM
    ... @moodCode 1..1 cs Binding: Planned moodCode (SubstanceAdministration/Supply) . (required)
    ... id 1..* II
    ... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (example)
    ... @negationInd 0..1 bl
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (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 (example)
    ... 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 C 0..1 CE Binding: SPL Drug Route of Administration Terminology . (required)
    Constraints: should-translation
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (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 . (preferred)
    ... approachSiteCode 0..* CD Binding: Body Site Value Set . (required)
    ... doseQuantity C 0..1 IVL_PQ Constraints: should-unit
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @unit 0..1 cs NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
    Binding: UnitsOfMeasureCaseSensitive (preferred)
    .... @value 0..1 real
    .... translation 0..* PQR
    .... @operator 0..1 cs Binding: CDASetOperator (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 (example)
    ... consumable 1..1 InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAParticipationType (required)
    Fixed Value: CSM
    .... manufacturedProduct 1..1 ImmunizationMedicationInformation
    ... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... 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 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 InstructionObservation
    ..... 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: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: PRCN
    ..... criterion 1..1 PreconditionforSubstanceAdministration
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    SubstanceAdministration.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​templateId:planned-immunization-activity.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​classCode Base required CDAActClass 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​moodCode Base required Planned moodCode (SubstanceAdministration/Supply) . 📦20240606 VSAC v0.23
    SubstanceAdministration.​code Base example CDAActSubstanceAdministrationCode 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    SubstanceAdministration.​text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    SubstanceAdministration.​text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​statusCode Base required ActStatus 📦3.0.0 THO v6.5
    SubstanceAdministration.​statusCode.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    SubstanceAdministration.​routeCode Base required SPL Drug Route of Administration Terminology . 📦20240716 VSAC v0.23
    SubstanceAdministration.​routeCode.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​routeCode.translation Base preferred Medication Route . 📦20240606 VSAC v0.23
    SubstanceAdministration.​approachSiteCode Base required Body Site Value Set . 📦20240606 VSAC v0.23
    SubstanceAdministration.​doseQuantity.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​doseQuantity.unit Base preferred UnitsOfMeasureCaseSensitive 📦3.0.0 THO v6.5
    SubstanceAdministration.​doseQuantity.operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​administrationUnitCode Base example AdministrableDrugForm 📦3.0.0 THO v6.5
    SubstanceAdministration.​consumable.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​consumable.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​consumable.typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:priorityPreference.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​entryRelationship:indication.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:indication.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:indication.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​entryRelationship:instruction.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:instruction.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​entryRelationship:instruction.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    SubstanceAdministration.​precondition:pronditionForSubstanceAdmin.​typeCode Base required CDAActRelationshipType 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.entryRelationship:priorityPreference.typeId, SubstanceAdministration.entryRelationship:indication.typeId, SubstanceAdministration.entryRelationship:instruction.typeId, SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-text-ref-value warning SubstanceAdministration SHOULD contain text/reference/@value text.reference.value.exists()
    should-translation warning SubstanceAdministration.routeCode SHOULD contain translation translation.exists()
    should-unit warning SubstanceAdministration.doseQuantity SHOULD contain @unit nullFlavor.exists() or unit.exists()
    value-starts-octothorpe error SubstanceAdministration.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from SubstanceAdministration

    Summary

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

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of SubstanceAdministration.templateId
    • The element 2 is sliced based on the values of SubstanceAdministration.entryRelationship
    • The element 1 is sliced based on the value of SubstanceAdministration.precondition

     

    Other representations of profile: CSV, Excel