Back To Index  <<  Back To Templates

draft Template  Immunization Activity (V3)

Id 2.16.840.1.113883.10.20.22.2.90 Effective Date 2019‑04‑01 01:57:35
Status draft Draft Version Label 2.1
Name ImmunizationActivityV3 Display Name Immunization Activity (V3)
Description
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) 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: [URL:http://www.cdc.gov/vaccines/pubs/pinkbook/downloads/appendices/D/vacc_admin.pdf])
Context Parent nodes of template element with id 2.16.840.1.113883.10.20.22.2.90
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 2 templates, Uses 11 templates
Used by as Name Version
2.16.840.1.113883.10.20.22.2.78 Containment draft Immunizations Section (entries optional) (V3) (2.1) 2019‑03‑16 21:11:13
2.16.840.1.113883.3.51.60.2.4.1 link draft BC CDA ClinicalDocumentDischargeSummary (V3) (2.1) 2019‑03‑19 14:15:51
Uses as Name Version
2.16.840.1.113883.10.20.22.2.91 Containment draft Immunization Medication Information (V2) (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.81 Containment draft BC CDA Author (Body) DYNAMIC
2.16.840.1.113883.10.20.22.2.65 Containment draft Drug Vehicle (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.67 Containment draft Indication (V2) (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.68 Containment draft Instruction (V2) (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.72 Containment draft Medication Supply Order (V2) (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.69 Containment draft Medication Dispense (V2) (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.58 Containment draft Reaction Observation (V2) (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.92 Containment draft Immunization Refusal Reason (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.76 Containment draft Substance Administered Act (2.1) DYNAMIC
2.16.840.1.113883.10.20.22.2.85 Containment draft Precondition for Substance Administration (V2) (2.1) DYNAMIC
Relationship Specialization: template 2.16.840.1.113883.10.20.22.2.90 (2015‑08‑01)
ref
?

Specialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-

Version: template 2.16.840.1.113883.10.20.22.2.90 (2013‑01‑31)
ref
?
Item DT Card Conf Description Label
cda:substanceAdministration
(ImmdotsyV3)
treetree @classCode
cs 1 … 1 F SBADM CONFdots8826
  SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8826).
treetree @moodCode
cs 1 … 1 R SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC (CONF:1198-8827). CONFdots8827
  CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.20.9.18 MoodCodeEvnInt (DYNAMIC)
treetree @negationInd
bl 1 … 1 R SHALL contain exactly one [1..1] @negationInd (CONF:1198-8985). CONFdots8985
treetree hl7:templateId
II 1 … 1 M (ImmdotsyV3)
treeblank treetree @root
uid 1 … 1 F 2.16.840.1.113883.10.20.22.2.90
treetree cda:templateId
II 1 … 1 M SHALL contain exactly one [1..1] templateId (CONF:1198-8828) such that it CONFdots8828
treeblank treetree @root
uid 1 … 1 F 2.16.840.1.113883.10.20.22.2.90 CONFdots0498
  SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.52" (CONF:1198-10498).
treeblank treetree @extension
st 1 … 1 F 2015-08-01 CONFdots2528
  SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32528).
treetree cda:id
II 1 … * SHALL contain at least one [1..*] id (CONF:1198-8829). CONFdots8829
treetree cda:code
0 … 1 MAY contain zero or one [0..1] code (CONF:1198-8830). CONFdots8830
treetree cda:statusCode
CS 1 … 1 R SHALL contain exactly one [1..1] statusCode (CONF:1198-8833). CONFdots8833
treetree cda:effectiveTime
1 … 1 SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8834). CONFdots8834
treetree cda:repeatNumber
0 … 1 MAY contain zero or one [0..1] repeatNumber (CONF:1198-8838).

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.

CONFdots8838
treetree cda:routeCode
0 … 1 MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet Medication Route FDA urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1198-8839). CONFdots8839
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.3221.8.7 Medication Route FDA (DYNAMIC)
treetree cda:approachSiteCode
CD 0 … 1 MAY contain zero or one [0..1] approachSiteCode, where the code SHALL be selected from ValueSet Body Site urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1198-8840). CONFdots8840
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.3.88.12.3221.8.9 Body Site (DYNAMIC)
treetree cda:doseQuantity
0 … 1 R SHOULD contain zero or one [0..1] doseQuantity (CONF:1198-8841). CONFdots8841
treeblank treetree @unit
cs 0 … 1   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:1198-8842). CONFdots8842
  CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.1.11.12839 UnitsOfMeasureCaseSensitive (DYNAMIC)
treetree cda:administrationUnitCode
CE 0 … 1 MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1198-8846). CONFdots8846
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113762.1.4.1021.30 Administration Unit Dose Form (DYNAMIC)
treetree cda:consumable
1 … 1 M Contains 2.16.840.1.113883.10.20.22.2.91 Immunization Medication Information (V2) (DYNAMIC) CONFdots8847
treeblank where [cda:manufacturedProduct [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.91'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.91'] [@extension = '2014-06-09']]]
treetree cda:performer
0 … 1 R SHOULD contain zero or one [0..1] performer (CONF:1198-8849). CONFdots8849
treetree cda:author
0 … * R SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31151).
Contains 2.16.840.1.113883.10.20.22.2.81 BC CDA Author (Body) (DYNAMIC) 		CONFdots1151
treeblank where [hl7:assignedAuthor [@classCode = 'ASSIGNED']]
treetree cda:participant
0 … * Contains 2.16.840.1.113883.10.20.22.2.65 Drug Vehicle (DYNAMIC) CONFdots8850
treeblank where [cda:participantRole [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.65'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.65']]]
treeblank treetree @typeCode
cs 1 … 1 F CSM CONFdots8851
  SHALL contain exactly one [1..1] @typeCode="CSM" (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8851).
treetree cda:entryRelationship
0 … * Contains 2.16.840.1.113883.10.20.22.2.67 Indication (V2) (DYNAMIC) CONFdots8853
treeblank where [cda:observation [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.67'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.67'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
cs 1 … 1 F RSON CONFdots8854
  SHALL contain exactly one [1..1] @typeCode="RSON" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8854).
treetree cda:entryRelationship
0 … 1 Contains 2.16.840.1.113883.10.20.22.2.68 Instruction (V2) (DYNAMIC) CONFdots8856
treeblank where [cda:act [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.68'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.68'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
cs 1 … 1 F SUBJ CONFdots8857
  SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8857).
treeblank treetree @inversionInd
bl 1 … 1 F true CONFdots8858
  SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-8858).
treetree cda:entryRelationship
0 … 1 Contains 2.16.840.1.113883.10.20.22.2.72 Medication Supply Order (V2) (DYNAMIC) CONFdots8860
treeblank where [cda:supply [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.72'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.72'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
cs 1 … 1 F REFR CONFdots8861
  SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8861).
treetree cda:entryRelationship
0 … 1 Contains 2.16.840.1.113883.10.20.22.2.69 Medication Dispense (V2) (DYNAMIC) CONFdots8863
treeblank where [cda:supply [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.69'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.69'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
cs 1 … 1 F REFR CONFdots8864
  SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8864).
treetree cda:entryRelationship
0 … 1 Contains 2.16.840.1.113883.10.20.22.2.58 Reaction Observation (V2) (DYNAMIC) CONFdots8866
treeblank where [cda:observation [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.58'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.58'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
cs 1 … 1 F CAUS CONFdots8867
  SHALL contain exactly one [1..1] @typeCode="CAUS" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8867).
treetree cda:entryRelationship
0 … 1 Contains 2.16.840.1.113883.10.20.22.2.92 Immunization Refusal Reason (DYNAMIC) CONFdots8988
treeblank where [cda:observation [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.92'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.92']]]
treeblank treetree @typeCode
cs 1 … 1 F RSON CONFdots8989
  SHALL contain exactly one [1..1] @typeCode="RSON" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8989).
treetree cda:entryRelationship
0 … * R 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.
Contains 2.16.840.1.113883.10.20.22.2.76 Substance Administered Act (DYNAMIC) 		CONFdots1510
treeblank where [cda:act [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.76'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.76']]]
treeblank treetree @typeCode
cs 1 … 1 F COMP CONFdots1511
  SHALL contain exactly one [1..1] @typeCode="COMP" Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31511).
treeblank treetree @inversionInd
bl 1 … 1 F true CONFdots1512
  SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1198-31512).
treeblank treetree cda:sequenceNumber
0 … 1 MAY contain zero or one [0..1] sequenceNumber (CONF:1198-31513). CONFdots1513
treetree cda:precondition
0 … * Contains 2.16.840.1.113883.10.20.22.2.85 Precondition for Substance Administration (V2) (DYNAMIC) CONFdots8869
treeblank where [cda:criterion [hl7:templateId [@root = '2.16.840.1.113883.10.20.22.2.85'] and cda:templateId [@root = '2.16.840.1.113883.10.20.22.2.85'] [@extension = '2014-06-09']]]
treeblank treetree @typeCode
cs 1 … 1 F PRCN CONFdots8870
  SHALL contain exactly one [1..1] @typeCode="PRCN" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8870).