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

Messages

Metadata

Name	Value		Comments
abstract	false
baseDefinition	http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
copyright
date	2023-12-21T01:13:10+10:00	2024-05-18T00:16:25-05:00	Values Differ
description	This template represents planned immunizations. Planned Immunization Activity is very similar to Planned Medication Activity with some key differences, for example, the drug code system is constrained to CVX codes. The priority of the immunization activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the immunization activity is intended to take place and authorTime indicates when the documentation of the plan occurred.
experimental
fhirVersion	5.0.0
jurisdiction
jurisdiction[0]	urn:iso:std:iso:3166#US
kind	logical
name	PlannedImmunizationActivity
publisher	Health Level Seven
purpose
status	draft
title	Planned Immunization Activity
type	http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
url	http://hl7.org/cda/us/ccda/StructureDefinition/PlannedImmunizationActivity
version	3.0.0-ballot	3.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	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
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		1..*	II	Slice: Unordered, Open by value:root
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	Binding: ?? (example)		0..1	CD	Binding: ?? (example)
negationInd		0..1	??			0..1	??
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..1	??	Binding: ?? (required)		0..1	??	Binding: ?? (required)
code		1..1	??	Fixed Value: active		1..1	??	Fixed Value: active
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	The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.		1..1	SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS	The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
priorityCode		0..1	CE	Binding: ?? (example)		0..1	CE	Binding: ?? (example)
repeatNumber		0..1	IVL_INT	In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.		0..1	IVL_INT	In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
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: ?? (required)		0..*	CD	Binding: ?? (preferred)
approachSiteCode		0..*	CD	Binding: ?? (required)		0..*	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: ?? (required)		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: ?? (example)		0..1	CE	Binding: ?? (example)
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..*	Performer2	The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.		0..*	Performer2	The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
author		0..*	??	The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.		0..*	??	The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
informant		0..*	Informant			0..*	Informant
participant		0..*	Participant2			0..*	Participant2
Slices for entryRelationship		0..*	EntryRelationship	The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act		0..*	EntryRelationship	The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act
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