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

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

Logical Model: PlannedImmunizationActivity - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the PlannedImmunizationActivity logical model.

Guidance on how to interpret the contents of this table can be found here

0. SubstanceAdministration
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. SubstanceAdministration.classCode
Comments

SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).

4. SubstanceAdministration.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2014-09-01 (CONF:1098-32097).

BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply)
6. SubstanceAdministration.templateId
Control1..?
SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
8. SubstanceAdministration.templateId:primary
Slice Nameprimary
Comments

SHALL contain exactly one [1..1] templateId (CONF:1098-32098) such that it, SHALL not contain [0..0] extension.

Control1..1
10. SubstanceAdministration.templateId:primary.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.120" (CONF:1098-32099).

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.120
12. SubstanceAdministration.templateId:primary.extension
Control0..0
14. SubstanceAdministration.id
Comments

SHALL contain at least one [1..*] id (CONF:1098-32100).

Control1..?
16. SubstanceAdministration.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:1098-32101).

Control1..?
18. SubstanceAdministration.statusCode.code
Comments

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32102).

Control1..?
Fixed Valueactive
20. SubstanceAdministration.effectiveTime
ShortThe effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
Comments

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).

Control1..1
22. SubstanceAdministration.repeatNumber
ShortIn a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
Comments

MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).

24. SubstanceAdministration.routeCode
Comments

MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32127).

BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology
26. SubstanceAdministration.routeCode.translation
Comments

The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHALL be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32951).

BindingThe codes SHALL be taken from Medication Route
28. SubstanceAdministration.approachSiteCode
Comments

MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32128).

BindingThe codes SHALL be taken from Body Site Value Set
30. SubstanceAdministration.doseQuantity
Comments

MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129).

32. SubstanceAdministration.doseQuantity.unit
Comments

The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32130).

BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
34. SubstanceAdministration.consumable
Comments

SHALL contain exactly one [1..1] consumable (CONF:1098-32131).

36. SubstanceAdministration.consumable.manufacturedProduct
Comments

This consumable SHALL contain exactly one [1..1] Immunization Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09) (CONF:1098-32132).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Immunization Medication Information)
38. SubstanceAdministration.performer
ShortThe clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
Comments

MAY contain zero or more [0..*] performer (CONF:1098-32104).

40. SubstanceAdministration.author
ShortThe author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
Comments

MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
42. SubstanceAdministration.entryRelationship
ShortThe following entryRelationship captures any instructions associated with the planned immunization activity.
SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ observation
  • profile @ act
44. SubstanceAdministration.entryRelationship:priorityPreference
Slice NamepriorityPreference
ShortThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
Comments

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32108) such that it

Control0..*
46. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).

Fixed ValueREFR
48. SubstanceAdministration.entryRelationship:priorityPreference.observation
Comments

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-32110).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
50. SubstanceAdministration.entryRelationship:indication
Slice Nameindication
ShortThe following entryRelationship represents the indication for the immunization activity.
Comments

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32114) such that it

Control0..*
52. SubstanceAdministration.entryRelationship:indication.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).

Fixed ValueRSON
54. SubstanceAdministration.entryRelationship:indication.observation
Comments

SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32116).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
56. SubstanceAdministration.entryRelationship:instruction
Slice Nameinstruction
Comments

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32117) such that it

Control0..*
58. SubstanceAdministration.entryRelationship:instruction.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).

Fixed ValueSUBJ
60. SubstanceAdministration.entryRelationship:instruction.act
Comments

SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32119).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
62. SubstanceAdministration.precondition
SlicingThis element introduces a set of slices on SubstanceAdministration.precondition. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ criterion
64. SubstanceAdministration.precondition:pronditionForSubstanceAdmin
Slice NamepronditionForSubstanceAdmin
Comments

MAY contain zero or more [0..*] precondition (CONF:1098-32123) such that it

Control0..*
66. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).

Control1..?
Fixed ValuePRCN
68. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.criterion
Comments

SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32125).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration)