Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Planned Immunization Activity

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedImmunizationActivity Version: 3.0.0-ballot
Draft as of 2023-12-21 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 SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration C1..1SubstanceAdministrationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-immunization-activity 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
..... @extension 0..0
... @classCode 1..1cs
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... 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 C0..1CEBinding: SPL Drug Route of Administration Terminology (required)
should-translation: SHOULD contain translation
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity C0..1IVL_PQshould-unit: SHOULD contain @unit
.... @unit 0..1csNOTE: 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 (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..1cs
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubstanceAdministration.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply
SubstanceAdministration.routeCoderequiredSPLDrugRouteOfAdministrationTerminology
SubstanceAdministration.routeCode.translationrequiredMedicationRoute
SubstanceAdministration.approachSiteCoderequiredBodySiteValueSet
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningSubstanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-translationwarningSubstanceAdministration.routeCodeSHOULD contain translation
: translation.exists()
should-unitwarningSubstanceAdministration.doseQuantitySHOULD contain @unit
: nullFlavor.exists() or unit.exists()
value-starts-octothorpeerrorSubstanceAdministration.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration C1..1SubstanceAdministrationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-immunization-activity 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
... @classCode 1..1csBinding: ActClass (2.0.0) (required)
Fixed Value: SBADM
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... 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 C0..1CEBinding: SPL Drug Route of Administration Terminology (required)
should-translation: SHOULD contain translation
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity C0..1IVL_PQshould-unit: SHOULD contain @unit
.... @unit 0..1csNOTE: 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 (required)
... consumable 1..1InfrastructureRoot
.... manufacturedProduct C1..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 C1..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 C1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... act C1..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.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.routeCoderequiredSPLDrugRouteOfAdministrationTerminology
SubstanceAdministration.routeCode.translationrequiredMedicationRoute
SubstanceAdministration.approachSiteCoderequiredBodySiteValueSet
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
product-choiceerrorSubstanceAdministration.consumable.manufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
should-authorwarningSubstanceAdministration.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningSubstanceAdministration.entryRelationship:priorityPreference.observation, SubstanceAdministration.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-manufacturerOrganizationwarningSubstanceAdministration.consumable.manufacturedProductSHOULD contain manufacturerOrganization
: manufacturerOrganization.exists()
should-text-ref-valuewarningSubstanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSubstanceAdministration.entryRelationship:priorityPreference.observation, SubstanceAdministration.entryRelationship:indication.observation, SubstanceAdministration.entryRelationship:instruction.actSHOULD contain text/reference/@value
: text.reference.value.exists()
should-translationwarningSubstanceAdministration.routeCodeSHOULD contain translation
: translation.exists()
should-unitwarningSubstanceAdministration.doseQuantitySHOULD contain @unit
: nullFlavor.exists() or unit.exists()
value-starts-octothorpeerrorSubstanceAdministration.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration C1..1SubstanceAdministrationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-immunization-activity 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
... @classCode 1..1csBinding: ActClass (2.0.0) (required)
Fixed Value: SBADM
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... id 1..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (example)
... @negationInd 0..1bl
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 (example)
... 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 C0..1CEBinding: SPL Drug Route of Administration Terminology (required)
should-translation: SHOULD contain translation
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 C0..1IVL_PQshould-unit: SHOULD contain @unit
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @unit 0..1csNOTE: 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 (required)
.... @value 0..1real
.... translation 0..*PQR
.... @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 (example)
... consumable 1..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: CSM
.... manufacturedProduct C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ActRelationshipType (required)
Fixed Value: PRCN
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.templateId:planned-immunization-activity.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply
SubstanceAdministration.codeexampleActSubstanceAdministrationCode
SubstanceAdministration.text.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.text.compressionrequiredCDACompressionAlgorithm
SubstanceAdministration.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
SubstanceAdministration.text.mediaTypeexampleMediaType
SubstanceAdministration.text.representationrequiredBinaryDataEncoding
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.priorityCodeexampleActPriority
SubstanceAdministration.routeCoderequiredSPLDrugRouteOfAdministrationTerminology
SubstanceAdministration.routeCode.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.routeCode.translationrequiredMedicationRoute
SubstanceAdministration.approachSiteCoderequiredBodySiteValueSet
SubstanceAdministration.doseQuantity.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.doseQuantity.operatorrequiredSetOperator
SubstanceAdministration.administrationUnitCodeexampleAdministrableDrugForm
SubstanceAdministration.consumable.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.consumable.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
SubstanceAdministration.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
SubstanceAdministration.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeCoderequiredFixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCoderequiredFixed Value: PRCN

Constraints

IdGradePath(s)DetailsRequirements
product-choiceerrorSubstanceAdministration.consumable.manufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
should-authorwarningSubstanceAdministration.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningSubstanceAdministration.entryRelationship:priorityPreference.observation, SubstanceAdministration.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-manufacturerOrganizationwarningSubstanceAdministration.consumable.manufacturedProductSHOULD contain manufacturerOrganization
: manufacturerOrganization.exists()
should-text-ref-valuewarningSubstanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSubstanceAdministration.entryRelationship:priorityPreference.observation, SubstanceAdministration.entryRelationship:indication.observation, SubstanceAdministration.entryRelationship:instruction.actSHOULD contain text/reference/@value
: text.reference.value.exists()
should-translationwarningSubstanceAdministration.routeCodeSHOULD contain translation
: translation.exists()
should-unitwarningSubstanceAdministration.doseQuantitySHOULD contain @unit
: nullFlavor.exists() or unit.exists()
value-starts-octothorpeerrorSubstanceAdministration.text.referenceIf 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 Value: 4 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 SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration C1..1SubstanceAdministrationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-immunization-activity 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
..... @extension 0..0
... @classCode 1..1cs
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... 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 C0..1CEBinding: SPL Drug Route of Administration Terminology (required)
should-translation: SHOULD contain translation
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity C0..1IVL_PQshould-unit: SHOULD contain @unit
.... @unit 0..1csNOTE: 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 (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..1cs
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubstanceAdministration.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply
SubstanceAdministration.routeCoderequiredSPLDrugRouteOfAdministrationTerminology
SubstanceAdministration.routeCode.translationrequiredMedicationRoute
SubstanceAdministration.approachSiteCoderequiredBodySiteValueSet
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningSubstanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-translationwarningSubstanceAdministration.routeCodeSHOULD contain translation
: translation.exists()
should-unitwarningSubstanceAdministration.doseQuantitySHOULD contain @unit
: nullFlavor.exists() or unit.exists()
value-starts-octothorpeerrorSubstanceAdministration.text.referenceIf 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 & Constraintsdoco
.. SubstanceAdministration C1..1SubstanceAdministrationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-immunization-activity 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
... @classCode 1..1csBinding: ActClass (2.0.0) (required)
Fixed Value: SBADM
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... 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 C0..1CEBinding: SPL Drug Route of Administration Terminology (required)
should-translation: SHOULD contain translation
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity C0..1IVL_PQshould-unit: SHOULD contain @unit
.... @unit 0..1csNOTE: 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 (required)
... consumable 1..1InfrastructureRoot
.... manufacturedProduct C1..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 C1..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 C1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... act C1..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.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.routeCoderequiredSPLDrugRouteOfAdministrationTerminology
SubstanceAdministration.routeCode.translationrequiredMedicationRoute
SubstanceAdministration.approachSiteCoderequiredBodySiteValueSet
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
product-choiceerrorSubstanceAdministration.consumable.manufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
should-authorwarningSubstanceAdministration.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningSubstanceAdministration.entryRelationship:priorityPreference.observation, SubstanceAdministration.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-manufacturerOrganizationwarningSubstanceAdministration.consumable.manufacturedProductSHOULD contain manufacturerOrganization
: manufacturerOrganization.exists()
should-text-ref-valuewarningSubstanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSubstanceAdministration.entryRelationship:priorityPreference.observation, SubstanceAdministration.entryRelationship:indication.observation, SubstanceAdministration.entryRelationship:instruction.actSHOULD contain text/reference/@value
: text.reference.value.exists()
should-translationwarningSubstanceAdministration.routeCodeSHOULD contain translation
: translation.exists()
should-unitwarningSubstanceAdministration.doseQuantitySHOULD contain @unit
: nullFlavor.exists() or unit.exists()
value-starts-octothorpeerrorSubstanceAdministration.text.referenceIf 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 & Constraintsdoco
.. SubstanceAdministration C1..1SubstanceAdministrationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:planned-immunization-activity 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.120
... @classCode 1..1csBinding: ActClass (2.0.0) (required)
Fixed Value: SBADM
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... id 1..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (example)
... @negationInd 0..1bl
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 (example)
... 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 C0..1CEBinding: SPL Drug Route of Administration Terminology (required)
should-translation: SHOULD contain translation
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 C0..1IVL_PQshould-unit: SHOULD contain @unit
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @unit 0..1csNOTE: 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 (required)
.... @value 0..1real
.... translation 0..*PQR
.... @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 (example)
... consumable 1..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: CSM
.... manufacturedProduct C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ActRelationshipType (required)
Fixed Value: PRCN
..... criterion 1..1PreconditionforSubstanceAdministrationBase for all types and resources
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.templateId:planned-immunization-activity.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply
SubstanceAdministration.codeexampleActSubstanceAdministrationCode
SubstanceAdministration.text.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.text.compressionrequiredCDACompressionAlgorithm
SubstanceAdministration.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
SubstanceAdministration.text.mediaTypeexampleMediaType
SubstanceAdministration.text.representationrequiredBinaryDataEncoding
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.priorityCodeexampleActPriority
SubstanceAdministration.routeCoderequiredSPLDrugRouteOfAdministrationTerminology
SubstanceAdministration.routeCode.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.routeCode.translationrequiredMedicationRoute
SubstanceAdministration.approachSiteCoderequiredBodySiteValueSet
SubstanceAdministration.doseQuantity.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive (a valid code from UCUM)
SubstanceAdministration.doseQuantity.operatorrequiredSetOperator
SubstanceAdministration.administrationUnitCodeexampleAdministrableDrugForm
SubstanceAdministration.consumable.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.consumable.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
SubstanceAdministration.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
SubstanceAdministration.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeCoderequiredFixed Value: RSON
SubstanceAdministration.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId.nullFlavorrequiredCDANullFlavor
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCoderequiredFixed Value: PRCN

Constraints

IdGradePath(s)DetailsRequirements
product-choiceerrorSubstanceAdministration.consumable.manufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
should-authorwarningSubstanceAdministration.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningSubstanceAdministration.entryRelationship:priorityPreference.observation, SubstanceAdministration.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-manufacturerOrganizationwarningSubstanceAdministration.consumable.manufacturedProductSHOULD contain manufacturerOrganization
: manufacturerOrganization.exists()
should-text-ref-valuewarningSubstanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSubstanceAdministration.entryRelationship:priorityPreference.observation, SubstanceAdministration.entryRelationship:indication.observation, SubstanceAdministration.entryRelationship:instruction.actSHOULD contain text/reference/@value
: text.reference.value.exists()
should-translationwarningSubstanceAdministration.routeCodeSHOULD contain translation
: translation.exists()
should-unitwarningSubstanceAdministration.doseQuantitySHOULD contain @unit
: nullFlavor.exists() or unit.exists()
value-starts-octothorpeerrorSubstanceAdministration.text.referenceIf 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 Value: 4 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