StructureDefinition-2.16.840.1.113883.10.20.22.4.52

Sourcehl7.cda.us.ccdar2dot2#current:Consolidated CDA Release 2.1 StructureDefinition Publication (v5.0.0)
resourceTypeStructureDefinition
id2.16.840.1.113883.10.20.22.4.52
canonicalhttp://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.52
version2.2
statusactive
publisherHealth Level Seven
nameImmunizationActivity
titleImmunization Activity
date2021-11-24T17:43:01+00:00
descriptionAn 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) a. Date printed on the VIS b. Date VIS given to patient or parent/guardian. 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])
jurisdictionsus
fhirVersion4.0.1
kindresource
abstractfalse
sdTtypeSubstanceAdministration
derivationconstraint
basehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
Usages
Name Flags Card. Type Description & Constraints doco
. . SubstanceAdministration
. . . classCode 1..1
. . . moodCode 1..1 Binding: MoodCodeEvnInt ( required )
. . . Slices for templateId Slice: Unordered, Open by value:root, value:extension
. . . . templateId:primary 1..1
. . . . . root 1..1 Required Pattern: 2.16.840.1.113883.10.20.22.4.52
. . . . . extension 1..1 Required Pattern: 2015-08-01
. . . id 1..*
. . . code 0..1 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 Use negationInd="true" to indicate that the immunization was not given.
. . . statusCode 1..1
. . . . code 1..1 Binding: ActStatus ( required )
. . . effectiveTime 1..1
. . . repeatNumber 0..1 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 Binding: SPL Drug Route of Administration Terminology ( required )
. . . . translation 0..* Binding: Medication Route ( required )
. . . approachSiteCode 0..1 Binding: Body Site Value Set ( required )
. . . doseQuantity 0..1
. . . . unit 0..1 Binding: UnitsOfMeasureCaseSensitive ( required )
. . . administrationUnitCode 0..1 Binding: AdministrationUnitDoseForm ( required )
. . . consumable 1..1
. . . . manufacturedProduct 1..1 http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct
. . . performer 0..1
. . . author 0..* http://hl7.org/fhir/cda/StructureDefinition/Author
. . . Slices for participant Slice: Unordered, Open by value:typeCode, profile:participantRole
. . . . participant:drugVehicle 0..*
. . . . . typeCode 1..1 Required Pattern: CSM
. . . . . participantRole 1..1 http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
. . . Slices for entryRelationship Slice: Unordered, Open by profile:act, profile:observation, profile:supply
. . . . entryRelationship:indication 0..*
. . . . . typeCode 1..1 Required Pattern: RSON
. . . . . observation 1..1 http://hl7.org/fhir/cda/StructureDefinition/Observation
. . . . entryRelationship:instruction 0..1
. . . . . typeCode 1..1 Required Pattern: SUBJ
. . . . . inversionInd 1..1 Required Pattern: true
. . . . . act 1..1 http://hl7.org/fhir/cda/StructureDefinition/Act
. . . . entryRelationship:medSupplyOrder 0..1
. . . . . typeCode 1..1 Required Pattern: REFR
. . . . . supply 1..1 http://hl7.org/fhir/cda/StructureDefinition/Supply
. . . . entryRelationship:medDispense 0..1
. . . . . typeCode 1..1 Required Pattern: REFR
. . . . . supply 1..1 http://hl7.org/fhir/cda/StructureDefinition/Supply
. . . . entryRelationship:reactionObs 0..1
. . . . . typeCode 1..1 Required Pattern: CAUS
. . . . . observation 1..1 http://hl7.org/fhir/cda/StructureDefinition/Observation
. . . . entryRelationship:immunizationRefusal 0..1
. . . . . typeCode 1..1 Required Pattern: RSON
. . . . . observation 1..1 http://hl7.org/fhir/cda/StructureDefinition/Observation
. . . . entryRelationship:substanceAdmin 0..* 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 Required Pattern: COMP
. . . . . inversionInd 1..1 Required Pattern: true
. . . . . sequenceNumber 0..1
. . . . . act 1..1 http://hl7.org/fhir/cda/StructureDefinition/Act
. . . Slices for precondition Slice: Unordered, Open by profile:criterion
. . . . precondition:substanceAdmin 0..*
. . . . . typeCode 1..1 Required Pattern: PRCN
. . . . . criterion 1..1 http://hl7.org/fhir/cda/StructureDefinition/Criterion

doco Documentation for this format

Produced 08 Sep 2023