This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Logical Model: Immunization Activity

An Immunization Activity describes immunization substance administrations that have actually occurred or are intended to occur. Immunization Activities in "INT" mood are reflections of immunizations a clinician intends a patient to receive. Immunization Activities in "EVN" mood reflect immunizations actually received.

An Immunization Activity is very similar to a Medication Activity with some key differentiators. The drug code system is constrained to CVX codes. Administration timing is less complex. Patient refusal reasons should be captured. All vaccines administered should be fully documented in the patient's permanent medical record. Healthcare providers who administer vaccines covered by the National Childhood Vaccine Injury Act are required to ensure that the permanent medical record of the recipient indicates:

1. Date of administration
2. Vaccine manufacturer
3. Vaccine lot number
4. Name and title of the person who administered the vaccine and the address of the clinic or facility where the permanent record will reside
5. Vaccine information statement (VIS)
   1. Date printed on the VIS
   2. Date VIS given to patient or parent/guardian.

This information should be included in an Immunization Activity when available. Reference: CDC Instructions

Templates Used

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

Optional EntryRelationships: ImmunizationNotGivenReason, Indication, InstructionObservation, MedicationDispense, MedicationSupplyOrder, ReactionObservation, SubstanceAdministeredAct

Usages:

• Use this Logical Model Profile: Immunizations Section, Intervention Act and Planned Intervention Act

Formal Views of Template Content

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

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

This structure is derived from SubstanceAdministration

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
SubstanceAdministration	C	1..1	SubstanceAdministration	XML 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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-doseQuantity, dose-unit-or-admin-unit, should-performer, should-author
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:immunization-activity		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.4.52
@extension		1..1	st	Required Pattern: 2015-08-01
@classCode		1..1	cs
@moodCode		1..1	cs	Binding: MoodCodeEvnInt (required)
id		1..*	II
code		0..1	CD	SubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set.
@negationInd		1..1	bl	Use negationInd="true" to indicate that the immunization was not given.
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
@nullFlavor		0..0
@code		1..1	cs	Binding: ActStatus (required)
effectiveTime		1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
repeatNumber	C	0..1	IVL_INT	In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. Constraints: value-only
@value		0..1	int	value should be used instead of low/high
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..1	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)
administrationUnitCode		0..1	CE	Binding: AdministrationUnitDoseForm (required)
consumable		1..1	InfrastructureRoot
manufacturedProduct		1..1	ImmunizationMedicationInformation
performer		0..1	Performer2
author		0..*	AuthorParticipation
Slices for participant		0..*	Participant2	Slice: Unordered, Open by value:typeCode
participant:drugVehicle		0..*	Participant2
@typeCode		1..1	cs	Fixed Value: CSM
participantRole		1..1	DrugVehicle
Slices for entryRelationship		0..*	EntryRelationship	Slice: Unordered, Open by profile:act, profile:observation, profile:supply
entryRelationship:indication		0..*	EntryRelationship
@typeCode		1..1	cs	Fixed Value: RSON
observation		1..1	Indication
code		1..1	CD	Indication for Immunization
@code		1..1	cs	Required Pattern: 59785-6
@codeSystem		1..1	oid, uuid, ruid	LOINC Required Pattern: 2.16.840.1.113883.6.1
entryRelationship:instruction		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: SUBJ
@inversionInd		1..1	bl	Fixed Value: true
observation		1..1	InstructionObservation
entryRelationship:medSupplyOrder		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: REFR
supply		1..1	MedicationSupplyOrder
entryRelationship:medDispense		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: REFR
supply		1..1	MedicationDispense
entryRelationship:reactionObs		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: CAUS
observation		1..1	ReactionObservation
entryRelationship:immunizationNotGiven		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: RSON
observation		1..1	ImmunizationNotGivenReason
entryRelationship:substanceAdmin		0..*	EntryRelationship	The following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
@typeCode		1..1	cs	Fixed Value: COMP
@inversionInd		1..1	bl	Fixed Value: true
sequenceNumber		0..1	INT
act		1..1	SubstanceAdministeredAct
Slices for precondition		0..*	Precondition	Slice: Unordered, Open by profile:criterion
precondition:substanceAdmin		0..*	Precondition
@typeCode		1..1	cs
criterion		1..1	PreconditionforSubstanceAdministration
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
SubstanceAdministration.moodCode	required	MoodCodeEvnInt http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 From https://vsac.nlm.nih.gov
SubstanceAdministration.statusCode.code	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.routeCode	required	SPLDrugRouteOfAdministrationTerminology http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7 From https://vsac.nlm.nih.gov
SubstanceAdministration.routeCode.translation	preferred	MedicationRoute http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12 From https://vsac.nlm.nih.gov
SubstanceAdministration.approachSiteCode	required	BodySiteValueSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9 From https://vsac.nlm.nih.gov
SubstanceAdministration.doseQuantity.unit	preferred	UnitsOfMeasureCaseSensitive(a valid code from UCUM) http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
SubstanceAdministration.administrationUnitCode	required	AdministrationUnitDoseForm http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30 From https://vsac.nlm.nih.gov

Constraints

