Profile Comparison between http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity vs http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
copyright
date	2024-05-18T00:16:25-05:00	2024-10-19T22:19:38+00:00	Values Differ
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: [https://www.cdc.gov/vaccines/pubs/pinkbook/downloads/appendices/c/vis-instruct.pdf])
experimental
fhirVersion	5.0.0
jurisdiction
jurisdiction[0]	urn:iso:std:iso:3166#US
kind	logical
name	ImmunizationActivity
publisher	Health Level Seven
purpose
status	draft
title	Immunization Activity
type	http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
url	http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity
version	3.0.0	4.0.0	Values Differ

Structure

Name	L Flags	L Card.	L Type	L Description & Constraints	R Flags	R Card.	R Type	R Description & Constraints	Comments
SubstanceAdministration	C	1..1	SubstanceAdministration	Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-doseQuantity: SHOULD contain doseQuantity dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. should-performer: SHOULD contain performer should-author: SHOULD contain author	C	1..1	SubstanceAdministration	Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-doseQuantity: SHOULD contain doseQuantity dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. should-performer: SHOULD contain performer should-author: SHOULD contain author
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
realmCode		0..*	CS			0..*	CS
typeId		0..1	II			0..1	II
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
assigningAuthorityName		0..1	??			0..1	??
displayable		0..1	??			0..1	??
root		1..1	??, ??, ??	Fixed Value: 2.16.840.1.113883.1.3		1..1	??, ??, ??	Fixed Value: 2.16.840.1.113883.1.3
st-simple		1..1	string	Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple		1..1	string	Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension		1..*	II	Slice: Unordered, Open by value:root, value:extension
classCode		1..1	??	Binding: ?? (required) Fixed Value: SBADM		1..1	??	Binding: ?? (required) Fixed Value: SBADM
moodCode		1..1	??	Binding: ?? (required)		1..1	??	Binding: ?? (required)
id		1..*	II			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. Binding: ?? (example)		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. Binding: ?? (example)
negationInd		1..1	??	Use negationInd="true" to indicate that the immunization was not given.		1..1	??	Use negationInd="true" to indicate that the immunization was not given.
text		0..1	ED	SHOULD reference the portion of section narrative text corresponding to this entry		0..1	ED	SHOULD reference the portion of section narrative text corresponding to this entry
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
compression		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
integrityCheck		0..1	??			0..1	??
integrityCheckAlgorithm		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
language		0..1	??			0..1	??
mediaType		0..1	??	Binding: ?? (example)		0..1	??	Binding: ?? (example)
representation		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
xmlText		0..1	??	Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.		0..1	??	Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
reference	C	0..1	TEL	value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative	C	0..1	TEL	value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
thumbnail		0..1	ED			0..1	ED
statusCode		1..1	CS	Binding: ?? (required)		1..1	CS	Binding: ?? (required)
nullFlavor		0..0				0..0
code		1..1	??	Binding: ?? (required)		1..1	??	Binding: ?? (required)
codeSystem		0..0				0..0
codeSystemName		0..0				0..0
codeSystemVersion		0..0				0..0
displayName		0..0				0..0
sdtcValueSet		0..1	??	XML: valueSet (urn:hl7-org:sdtc)		0..1	??	XML: valueSet (urn:hl7-org:sdtc)
sdtcValueSetVersion		0..1	??	XML: valueSetVersion (urn:hl7-org:sdtc)		0..1	??	XML: valueSetVersion (urn:hl7-org:sdtc)
originalText		0..0				0..0
qualifier		0..0				0..0
translation		0..0				0..0
effectiveTime		1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS			1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
priorityCode		0..1	CE	Binding: ?? (example)		0..1	CE	Binding: ?? (example)
repeatNumber	C	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. value-only: Interval fields SHALL not be present	C	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. value-only: Interval fields SHALL NOT be present
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
value		0..1	??	value should be used instead of low/high		0..1	??	value should be used instead of low/high
operator		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
low		0..1	IVXB_INT			0..1	IVXB_INT
center		0..1	INT			0..1	INT
width		0..1	INT			0..1	INT
high		0..1	IVXB_INT			0..1	IVXB_INT
routeCode	C	0..1	CE	Binding: ?? (required) should-translation: SHOULD contain translation	C	0..1	CE	Binding: ?? (required) should-translation: SHOULD contain translation
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
code		0..1	??			0..1	??
codeSystem		0..1	??, ??, ??			0..1	??, ??, ??
codeSystemName		0..1	??			0..1	??
codeSystemVersion		0..1	??			0..1	??
displayName		0..1	??			0..1	??
sdtcValueSet		0..1	??	XML: valueSet (urn:hl7-org:sdtc)		0..1	??	XML: valueSet (urn:hl7-org:sdtc)
sdtcValueSetVersion		0..1	??	XML: valueSetVersion (urn:hl7-org:sdtc)		0..1	??	XML: valueSetVersion (urn:hl7-org:sdtc)
originalText		0..1	ED			0..1	ED
qualifier		0..0				0..0
translation		0..*	CD	Binding: ?? (preferred)		0..*	CD	Binding: ?? (preferred)
approachSiteCode		0..1	CD	Binding: ?? (required)		0..1	CD	Binding: ?? (required)
doseQuantity	C	0..1	IVL_PQ	should-unit: SHOULD contain @unit	C	0..1	IVL_PQ	should-unit: SHOULD contain @unit
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
unit		0..1	??	NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units Binding: ?? (preferred)		0..1	??	NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units Binding: ?? (preferred)
value		0..1	??			0..1	??
translation		0..*	PQR			0..*	PQR
operator		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
low		0..1	IVXB_PQ			0..1	IVXB_PQ
center		0..1	PQ			0..1	PQ
width		0..1	PQ			0..1	PQ
high		0..1	IVXB_PQ			0..1	IVXB_PQ
rateQuantity		0..1	IVL_PQ			0..1	IVL_PQ
maxDoseQuantity		0..1	RTO_PQ_PQ			0..1	RTO_PQ_PQ
administrationUnitCode		0..1	CE	Binding: ?? (required)		0..1	CE	Binding: ?? (required)
consumable		1..1	InfrastructureRoot			1..1	InfrastructureRoot
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
realmCode		0..*	CS			0..*	CS
typeId		0..1	II			0..1	II
nullFlavor		0..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
assigningAuthorityName		0..1	??			0..1	??
displayable		0..1	??			0..1	??
root		1..1	??, ??, ??	Fixed Value: 2.16.840.1.113883.1.3		1..1	??, ??, ??	Fixed Value: 2.16.840.1.113883.1.3
st-simple		1..1	string	Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple		1..1	string	Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
templateId		0..*	II			0..*	II
typeCode		0..1	??	Binding: ?? (required) Fixed Value: CSM		0..1	??	Binding: ?? (required) Fixed Value: CSM
manufacturedProduct	C	1..1	??	Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) should-manufacturerOrganization: SHOULD contain manufacturerOrganization	C	1..1	??	Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) should-manufacturerOrganization: SHOULD contain manufacturerOrganization
subject		0..1	Subject			0..1	Subject
specimen		0..*	Specimen			0..*	Specimen
performer		0..1	Performer2			0..1	Performer2
author		0..*	??	Base for all types and resources		0..*	??	Base for all types and resources
informant		0..*	Informant			0..*	Informant
Slices for participant		0..*	Participant2	Slice: Unordered, Open by value:typeCode		0..*	Participant2	Slice: Unordered, Open by value:typeCode
Slices for entryRelationship		0..*	EntryRelationship	Slice: Unordered, Open by profile:act, profile:observation, profile:supply		0..*	EntryRelationship	Slice: Unordered, Open by profile:act, profile:observation, profile:supply
reference		0..*	Reference			0..*	Reference
Slices for precondition		0..*	Precondition	Slice: Unordered, Open by profile:criterion		0..*	Precondition	Slice: Unordered, Open by profile:criterion
sdtcInFulfillmentOf1		0..*	InFulfillmentOf1	XML: inFulfillmentOf1 (urn:hl7-org:sdtc)		0..*	InFulfillmentOf1	XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
Documentation for this format