Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.120 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: PlannedImmunizationActivity | |||
Other Identifiers: : urn:oid:2.16.840.1.113883.10.20.22.4.120 |
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.SubstanceAdministration
Summary
Mandatory: 10 elements (8 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from CDAR2.SubstanceAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceAdministration | 1..1 | CDAR2.SubstanceAdministration | ||
classCode | 1..1 | code | Required Pattern: SBADM | |
moodCode | 1..1 | code | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.120 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
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. | |
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. | |
routeCode | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required) | |
translation | 0..* | CD | Binding: Medication Route (required) | |
approachSiteCode | 0..* | CD | Binding: Body Site Value Set (required) | |
doseQuantity | 0..1 | IVL_PQ | ||
unit | 0..1 | code | Binding: UnitsOfMeasureCaseSensitive (required) | |
consumable | 1..1 | Element | ||
manufacturedProduct | 1..1 | ImmunizationMedicationInformation | ||
performer | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer. | |
author | 0..* | AuthorParticipation | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity. | |
Slices for entryRelationship | 0..* | Element | The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act | |
entryRelationship:priorityPreference | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the immunization activity. | |
typeCode | 1..1 | code | Required Pattern: REFR | |
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | 0..* | Element | The following entryRelationship represents the indication for the immunization activity. | |
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
entryRelationship:instruction | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: SUBJ | |
act | 1..1 | Instruction | ||
Slices for precondition | 0..* | Precondition | Slice: Unordered, Open by profile:criterion | |
precondition:pronditionForSubstanceAdmin | 0..* | Precondition | ||
typeCode | 1..1 | code | Required Pattern: PRCN | |
criterion | 1..1 | PreconditionforSubstanceAdministration | ||
Documentation for this format |
This structure is derived from CDAR2.SubstanceAdministration
Summary
Mandatory: 10 elements (8 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.SubstanceAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceAdministration | 1..1 | CDAR2.SubstanceAdministration | ||
classCode | 1..1 | code | Required Pattern: SBADM | |
moodCode | 1..1 | code | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.120 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
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. | |
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. | |
routeCode | 0..1 | CE | Binding: SPL Drug Route of Administration Terminology (required) | |
translation | 0..* | CD | Binding: Medication Route (required) | |
approachSiteCode | 0..* | CD | Binding: Body Site Value Set (required) | |
doseQuantity | 0..1 | IVL_PQ | ||
unit | 0..1 | code | Binding: UnitsOfMeasureCaseSensitive (required) | |
consumable | 1..1 | Element | ||
manufacturedProduct | 1..1 | ImmunizationMedicationInformation | ||
performer | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer. | |
author | 0..* | AuthorParticipation | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity. | |
Slices for entryRelationship | 0..* | Element | The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act | |
entryRelationship:priorityPreference | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the immunization activity. | |
typeCode | 1..1 | code | Required Pattern: REFR | |
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | 0..* | Element | The following entryRelationship represents the indication for the immunization activity. | |
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
entryRelationship:instruction | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: SUBJ | |
act | 1..1 | Instruction | ||
Slices for precondition | 0..* | Precondition | Slice: Unordered, Open by profile:criterion | |
precondition:pronditionForSubstanceAdmin | 0..* | Precondition | ||
typeCode | 1..1 | code | Required Pattern: PRCN | |
criterion | 1..1 | PreconditionforSubstanceAdministration | ||
Documentation for this format |
Snapshot View
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
SubstanceAdministration.classCode | required | Fixed Value: SBADM |
SubstanceAdministration.moodCode | required | Planned moodCode (SubstanceAdministration/Supply) |
SubstanceAdministration.templateId:primary.nullFlavor | required | NullFlavor |
SubstanceAdministration.code | extensible | http://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode |
SubstanceAdministration.statusCode | required | ActStatus |
SubstanceAdministration.statusCode.nullFlavor | required | NullFlavor |
SubstanceAdministration.priorityCode | extensible | ActPriority |
SubstanceAdministration.routeCode | required | SPL Drug Route of Administration Terminology |
SubstanceAdministration.routeCode.nullFlavor | required | NullFlavor |
SubstanceAdministration.routeCode.translation | required | MedicationRoute |
SubstanceAdministration.approachSiteCode | required | BodySiteValueSet |
SubstanceAdministration.doseQuantity.nullFlavor | required | NullFlavor |
SubstanceAdministration.doseQuantity.unit | required | UnitsOfMeasureCaseSensitive |
SubstanceAdministration.administrationUnitCode | extensible | AdministrableDrugForm |
SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSM |
SubstanceAdministration.subject.typeCode | required | Fixed Value: SBJ |
SubstanceAdministration.subject.contextControlCode | required | Fixed Value: OP |
SubstanceAdministration.subject.awarenessCode | extensible | TargetAwareness |
SubstanceAdministration.informant.typeCode | required | Fixed Value: INF |
SubstanceAdministration.informant.contextControlCode | required | Fixed Value: OP |
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.nullFlavor | required | NullFlavor |
SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode | required | Pattern: PRCN |
Id | Grade | Path | Details | Requirements |
subst-er-1 | error | SubstanceAdministration.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:priorityPreference | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
subst-er-1 | error | SubstanceAdministration.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |