Template

Show index

Template Immunization Activity (V3) 2019‑04‑01 01:57:35

Id2.16.840.1.113883.10.20.22.2.90Effective Date2019‑04‑01 01:57:35
Statusdraft DraftVersion Label2.1
NameImmunizationActivityV3Display NameImmunization 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])
ContextParent nodes of template element with id 2.16.840.1.113883.10.20.22.2.90
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 1 template, Uses 11 templates
Used by as NameVersion
2.16.840.1.113883.10.20.22.2.78Containmentdraft Immunizations Section (entries optional) (V3) (2.1)2019‑03‑16 21:11:13
Uses as NameVersion
2.16.840.1.113883.10.20.22.2.58Containmentpending Reaction Observation (V2) (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.65Containmentpending Drug Vehicle (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.67Containmentpending Indication (V2) (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.68Containmentpending Instruction (V2) (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.69Containmentpending Medication Dispense (V2) (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.72Containmentpending Medication Supply Order (V2) (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.76Containmentpending Substance Administered Act (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.81ContainmentDYNAMIC
2.16.840.1.113883.10.20.22.2.85Containmentpending Precondition for Substance Administration (V2) (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.91Containmentpending Immunization Medication Information (V2) (2.1)DYNAMIC
2.16.840.1.113883.10.20.22.2.92Containmentpending Immunization Refusal Reason (2.1)DYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.20.22.2.90 (2015‑08‑01)
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)
ItemDTCardConfDescriptionLabel
cda:substanceAdministration
ImmudotstyV3
@classCode
cs1 … 1FSBADMCONFdots8826
 SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8826).
@moodCode
cs1 … 1RSHALL 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)
@negationInd
bl1 … 1RSHALL contain exactly one [1..1] @negationInd (CONF:1198-8985).CONFdots8985
hl7:templateId
II1 … 1MImmudotstyV3
@root
uid1 … 1F2.16.840.1.113883.10.20.22.2.90
cda:templateId
II1 … 1MSHALL contain exactly one [1..1] templateId (CONF:1198-8828) such that itCONFdots8828
@root
uid1 … 1F2.16.840.1.113883.10.20.22.2.90CONFdots0498
 SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.52" (CONF:1198-10498).
@extension
st1 … 1F2015-08-01CONFdots2528
 SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32528).
cda:id
II1 … *SHALL contain at least one [1..*] id (CONF:1198-8829).CONFdots8829
cda:code
0 … 1MAY contain zero or one [0..1] code (CONF:1198-8830).CONFdots8830
cda:statusCode
CS1 … 1RSHALL contain exactly one [1..1] statusCode (CONF:1198-8833).CONFdots8833
cda:effectiveTime
1 … 1SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8834).CONFdots8834
cda:repeatNumber
0 … 1MAY 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
cda:routeCode
0 … 1MAY 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)
cda:approachSiteCode
CD0 … 1MAY 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)
cda:doseQuantity
0 … 1RSHOULD contain zero or one [0..1] doseQuantity (CONF:1198-8841).CONFdots8841
@unit
cs0 … 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)
cda:administrationUnitCode
CE0 … 1MAY 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)
cda:consumable
1 … 1MContains 2.16.840.1.113883.10.20.22.2.91 Immunization Medication Information (V2) (DYNAMIC)CONFdots8847
cda:performer
0 … 1RSHOULD contain zero or one [0..1] performer (CONF:1198-8849).CONFdots8849
cda:author
0 … *RSHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31151).
Contains
alertError: Cannot find template "2.16.840.1.113883.10.20.22.2.81" (DYNAMIC)
CONFdots1151
cda:participant
0 … *Contains 2.16.840.1.113883.10.20.22.2.65 Drug Vehicle (DYNAMIC)CONFdots8850
@typeCode
cs1 … 1FCSMCONFdots8851
 SHALL contain exactly one [1..1] @typeCode="CSM" (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8851).
cda:entryRelationship
0 … *Contains 2.16.840.1.113883.10.20.22.2.67 Indication (V2) (DYNAMIC)CONFdots8853
@typeCode
cs1 … 1FRSONCONFdots8854
 SHALL contain exactly one [1..1] @typeCode="RSON" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8854).
cda:entryRelationship
0 … 1Contains 2.16.840.1.113883.10.20.22.2.68 Instruction (V2) (DYNAMIC)CONFdots8856
@typeCode
cs1 … 1FSUBJCONFdots8857
 SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8857).
@inversionInd
bl1 … 1FtrueCONFdots8858
 SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-8858).
cda:entryRelationship
0 … 1Contains 2.16.840.1.113883.10.20.22.2.72 Medication Supply Order (V2) (DYNAMIC)CONFdots8860
@typeCode
cs1 … 1FREFRCONFdots8861
 SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8861).
cda:entryRelationship
0 … 1Contains 2.16.840.1.113883.10.20.22.2.69 Medication Dispense (V2) (DYNAMIC)CONFdots8863
@typeCode
cs1 … 1FREFRCONFdots8864
 SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8864).
cda:entryRelationship
0 … 1Contains 2.16.840.1.113883.10.20.22.2.58 Reaction Observation (V2) (DYNAMIC)CONFdots8866
@typeCode
cs1 … 1FCAUSCONFdots8867
 SHALL contain exactly one [1..1] @typeCode="CAUS" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8867).
cda:entryRelationship
0 … 1Contains 2.16.840.1.113883.10.20.22.2.92 Immunization Refusal Reason (DYNAMIC)CONFdots8988
@typeCode
cs1 … 1FRSONCONFdots8989
 SHALL contain exactly one [1..1] @typeCode="RSON" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8989).
cda:entryRelationship
0 … *RThe 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
@typeCode
cs1 … 1FCOMPCONFdots1511
 SHALL contain exactly one [1..1] @typeCode="COMP" Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-31511).
@inversionInd
bl1 … 1FtrueCONFdots1512
 SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1198-31512).
cda:sequenceNumber
0 … 1MAY contain zero or one [0..1] sequenceNumber (CONF:1198-31513).CONFdots1513
cda:precondition
0 … *Contains 2.16.840.1.113883.10.20.22.2.85 Precondition for Substance Administration (V2) (DYNAMIC)CONFdots8869
@typeCode
cs1 … 1FPRCNCONFdots8870
 SHALL contain exactly one [1..1] @typeCode="PRCN" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8870).