Id	Grade	Path(s)	Details	Requirements
dose-unit-or-admin-unit	error	SubstanceAdministration	If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty()
should-author	warning	SubstanceAdministration	SHOULD contain author : author.exists()
should-doseQuantity	warning	SubstanceAdministration	SHOULD contain doseQuantity : doseQuantity.exists()
should-performer	warning	SubstanceAdministration	SHOULD contain performer : performer.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-only	error	SubstanceAdministration.repeatNumber	Interval fields SHALL NOT be present : (low | high | width | center).empty()
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('#')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
SubstanceAdministration	C	1..1	SubstanceAdministration	XML 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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-doseQuantity, dose-unit-or-admin-unit, should-performer, should-author
@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, value:extension
templateId: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.52
@extension		1..1	st	Required Pattern: 2015-08-01
@classCode		1..1	cs	Binding: CDAActClass (required) Fixed Value: SBADM
@moodCode		1..1	cs	Binding: MoodCodeEvnInt (required)
id		1..*	II
code		0..1	CD	SubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set. Binding: CDAActSubstanceAdministrationCode (example)
@negationInd		1..1	bl	Use negationInd="true" to indicate that the immunization was not given.
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)
@code		1..1	cs	Binding: ActStatus (required)
@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
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
repeatNumber	C	0..1	IVL_INT	In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. Constraints: value-only
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	int	value should be used instead of low/high
@operator		0..1	cs	Binding: CDASetOperator (required)
low		0..1	IVXB_INT
center		0..1	INT
width		0..1	INT
high		0..1	IVXB_INT
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..1	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: AdministrationUnitDoseForm (required)
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..1	Performer2
author		0..*	AuthorParticipation
informant		0..*	Informant
Slices for participant		0..*	Participant2	Slice: Unordered, Open by value:typeCode
participant:drugVehicle		0..*	Participant2
@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: CDAParticipationType (required) Fixed Value: CSM
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
sdtcFunctionCode		0..1	CE	XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc)
time		0..1	IVL_TS
awarenessCode		0..1	CE
participantRole		1..1	DrugVehicle
Slices for entryRelationship		0..*	EntryRelationship	Slice: Unordered, Open by profile:act, profile:observation, profile:supply
entryRelationship:indication		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: 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
@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, value:extension
templateId:indication		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.19
@extension		1..1	st	Required Pattern: 2023-05-01
@classCode		1..1	cs	Binding: CDAActClassObservation (required) Fixed Value: OBS
@moodCode		1..1	cs	Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN
@negationInd		0..1	bl
id		1..*	II	If the id element is used to reference a problem recorded elsewhere in the document then this id must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. Its purpose is to obviate the need to repeat the complete XML representation of the referred to entry when relating one entry to another.
sdtcCategory		0..*	CD	XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc)
code		1..1	CD	Indication for Immunization Binding: Problem Type (preferred)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		1..1	cs	Required Pattern: 59785-6
@codeSystem		1..1	oid, uuid, ruid	LOINC Required Pattern: 2.16.840.1.113883.6.1
@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
qualifier		0..*	CR
translation		0..*	CD
derivationExpr		0..1	ST
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: completed
@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		0..1	IVL_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
repeatNumber		0..1	IVL_INT
languageCode		0..1	CS	Binding: AllLanguages (required)
value		0..1	CD	If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. Binding: US Core Condition Codes (preferred)
interpretationCode		0..*	CE	Binding: CDAObservationInterpretation (required)
methodCode		0..*	CE	Binding: ObservationMethod (example)
targetSiteCode		0..*	CD
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
entryRelationship		0..*	EntryRelationship
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
referenceRange		0..*	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: CDAActRelationshipType (required) Fixed Value: REFV
observationRange		1..1	ObservationRange
sdtcInFulfillmentOf1		0..*	InFulfillmentOf1	XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
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..1	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		1..1	bl	Fixed Value: true
@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
entryRelationship:medSupplyOrder		0..1	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: 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		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		1..1	MedicationSupplyOrder
entryRelationship:medDispense		0..1	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: 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		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		1..1	MedicationDispense
entryRelationship:reactionObs		0..1	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: CAUS
@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	ReactionObservation
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:immunizationNotGiven		0..1	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: 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	ImmunizationNotGivenReason
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:substanceAdmin		0..*	EntryRelationship	The following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
@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: COMP
@inversionInd		1..1	bl	Fixed Value: true
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		1..1	SubstanceAdministeredAct
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
reference		0..*	Reference
Slices for precondition		0..*	Precondition	Slice: Unordered, Open by profile:criterion
precondition:substanceAdmin		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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
SubstanceAdministration.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.templateId:immunization-activity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.classCode	required	Fixed Value: SBADM http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCode	required	MoodCodeEvnInt http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 From https://vsac.nlm.nih.gov
SubstanceAdministration.code	example	CDAActSubstanceAdministrationCode http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode
SubstanceAdministration.text.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.text.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.text.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.text.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.statusCode.code	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.repeatNumber.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.repeatNumber.operator	required	CDASetOperator http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.routeCode	required	SPLDrugRouteOfAdministrationTerminology http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7 From https://vsac.nlm.nih.gov
SubstanceAdministration.routeCode.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.routeCode.translation	preferred	MedicationRoute http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12 From https://vsac.nlm.nih.gov
SubstanceAdministration.approachSiteCode	required	BodySiteValueSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9 From https://vsac.nlm.nih.gov
SubstanceAdministration.doseQuantity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.doseQuantity.unit	preferred	UnitsOfMeasureCaseSensitive(a valid code from UCUM) http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
SubstanceAdministration.doseQuantity.operator	required	CDASetOperator http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.administrationUnitCode	required	AdministrationUnitDoseForm http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30 From https://vsac.nlm.nih.gov
SubstanceAdministration.consumable.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeCode	required	Fixed Value: CSM http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.participant:drugVehicle.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.participant:drugVehicle.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.participant:drugVehicle.typeCode	required	Fixed Value: CSM http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.participant:drugVehicle.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
SubstanceAdministration.entryRelationship:indication.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeCode	required	Fixed Value: RSON http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:indication.observation.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.templateId:indication.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.classCode	required	Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
SubstanceAdministration.entryRelationship:indication.observation.moodCode	required	Fixed Value: EVN http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
SubstanceAdministration.entryRelationship:indication.observation.code	preferred	ProblemType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.1 From https://vsac.nlm.nih.gov
SubstanceAdministration.entryRelationship:indication.observation.code.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.text.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.text.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.entryRelationship:indication.observation.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.entryRelationship:indication.observation.text.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.entryRelationship:indication.observation.text.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.entryRelationship:indication.observation.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.entryRelationship:indication.observation.statusCode.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.entryRelationship:indication.observation.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages From the FHIR Standard
SubstanceAdministration.entryRelationship:indication.observation.value	preferred	USCoreConditionCodes http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
SubstanceAdministration.entryRelationship:indication.observation.interpretationCode	required	CDAObservationInterpretation http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
SubstanceAdministration.entryRelationship:indication.observation.methodCode	example	ObservationMethod http://terminology.hl7.org/ValueSet/v3-ObservationMethod
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeCode	required	Fixed Value: REFV http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
SubstanceAdministration.entryRelationship:instruction.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCode	required	Fixed Value: SUBJ http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:medSupplyOrder.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medSupplyOrder.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medSupplyOrder.typeCode	required	Fixed Value: REFR http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:medDispense.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medDispense.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medDispense.typeCode	required	Fixed Value: REFR http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:reactionObs.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:reactionObs.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:reactionObs.typeCode	required	Fixed Value: CAUS http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:immunizationNotGiven.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:immunizationNotGiven.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:immunizationNotGiven.typeCode	required	Fixed Value: RSON http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:substanceAdmin.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:substanceAdmin.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:substanceAdmin.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.precondition:substanceAdmin.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeCode	required	Fixed Value: PRCN http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.participant:drugVehicle.typeId, SubstanceAdministration.entryRelationship:indication.typeId, SubstanceAdministration.entryRelationship:indication.observation.typeId, SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeId, SubstanceAdministration.entryRelationship:instruction.typeId, SubstanceAdministration.entryRelationship:medSupplyOrder.typeId, SubstanceAdministration.entryRelationship:medDispense.typeId, SubstanceAdministration.entryRelationship:reactionObs.typeId, SubstanceAdministration.entryRelationship:immunizationNotGiven.typeId, SubstanceAdministration.entryRelationship:substanceAdmin.typeId, SubstanceAdministration.precondition:substanceAdmin.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
dose-unit-or-admin-unit	error	SubstanceAdministration	If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty()
should-author	warning	SubstanceAdministration	SHOULD contain author : author.exists()
should-doseQuantity	warning	SubstanceAdministration	SHOULD contain doseQuantity : doseQuantity.exists()
should-performer	warning	SubstanceAdministration	SHOULD contain performer : performer.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-only	error	SubstanceAdministration.repeatNumber	Interval fields SHALL NOT be present : (low | high | width | center).empty()
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('#')
value-starts-octothorpe	error	SubstanceAdministration.entryRelationship:indication.observation.text.reference	If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
SubstanceAdministration	C	1..1	SubstanceAdministration	XML 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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-doseQuantity, dose-unit-or-admin-unit, should-performer, should-author
@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, value:extension
templateId: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.52
@extension		1..1	st	Required Pattern: 2015-08-01
@classCode		1..1	cs	Binding: CDAActClass (required) Fixed Value: SBADM
@moodCode		1..1	cs	Binding: MoodCodeEvnInt (required)
id		1..*	II
code		0..1	CD	SubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set. Binding: CDAActSubstanceAdministrationCode (example)
@negationInd		1..1	bl	Use negationInd="true" to indicate that the immunization was not given.
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)
@code		1..1	cs	Binding: ActStatus (required)
@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
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
repeatNumber	C	0..1	IVL_INT	In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. Constraints: value-only
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	int	value should be used instead of low/high
@operator		0..1	cs	Binding: CDASetOperator (required)
low		0..1	IVXB_INT
center		0..1	INT
width		0..1	INT
high		0..1	IVXB_INT
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..1	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: AdministrationUnitDoseForm (required)
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..1	Performer2
author		0..*	AuthorParticipation
informant		0..*	Informant
Slices for participant		0..*	Participant2	Slice: Unordered, Open by value:typeCode
participant:drugVehicle		0..*	Participant2
@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: CDAParticipationType (required) Fixed Value: CSM
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
sdtcFunctionCode		0..1	CE	XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc)
time		0..1	IVL_TS
awarenessCode		0..1	CE
participantRole		1..1	DrugVehicle
Slices for entryRelationship		0..*	EntryRelationship	Slice: Unordered, Open by profile:act, profile:observation, profile:supply
entryRelationship:indication		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: 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
@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, value:extension
templateId:indication		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.19
@extension		1..1	st	Required Pattern: 2023-05-01
@classCode		1..1	cs	Binding: CDAActClassObservation (required) Fixed Value: OBS
@moodCode		1..1	cs	Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN
@negationInd		0..1	bl
id		1..*	II	If the id element is used to reference a problem recorded elsewhere in the document then this id must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. Its purpose is to obviate the need to repeat the complete XML representation of the referred to entry when relating one entry to another.
sdtcCategory		0..*	CD	XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc)
code		1..1	CD	Indication for Immunization Binding: Problem Type (preferred)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		1..1	cs	Required Pattern: 59785-6
@codeSystem		1..1	oid, uuid, ruid	LOINC Required Pattern: 2.16.840.1.113883.6.1
@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
qualifier		0..*	CR
translation		0..*	CD
derivationExpr		0..1	ST
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: completed
@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		0..1	IVL_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
repeatNumber		0..1	IVL_INT
languageCode		0..1	CS	Binding: AllLanguages (required)
value		0..1	CD	If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. Binding: US Core Condition Codes (preferred)
interpretationCode		0..*	CE	Binding: CDAObservationInterpretation (required)
methodCode		0..*	CE	Binding: ObservationMethod (example)
targetSiteCode		0..*	CD
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
entryRelationship		0..*	EntryRelationship
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
referenceRange		0..*	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: CDAActRelationshipType (required) Fixed Value: REFV
observationRange		1..1	ObservationRange
sdtcInFulfillmentOf1		0..*	InFulfillmentOf1	XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
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..1	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		1..1	bl	Fixed Value: true
@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
entryRelationship:medSupplyOrder		0..1	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: 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		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		1..1	MedicationSupplyOrder
entryRelationship:medDispense		0..1	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: 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		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		1..1	MedicationDispense
entryRelationship:reactionObs		0..1	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: CAUS
@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	ReactionObservation
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:immunizationNotGiven		0..1	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: 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	ImmunizationNotGivenReason
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:substanceAdmin		0..*	EntryRelationship	The following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
@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: COMP
@inversionInd		1..1	bl	Fixed Value: true
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		1..1	SubstanceAdministeredAct
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
reference		0..*	Reference
Slices for precondition		0..*	Precondition	Slice: Unordered, Open by profile:criterion
precondition:substanceAdmin		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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
SubstanceAdministration.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.templateId:immunization-activity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.classCode	required	Fixed Value: SBADM http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCode	required	MoodCodeEvnInt http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 From https://vsac.nlm.nih.gov
SubstanceAdministration.code	example	CDAActSubstanceAdministrationCode http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode
SubstanceAdministration.text.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.text.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.text.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.text.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.statusCode.code	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.repeatNumber.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.repeatNumber.operator	required	CDASetOperator http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.routeCode	required	SPLDrugRouteOfAdministrationTerminology http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7 From https://vsac.nlm.nih.gov
SubstanceAdministration.routeCode.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.routeCode.translation	preferred	MedicationRoute http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12 From https://vsac.nlm.nih.gov
SubstanceAdministration.approachSiteCode	required	BodySiteValueSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9 From https://vsac.nlm.nih.gov
SubstanceAdministration.doseQuantity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.doseQuantity.unit	preferred	UnitsOfMeasureCaseSensitive(a valid code from UCUM) http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
SubstanceAdministration.doseQuantity.operator	required	CDASetOperator http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.administrationUnitCode	required	AdministrationUnitDoseForm http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30 From https://vsac.nlm.nih.gov
SubstanceAdministration.consumable.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeCode	required	Fixed Value: CSM http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.participant:drugVehicle.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.participant:drugVehicle.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.participant:drugVehicle.typeCode	required	Fixed Value: CSM http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.participant:drugVehicle.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
SubstanceAdministration.entryRelationship:indication.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeCode	required	Fixed Value: RSON http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:indication.observation.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.templateId:indication.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.classCode	required	Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
SubstanceAdministration.entryRelationship:indication.observation.moodCode	required	Fixed Value: EVN http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
SubstanceAdministration.entryRelationship:indication.observation.code	preferred	ProblemType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.1 From https://vsac.nlm.nih.gov
SubstanceAdministration.entryRelationship:indication.observation.code.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.text.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.text.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.entryRelationship:indication.observation.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.entryRelationship:indication.observation.text.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.entryRelationship:indication.observation.text.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.entryRelationship:indication.observation.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.entryRelationship:indication.observation.statusCode.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.entryRelationship:indication.observation.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages From the FHIR Standard
SubstanceAdministration.entryRelationship:indication.observation.value	preferred	USCoreConditionCodes http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
SubstanceAdministration.entryRelationship:indication.observation.interpretationCode	required	CDAObservationInterpretation http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
SubstanceAdministration.entryRelationship:indication.observation.methodCode	example	ObservationMethod http://terminology.hl7.org/ValueSet/v3-ObservationMethod
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeCode	required	Fixed Value: REFV http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
SubstanceAdministration.entryRelationship:instruction.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCode	required	Fixed Value: SUBJ http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:medSupplyOrder.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medSupplyOrder.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medSupplyOrder.typeCode	required	Fixed Value: REFR http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:medDispense.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medDispense.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medDispense.typeCode	required	Fixed Value: REFR http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:reactionObs.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:reactionObs.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:reactionObs.typeCode	required	Fixed Value: CAUS http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:immunizationNotGiven.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:immunizationNotGiven.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:immunizationNotGiven.typeCode	required	Fixed Value: RSON http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:substanceAdmin.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:substanceAdmin.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:substanceAdmin.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.precondition:substanceAdmin.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeCode	required	Fixed Value: PRCN http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.participant:drugVehicle.typeId, SubstanceAdministration.entryRelationship:indication.typeId, SubstanceAdministration.entryRelationship:indication.observation.typeId, SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeId, SubstanceAdministration.entryRelationship:instruction.typeId, SubstanceAdministration.entryRelationship:medSupplyOrder.typeId, SubstanceAdministration.entryRelationship:medDispense.typeId, SubstanceAdministration.entryRelationship:reactionObs.typeId, SubstanceAdministration.entryRelationship:immunizationNotGiven.typeId, SubstanceAdministration.entryRelationship:substanceAdmin.typeId, SubstanceAdministration.precondition:substanceAdmin.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
dose-unit-or-admin-unit	error	SubstanceAdministration	If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty()
should-author	warning	SubstanceAdministration	SHOULD contain author : author.exists()
should-doseQuantity	warning	SubstanceAdministration	SHOULD contain doseQuantity : doseQuantity.exists()
should-performer	warning	SubstanceAdministration	SHOULD contain performer : performer.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-only	error	SubstanceAdministration.repeatNumber	Interval fields SHALL NOT be present : (low | high | width | center).empty()
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('#')
value-starts-octothorpe	error	SubstanceAdministration.entryRelationship:indication.observation.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: 9 elements(12 nested mandatory elements)
Fixed: 10 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• Immunization Medication Information (http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationMedicationInformation)
• Author Participation (http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation)
• Drug Vehicle (http://hl7.org/cda/us/ccda/StructureDefinition/DrugVehicle)
• Indication (http://hl7.org/cda/us/ccda/StructureDefinition/Indication)
• Instruction Observation (http://hl7.org/cda/us/ccda/StructureDefinition/InstructionObservation)
• Medication Supply Order (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationSupplyOrder)
• Medication Dispense (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationDispense)
• Reaction Observation (http://hl7.org/cda/us/ccda/StructureDefinition/ReactionObservation)
• Immunization Not Given Reason (http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationNotGivenReason)
• Substance Administered Act (http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceAdministeredAct)
• Precondition for Substance Administration (http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration)

Slices

This structure defines the following Slices:

• The element 2 is sliced based on the values of SubstanceAdministration.templateId
• The element 1 is sliced based on the value of SubstanceAdministration.participant
• The element 3 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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
SubstanceAdministration	C	1..1	SubstanceAdministration	XML 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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-doseQuantity, dose-unit-or-admin-unit, should-performer, should-author
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:immunization-activity		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.4.52
@extension		1..1	st	Required Pattern: 2015-08-01
@classCode		1..1	cs
@moodCode		1..1	cs	Binding: MoodCodeEvnInt (required)
id		1..*	II
code		0..1	CD	SubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set.
@negationInd		1..1	bl	Use negationInd="true" to indicate that the immunization was not given.
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
@nullFlavor		0..0
@code		1..1	cs	Binding: ActStatus (required)
effectiveTime		1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
repeatNumber	C	0..1	IVL_INT	In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. Constraints: value-only
@value		0..1	int	value should be used instead of low/high
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..1	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)
administrationUnitCode		0..1	CE	Binding: AdministrationUnitDoseForm (required)
consumable		1..1	InfrastructureRoot
manufacturedProduct		1..1	ImmunizationMedicationInformation
performer		0..1	Performer2
author		0..*	AuthorParticipation
Slices for participant		0..*	Participant2	Slice: Unordered, Open by value:typeCode
participant:drugVehicle		0..*	Participant2
@typeCode		1..1	cs	Fixed Value: CSM
participantRole		1..1	DrugVehicle
Slices for entryRelationship		0..*	EntryRelationship	Slice: Unordered, Open by profile:act, profile:observation, profile:supply
entryRelationship:indication		0..*	EntryRelationship
@typeCode		1..1	cs	Fixed Value: RSON
observation		1..1	Indication
code		1..1	CD	Indication for Immunization
@code		1..1	cs	Required Pattern: 59785-6
@codeSystem		1..1	oid, uuid, ruid	LOINC Required Pattern: 2.16.840.1.113883.6.1
entryRelationship:instruction		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: SUBJ
@inversionInd		1..1	bl	Fixed Value: true
observation		1..1	InstructionObservation
entryRelationship:medSupplyOrder		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: REFR
supply		1..1	MedicationSupplyOrder
entryRelationship:medDispense		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: REFR
supply		1..1	MedicationDispense
entryRelationship:reactionObs		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: CAUS
observation		1..1	ReactionObservation
entryRelationship:immunizationNotGiven		0..1	EntryRelationship
@typeCode		1..1	cs	Fixed Value: RSON
observation		1..1	ImmunizationNotGivenReason
entryRelationship:substanceAdmin		0..*	EntryRelationship	The following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
@typeCode		1..1	cs	Fixed Value: COMP
@inversionInd		1..1	bl	Fixed Value: true
sequenceNumber		0..1	INT
act		1..1	SubstanceAdministeredAct
Slices for precondition		0..*	Precondition	Slice: Unordered, Open by profile:criterion
precondition:substanceAdmin		0..*	Precondition
@typeCode		1..1	cs
criterion		1..1	PreconditionforSubstanceAdministration
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
SubstanceAdministration.moodCode	required	MoodCodeEvnInt http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 From https://vsac.nlm.nih.gov
SubstanceAdministration.statusCode.code	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.routeCode	required	SPLDrugRouteOfAdministrationTerminology http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7 From https://vsac.nlm.nih.gov
SubstanceAdministration.routeCode.translation	preferred	MedicationRoute http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12 From https://vsac.nlm.nih.gov
SubstanceAdministration.approachSiteCode	required	BodySiteValueSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9 From https://vsac.nlm.nih.gov
SubstanceAdministration.doseQuantity.unit	preferred	UnitsOfMeasureCaseSensitive(a valid code from UCUM) http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
SubstanceAdministration.administrationUnitCode	required	AdministrationUnitDoseForm http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30 From https://vsac.nlm.nih.gov

Constraints

Id	Grade	Path(s)	Details	Requirements
dose-unit-or-admin-unit	error	SubstanceAdministration	If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty()
should-author	warning	SubstanceAdministration	SHOULD contain author : author.exists()
should-doseQuantity	warning	SubstanceAdministration	SHOULD contain doseQuantity : doseQuantity.exists()
should-performer	warning	SubstanceAdministration	SHOULD contain performer : performer.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-only	error	SubstanceAdministration.repeatNumber	Interval fields SHALL NOT be present : (low | high | width | center).empty()
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
SubstanceAdministration	C	1..1	SubstanceAdministration	XML 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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-doseQuantity, dose-unit-or-admin-unit, should-performer, should-author
@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, value:extension
templateId: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.52
@extension		1..1	st	Required Pattern: 2015-08-01
@classCode		1..1	cs	Binding: CDAActClass (required) Fixed Value: SBADM
@moodCode		1..1	cs	Binding: MoodCodeEvnInt (required)
id		1..*	II
code		0..1	CD	SubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set. Binding: CDAActSubstanceAdministrationCode (example)
@negationInd		1..1	bl	Use negationInd="true" to indicate that the immunization was not given.
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)
@code		1..1	cs	Binding: ActStatus (required)
@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
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
repeatNumber	C	0..1	IVL_INT	In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. Constraints: value-only
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	int	value should be used instead of low/high
@operator		0..1	cs	Binding: CDASetOperator (required)
low		0..1	IVXB_INT
center		0..1	INT
width		0..1	INT
high		0..1	IVXB_INT
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..1	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: AdministrationUnitDoseForm (required)
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..1	Performer2
author		0..*	AuthorParticipation
informant		0..*	Informant
Slices for participant		0..*	Participant2	Slice: Unordered, Open by value:typeCode
participant:drugVehicle		0..*	Participant2
@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: CDAParticipationType (required) Fixed Value: CSM
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
sdtcFunctionCode		0..1	CE	XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc)
time		0..1	IVL_TS
awarenessCode		0..1	CE
participantRole		1..1	DrugVehicle
Slices for entryRelationship		0..*	EntryRelationship	Slice: Unordered, Open by profile:act, profile:observation, profile:supply
entryRelationship:indication		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: 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
@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, value:extension
templateId:indication		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.19
@extension		1..1	st	Required Pattern: 2023-05-01
@classCode		1..1	cs	Binding: CDAActClassObservation (required) Fixed Value: OBS
@moodCode		1..1	cs	Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN
@negationInd		0..1	bl
id		1..*	II	If the id element is used to reference a problem recorded elsewhere in the document then this id must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. Its purpose is to obviate the need to repeat the complete XML representation of the referred to entry when relating one entry to another.
sdtcCategory		0..*	CD	XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc)
code		1..1	CD	Indication for Immunization Binding: Problem Type (preferred)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		1..1	cs	Required Pattern: 59785-6
@codeSystem		1..1	oid, uuid, ruid	LOINC Required Pattern: 2.16.840.1.113883.6.1
@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
qualifier		0..*	CR
translation		0..*	CD
derivationExpr		0..1	ST
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: completed
@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		0..1	IVL_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
repeatNumber		0..1	IVL_INT
languageCode		0..1	CS	Binding: AllLanguages (required)
value		0..1	CD	If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. Binding: US Core Condition Codes (preferred)
interpretationCode		0..*	CE	Binding: CDAObservationInterpretation (required)
methodCode		0..*	CE	Binding: ObservationMethod (example)
targetSiteCode		0..*	CD
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
entryRelationship		0..*	EntryRelationship
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
referenceRange		0..*	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: CDAActRelationshipType (required) Fixed Value: REFV
observationRange		1..1	ObservationRange
sdtcInFulfillmentOf1		0..*	InFulfillmentOf1	XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
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..1	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		1..1	bl	Fixed Value: true
@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
entryRelationship:medSupplyOrder		0..1	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: 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		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		1..1	MedicationSupplyOrder
entryRelationship:medDispense		0..1	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: 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		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		1..1	MedicationDispense
entryRelationship:reactionObs		0..1	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: CAUS
@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	ReactionObservation
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:immunizationNotGiven		0..1	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: 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	ImmunizationNotGivenReason
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:substanceAdmin		0..*	EntryRelationship	The following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
@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: COMP
@inversionInd		1..1	bl	Fixed Value: true
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		1..1	SubstanceAdministeredAct
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
reference		0..*	Reference
Slices for precondition		0..*	Precondition	Slice: Unordered, Open by profile:criterion
precondition:substanceAdmin		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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
SubstanceAdministration.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.templateId:immunization-activity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.classCode	required	Fixed Value: SBADM http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCode	required	MoodCodeEvnInt http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 From https://vsac.nlm.nih.gov
SubstanceAdministration.code	example	CDAActSubstanceAdministrationCode http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode
SubstanceAdministration.text.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.text.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.text.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.text.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.statusCode.code	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.repeatNumber.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.repeatNumber.operator	required	CDASetOperator http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.routeCode	required	SPLDrugRouteOfAdministrationTerminology http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7 From https://vsac.nlm.nih.gov
SubstanceAdministration.routeCode.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.routeCode.translation	preferred	MedicationRoute http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12 From https://vsac.nlm.nih.gov
SubstanceAdministration.approachSiteCode	required	BodySiteValueSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9 From https://vsac.nlm.nih.gov
SubstanceAdministration.doseQuantity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.doseQuantity.unit	preferred	UnitsOfMeasureCaseSensitive(a valid code from UCUM) http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
SubstanceAdministration.doseQuantity.operator	required	CDASetOperator http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.administrationUnitCode	required	AdministrationUnitDoseForm http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30 From https://vsac.nlm.nih.gov
SubstanceAdministration.consumable.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeCode	required	Fixed Value: CSM http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.participant:drugVehicle.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.participant:drugVehicle.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.participant:drugVehicle.typeCode	required	Fixed Value: CSM http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.participant:drugVehicle.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
SubstanceAdministration.entryRelationship:indication.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeCode	required	Fixed Value: RSON http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:indication.observation.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.templateId:indication.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.classCode	required	Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
SubstanceAdministration.entryRelationship:indication.observation.moodCode	required	Fixed Value: EVN http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
SubstanceAdministration.entryRelationship:indication.observation.code	preferred	ProblemType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.1 From https://vsac.nlm.nih.gov
SubstanceAdministration.entryRelationship:indication.observation.code.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.text.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.text.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.entryRelationship:indication.observation.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.entryRelationship:indication.observation.text.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.entryRelationship:indication.observation.text.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.entryRelationship:indication.observation.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.entryRelationship:indication.observation.statusCode.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.entryRelationship:indication.observation.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages From the FHIR Standard
SubstanceAdministration.entryRelationship:indication.observation.value	preferred	USCoreConditionCodes http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
SubstanceAdministration.entryRelationship:indication.observation.interpretationCode	required	CDAObservationInterpretation http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
SubstanceAdministration.entryRelationship:indication.observation.methodCode	example	ObservationMethod http://terminology.hl7.org/ValueSet/v3-ObservationMethod
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeCode	required	Fixed Value: REFV http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
SubstanceAdministration.entryRelationship:instruction.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCode	required	Fixed Value: SUBJ http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:medSupplyOrder.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medSupplyOrder.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medSupplyOrder.typeCode	required	Fixed Value: REFR http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:medDispense.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medDispense.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medDispense.typeCode	required	Fixed Value: REFR http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:reactionObs.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:reactionObs.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:reactionObs.typeCode	required	Fixed Value: CAUS http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:immunizationNotGiven.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:immunizationNotGiven.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:immunizationNotGiven.typeCode	required	Fixed Value: RSON http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:substanceAdmin.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:substanceAdmin.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:substanceAdmin.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.precondition:substanceAdmin.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeCode	required	Fixed Value: PRCN http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.participant:drugVehicle.typeId, SubstanceAdministration.entryRelationship:indication.typeId, SubstanceAdministration.entryRelationship:indication.observation.typeId, SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeId, SubstanceAdministration.entryRelationship:instruction.typeId, SubstanceAdministration.entryRelationship:medSupplyOrder.typeId, SubstanceAdministration.entryRelationship:medDispense.typeId, SubstanceAdministration.entryRelationship:reactionObs.typeId, SubstanceAdministration.entryRelationship:immunizationNotGiven.typeId, SubstanceAdministration.entryRelationship:substanceAdmin.typeId, SubstanceAdministration.precondition:substanceAdmin.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
dose-unit-or-admin-unit	error	SubstanceAdministration	If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty()
should-author	warning	SubstanceAdministration	SHOULD contain author : author.exists()
should-doseQuantity	warning	SubstanceAdministration	SHOULD contain doseQuantity : doseQuantity.exists()
should-performer	warning	SubstanceAdministration	SHOULD contain performer : performer.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-only	error	SubstanceAdministration.repeatNumber	Interval fields SHALL NOT be present : (low | high | width | center).empty()
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('#')
value-starts-octothorpe	error	SubstanceAdministration.entryRelationship:indication.observation.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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
SubstanceAdministration	C	1..1	SubstanceAdministration	XML 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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-doseQuantity, dose-unit-or-admin-unit, should-performer, should-author
@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, value:extension
templateId: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.52
@extension		1..1	st	Required Pattern: 2015-08-01
@classCode		1..1	cs	Binding: CDAActClass (required) Fixed Value: SBADM
@moodCode		1..1	cs	Binding: MoodCodeEvnInt (required)
id		1..*	II
code		0..1	CD	SubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set. Binding: CDAActSubstanceAdministrationCode (example)
@negationInd		1..1	bl	Use negationInd="true" to indicate that the immunization was not given.
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)
@code		1..1	cs	Binding: ActStatus (required)
@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
effectiveTime			SXCM_TS
effectiveTime			IVL_TS
effectiveTime			EIVL_TS
effectiveTime			PIVL_TS
effectiveTime			SXPR_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
repeatNumber	C	0..1	IVL_INT	In "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series. Constraints: value-only
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	int	value should be used instead of low/high
@operator		0..1	cs	Binding: CDASetOperator (required)
low		0..1	IVXB_INT
center		0..1	INT
width		0..1	INT
high		0..1	IVXB_INT
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..1	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: AdministrationUnitDoseForm (required)
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..1	Performer2
author		0..*	AuthorParticipation
informant		0..*	Informant
Slices for participant		0..*	Participant2	Slice: Unordered, Open by value:typeCode
participant:drugVehicle		0..*	Participant2
@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: CDAParticipationType (required) Fixed Value: CSM
@contextControlCode		0..1	cs	Binding: CDAContextControl (required) Fixed Value: OP
sdtcFunctionCode		0..1	CE	XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc)
time		0..1	IVL_TS
awarenessCode		0..1	CE
participantRole		1..1	DrugVehicle
Slices for entryRelationship		0..*	EntryRelationship	Slice: Unordered, Open by profile:act, profile:observation, profile:supply
entryRelationship:indication		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: 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
@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, value:extension
templateId:indication		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.19
@extension		1..1	st	Required Pattern: 2023-05-01
@classCode		1..1	cs	Binding: CDAActClassObservation (required) Fixed Value: OBS
@moodCode		1..1	cs	Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN
@negationInd		0..1	bl
id		1..*	II	If the id element is used to reference a problem recorded elsewhere in the document then this id must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. Its purpose is to obviate the need to repeat the complete XML representation of the referred to entry when relating one entry to another.
sdtcCategory		0..*	CD	XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc)
code		1..1	CD	Indication for Immunization Binding: Problem Type (preferred)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		1..1	cs	Required Pattern: 59785-6
@codeSystem		1..1	oid, uuid, ruid	LOINC Required Pattern: 2.16.840.1.113883.6.1
@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
qualifier		0..*	CR
translation		0..*	CD
derivationExpr		0..1	ST
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: completed
@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		0..1	IVL_TS
priorityCode		0..1	CE	Binding: ActPriority (example)
repeatNumber		0..1	IVL_INT
languageCode		0..1	CS	Binding: AllLanguages (required)
value		0..1	CD	If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. Binding: US Core Condition Codes (preferred)
interpretationCode		0..*	CE	Binding: CDAObservationInterpretation (required)
methodCode		0..*	CE	Binding: ObservationMethod (example)
targetSiteCode		0..*	CD
subject		0..1	Subject
specimen		0..*	Specimen
performer		0..*	Performer2
author		0..*	Author
informant		0..*	Informant
participant		0..*	Participant2
entryRelationship		0..*	EntryRelationship
reference		0..*	Reference
precondition		0..*	Precondition
sdtcPrecondition2		0..*	Precondition2	XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc)
referenceRange		0..*	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: CDAActRelationshipType (required) Fixed Value: REFV
observationRange		1..1	ObservationRange
sdtcInFulfillmentOf1		0..*	InFulfillmentOf1	XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
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..1	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		1..1	bl	Fixed Value: true
@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
entryRelationship:medSupplyOrder		0..1	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: 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		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		1..1	MedicationSupplyOrder
entryRelationship:medDispense		0..1	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: 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		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		1..1	MedicationDispense
entryRelationship:reactionObs		0..1	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: CAUS
@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	ReactionObservation
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:immunizationNotGiven		0..1	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: 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	ImmunizationNotGivenReason
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:substanceAdmin		0..*	EntryRelationship	The following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
@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: COMP
@inversionInd		1..1	bl	Fixed Value: true
@contextConductionInd		0..1	bl
@negationInd		0..1	bl
sequenceNumber		0..1	INT
seperatableInd		0..1	BL
act		1..1	SubstanceAdministeredAct
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
reference		0..*	Reference
Slices for precondition		0..*	Precondition	Slice: Unordered, Open by profile:criterion
precondition:substanceAdmin		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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
SubstanceAdministration.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.templateId:immunization-activity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.classCode	required	Fixed Value: SBADM http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCode	required	MoodCodeEvnInt http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18 From https://vsac.nlm.nih.gov
SubstanceAdministration.code	example	CDAActSubstanceAdministrationCode http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode
SubstanceAdministration.text.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.text.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.text.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.text.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.statusCode.code	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.repeatNumber.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.repeatNumber.operator	required	CDASetOperator http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.routeCode	required	SPLDrugRouteOfAdministrationTerminology http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7 From https://vsac.nlm.nih.gov
SubstanceAdministration.routeCode.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.routeCode.translation	preferred	MedicationRoute http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12 From https://vsac.nlm.nih.gov
SubstanceAdministration.approachSiteCode	required	BodySiteValueSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9 From https://vsac.nlm.nih.gov
SubstanceAdministration.doseQuantity.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.doseQuantity.unit	preferred	UnitsOfMeasureCaseSensitive(a valid code from UCUM) http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive
SubstanceAdministration.doseQuantity.operator	required	CDASetOperator http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.administrationUnitCode	required	AdministrationUnitDoseForm http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.30 From https://vsac.nlm.nih.gov
SubstanceAdministration.consumable.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeCode	required	Fixed Value: CSM http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.participant:drugVehicle.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.participant:drugVehicle.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.participant:drugVehicle.typeCode	required	Fixed Value: CSM http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.participant:drugVehicle.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
SubstanceAdministration.entryRelationship:indication.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.typeCode	required	Fixed Value: RSON http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:indication.observation.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.templateId:indication.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.classCode	required	Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
SubstanceAdministration.entryRelationship:indication.observation.moodCode	required	Fixed Value: EVN http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
SubstanceAdministration.entryRelationship:indication.observation.code	preferred	ProblemType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.1 From https://vsac.nlm.nih.gov
SubstanceAdministration.entryRelationship:indication.observation.code.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.text.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.text.compression	required	CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.entryRelationship:indication.observation.text.integrityCheckAlgorithm	required	IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.entryRelationship:indication.observation.text.mediaType	example	MediaType http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.entryRelationship:indication.observation.text.representation	required	BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.entryRelationship:indication.observation.statusCode	required	ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.entryRelationship:indication.observation.statusCode.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.priorityCode	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.entryRelationship:indication.observation.languageCode	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages From the FHIR Standard
SubstanceAdministration.entryRelationship:indication.observation.value	preferred	USCoreConditionCodes http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
SubstanceAdministration.entryRelationship:indication.observation.interpretationCode	required	CDAObservationInterpretation http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
SubstanceAdministration.entryRelationship:indication.observation.methodCode	example	ObservationMethod http://terminology.hl7.org/ValueSet/v3-ObservationMethod
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeCode	required	Fixed Value: REFV http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
SubstanceAdministration.entryRelationship:instruction.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:instruction.typeCode	required	Fixed Value: SUBJ http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:medSupplyOrder.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medSupplyOrder.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medSupplyOrder.typeCode	required	Fixed Value: REFR http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:medDispense.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medDispense.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:medDispense.typeCode	required	Fixed Value: REFR http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:reactionObs.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:reactionObs.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:reactionObs.typeCode	required	Fixed Value: CAUS http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:immunizationNotGiven.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:immunizationNotGiven.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:immunizationNotGiven.typeCode	required	Fixed Value: RSON http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.entryRelationship:substanceAdmin.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:substanceAdmin.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:substanceAdmin.typeCode	required	Fixed Value: COMP http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
SubstanceAdministration.precondition:substanceAdmin.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeCode	required	Fixed Value: PRCN http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	SubstanceAdministration.typeId, SubstanceAdministration.consumable.typeId, SubstanceAdministration.participant:drugVehicle.typeId, SubstanceAdministration.entryRelationship:indication.typeId, SubstanceAdministration.entryRelationship:indication.observation.typeId, SubstanceAdministration.entryRelationship:indication.observation.referenceRange.typeId, SubstanceAdministration.entryRelationship:instruction.typeId, SubstanceAdministration.entryRelationship:medSupplyOrder.typeId, SubstanceAdministration.entryRelationship:medDispense.typeId, SubstanceAdministration.entryRelationship:reactionObs.typeId, SubstanceAdministration.entryRelationship:immunizationNotGiven.typeId, SubstanceAdministration.entryRelationship:substanceAdmin.typeId, SubstanceAdministration.precondition:substanceAdmin.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
dose-unit-or-admin-unit	error	SubstanceAdministration	If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. : doseQuantity.unit.exists() implies administrationUnitCode.empty()
should-author	warning	SubstanceAdministration	SHOULD contain author : author.exists()
should-doseQuantity	warning	SubstanceAdministration	SHOULD contain doseQuantity : doseQuantity.exists()
should-performer	warning	SubstanceAdministration	SHOULD contain performer : performer.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-only	error	SubstanceAdministration.repeatNumber	Interval fields SHALL NOT be present : (low | high | width | center).empty()
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('#')
value-starts-octothorpe	error	SubstanceAdministration.entryRelationship:indication.observation.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: 9 elements(12 nested mandatory elements)
Fixed: 10 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• Immunization Medication Information (http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationMedicationInformation)
• Author Participation (http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation)
• Drug Vehicle (http://hl7.org/cda/us/ccda/StructureDefinition/DrugVehicle)
• Indication (http://hl7.org/cda/us/ccda/StructureDefinition/Indication)
• Instruction Observation (http://hl7.org/cda/us/ccda/StructureDefinition/InstructionObservation)
• Medication Supply Order (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationSupplyOrder)
• Medication Dispense (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationDispense)
• Reaction Observation (http://hl7.org/cda/us/ccda/StructureDefinition/ReactionObservation)
• Immunization Not Given Reason (http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationNotGivenReason)
• Substance Administered Act (http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceAdministeredAct)
• Precondition for Substance Administration (http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration)

Slices

This structure defines the following Slices:

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