Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.52 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: ImmunizationActivity | |||
Other Identifiers: : urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01 |
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:
This information should be included in an Immunization Activity when available. (Reference: [https://www.cdc.gov/vaccines/pubs/pinkbook/downloads/appendices/c/vis-instruct.pdf])
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.SubstanceAdministration
Summary
Mandatory: 12 elements (20 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from CDAR2.SubstanceAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceAdministration | 1..1 | CDAR2.SubstanceAdministration | ||
classCode | 1..1 | code | ||
moodCode | 1..1 | code | Binding: MoodCodeEvnInt (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.52 | |
extension | 1..1 | string | Required Pattern: 2015-08-01 | |
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 | boolean | Use negationInd="true" to indicate that the immunization was not given. | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Binding: ActStatus (required) | |
effectiveTime | 1..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | ||
repeatNumber | 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. | |
routeCode | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required) | |
translation | 0..* | CD | Binding: Medication Route (required) | |
approachSiteCode | 0..1 | CD | Binding: Body Site Value Set (required) | |
doseQuantity | 0..1 | IVL_PQ | ||
unit | 0..1 | code | Binding: UnitsOfMeasureCaseSensitive (required) | |
administrationUnitCode | 0..1 | CE | Binding: AdministrationUnitDoseForm (required) | |
consumable | 1..1 | Element | ||
manufacturedProduct | 1..1 | ImmunizationMedicationInformation | ||
performer | 0..1 | Performer2 | ||
author | 0..* | AuthorParticipation | ||
Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode, profile:participantRole | |
participant:drugVehicle | 0..* | Participant2 | ||
typeCode | 1..1 | code | Required Pattern: CSM | |
participantRole | 1..1 | DrugVehicle | ||
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:act, profile:observation, profile:supply | |
entryRelationship:indication | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
entryRelationship:instruction | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: SUBJ | |
inversionInd | 1..1 | boolean | Required Pattern: true | |
act | 1..1 | Instruction | ||
entryRelationship:medSupplyOrder | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: REFR | |
supply | 1..1 | MedicationSupplyOrder | ||
entryRelationship:medDispense | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: REFR | |
supply | 1..1 | MedicationDispense | ||
entryRelationship:reactionObs | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: CAUS | |
observation | 1..1 | ReactionObservation | ||
entryRelationship:immunizationRefusal | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | ImmunizationRefusalReason | ||
entryRelationship:substanceAdmin | 0..* | Element | 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 | code | Required Pattern: COMP | |
inversionInd | 1..1 | boolean | Required Pattern: 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 | code | Required Pattern: PRCN | |
criterion | 1..1 | PreconditionforSubstanceAdministration | ||
Documentation for this format |
This structure is derived from CDAR2.SubstanceAdministration
Summary
Mandatory: 12 elements (20 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.SubstanceAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceAdministration | 1..1 | CDAR2.SubstanceAdministration | ||
classCode | 1..1 | code | ||
moodCode | 1..1 | code | Binding: MoodCodeEvnInt (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.52 | |
extension | 1..1 | string | Required Pattern: 2015-08-01 | |
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 | boolean | Use negationInd="true" to indicate that the immunization was not given. | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Binding: ActStatus (required) | |
effectiveTime | 1..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | ||
repeatNumber | 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. | |
routeCode | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required) | |
translation | 0..* | CD | Binding: Medication Route (required) | |
approachSiteCode | 0..1 | CD | Binding: Body Site Value Set (required) | |
doseQuantity | 0..1 | IVL_PQ | ||
unit | 0..1 | code | Binding: UnitsOfMeasureCaseSensitive (required) | |
administrationUnitCode | 0..1 | CE | Binding: AdministrationUnitDoseForm (required) | |
consumable | 1..1 | Element | ||
manufacturedProduct | 1..1 | ImmunizationMedicationInformation | ||
performer | 0..1 | Performer2 | ||
author | 0..* | AuthorParticipation | ||
Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode, profile:participantRole | |
participant:drugVehicle | 0..* | Participant2 | ||
typeCode | 1..1 | code | Required Pattern: CSM | |
participantRole | 1..1 | DrugVehicle | ||
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:act, profile:observation, profile:supply | |
entryRelationship:indication | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
entryRelationship:instruction | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: SUBJ | |
inversionInd | 1..1 | boolean | Required Pattern: true | |
act | 1..1 | Instruction | ||
entryRelationship:medSupplyOrder | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: REFR | |
supply | 1..1 | MedicationSupplyOrder | ||
entryRelationship:medDispense | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: REFR | |
supply | 1..1 | MedicationDispense | ||
entryRelationship:reactionObs | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: CAUS | |
observation | 1..1 | ReactionObservation | ||
entryRelationship:immunizationRefusal | 0..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | ImmunizationRefusalReason | ||
entryRelationship:substanceAdmin | 0..* | Element | 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 | code | Required Pattern: COMP | |
inversionInd | 1..1 | boolean | Required Pattern: 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 | code | Required Pattern: PRCN | |
criterion | 1..1 | PreconditionforSubstanceAdministration | ||
Documentation for this format |
Snapshot View
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
SubstanceAdministration.classCode | required | Fixed Value: SBADM |
SubstanceAdministration.moodCode | required | MoodCodeEvnInt |
SubstanceAdministration.templateId:primary.nullFlavor | required | NullFlavor |
SubstanceAdministration.code | extensible | http://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode |
SubstanceAdministration.statusCode | required | ActStatus |
SubstanceAdministration.statusCode.nullFlavor | required | NullFlavor |
SubstanceAdministration.statusCode.code | required | ActStatus |
SubstanceAdministration.priorityCode | extensible | ActPriority |
SubstanceAdministration.routeCode | required | SPL Drug Route of Administration Terminology |
SubstanceAdministration.routeCode.nullFlavor | required | NullFlavor |
SubstanceAdministration.routeCode.translation | required | MedicationRoute |
SubstanceAdministration.approachSiteCode | required | BodySiteValueSet |
SubstanceAdministration.doseQuantity.nullFlavor | required | NullFlavor |
SubstanceAdministration.doseQuantity.unit | required | UnitsOfMeasureCaseSensitive |
SubstanceAdministration.administrationUnitCode | required | AdministrationUnitDoseForm |
SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSM |
SubstanceAdministration.subject.typeCode | required | Fixed Value: SBJ |
SubstanceAdministration.subject.contextControlCode | required | Fixed Value: OP |
SubstanceAdministration.subject.awarenessCode | extensible | TargetAwareness |
SubstanceAdministration.informant.typeCode | required | Fixed Value: INF |
SubstanceAdministration.informant.contextControlCode | required | Fixed Value: OP |
SubstanceAdministration.participant:drugVehicle.nullFlavor | required | NullFlavor |
SubstanceAdministration.participant:drugVehicle.typeCode | required | Pattern: CSM |
SubstanceAdministration.participant:drugVehicle.contextControlCode | required | Fixed Value: OP |
SubstanceAdministration.precondition:substanceAdmin.nullFlavor | required | NullFlavor |
SubstanceAdministration.precondition:substanceAdmin.typeCode | required | Pattern: PRCN |
Id | Grade | Path | Details | Requirements |
subst-er-1 | error | SubstanceAdministration.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:medSupplyOrder | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:medDispense | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
1098-9333 | error | SubstanceAdministration.entryRelationship:medDispense.supply | A supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333). : | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:reactionObs | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:immunizationRefusal | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:substanceAdmin | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |