Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot International flag

Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

Resource Profile: CPG Immunization

Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-immunization Version: 3.0.0-ballot
Active as of 2026-11-10 Computable Name: CPGImmunization
Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.71

Documents a particular immunization as an activity within the context of a computable clinical practice guideline

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:pertinenceRating 0..1 integer CPG Pertinence Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinenceRating
Immunization.Slices for extension.extension:pertinentTo 0..1 Reference() CPG Pertinent To Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinentTo
Immunization.Slices for extension.extension:instantiatesCaseFeature This element must be supported. 0..1 canonical(CPG Case Feature Definition) CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
Immunization.Slices for extension.extension:caseFeatureType This element must be supported. 0..1 code CPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
Immunization.Slices for extension.extension:caseFeaturePertinence This element must be supported. 0..1 code CPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
Immunization.Slices for extension.extension:basedOn This element must be supported. 0..1 Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
Immunization.Slices for extension.extension:pertinent This element must be supported. 0..* Reference() CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier This element must be supported. 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason This element must be supported. 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Immunization.patient This element must be supported. This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.encounter This element must be supported. 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.reasonCode This element must be supported. 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference This element must be supported. 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:pertinenceRating 0..1 integer CPG Pertinence Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinenceRating
Immunization.Slices for extension.extension:pertinentTo 0..1 Reference() CPG Pertinent To Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinentTo
Immunization.Slices for extension.extension:instantiatesCaseFeature This element must be supported. 0..1 canonical(CPG Case Feature Definition) CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
Immunization.Slices for extension.extension:caseFeatureType This element must be supported. 0..1 code CPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
Immunization.Slices for extension.extension:caseFeaturePertinence This element must be supported. 0..1 code CPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
Immunization.Slices for extension.extension:basedOn This element must be supported. 0..1 Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
Immunization.Slices for extension.extension:pertinent This element must be supported. 0..* Reference() CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
Immunization.identifier This element must be supported. 0..* Identifier Business identifier
Immunization.statusReason This element must be supported. 0..1 CodeableConcept Reason not done
Immunization.encounter This element must be supported. 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.reasonCode This element must be supported. 0..* CodeableConcept Why immunization occurred
Immunization.reasonReference This element must be supported. 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:pertinenceRating 0..1 integer CPG Pertinence Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinenceRating
Immunization.Slices for extension.extension:pertinentTo 0..1 Reference() CPG Pertinent To Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinentTo
Immunization.Slices for extension.extension:instantiatesCaseFeature This element must be supported. 0..1 canonical(CPG Case Feature Definition) CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
Immunization.Slices for extension.extension:caseFeatureType This element must be supported. 0..1 code CPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
Immunization.Slices for extension.extension:caseFeaturePertinence This element must be supported. 0..1 code CPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
Immunization.Slices for extension.extension:basedOn This element must be supported. 0..1 Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
Immunization.Slices for extension.extension:pertinent This element must be supported. 0..* Reference() CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier This element must be supported. 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason This element must be supported. 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Immunization.patient This element must be supported. This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.encounter This element must be supported. 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element is included in summaries. 0..1 boolean Indicates context the data was recorded in
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer
Immunization.lotNumber 0..1 string Vaccine lot number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reasonCode This element must be supported. 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference This element must be supported. 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:pertinenceRating 0..1 integer CPG Pertinence Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinenceRating
Immunization.Slices for extension.extension:pertinentTo 0..1 Reference() CPG Pertinent To Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinentTo
Immunization.Slices for extension.extension:instantiatesCaseFeature This element must be supported. 0..1 canonical(CPG Case Feature Definition) CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
Immunization.Slices for extension.extension:caseFeatureType This element must be supported. 0..1 code CPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
Immunization.Slices for extension.extension:caseFeaturePertinence This element must be supported. 0..1 code CPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
Immunization.Slices for extension.extension:basedOn This element must be supported. 0..1 Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
Immunization.Slices for extension.extension:pertinent This element must be supported. 0..* Reference() CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier This element must be supported. 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason This element must be supported. 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Immunization.patient This element must be supported. This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.encounter This element must be supported. 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.reasonCode This element must be supported. 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference This element must be supported. 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:pertinenceRating 0..1 integer CPG Pertinence Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinenceRating
Immunization.Slices for extension.extension:pertinentTo 0..1 Reference() CPG Pertinent To Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinentTo
Immunization.Slices for extension.extension:instantiatesCaseFeature This element must be supported. 0..1 canonical(CPG Case Feature Definition) CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
Immunization.Slices for extension.extension:caseFeatureType This element must be supported. 0..1 code CPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
Immunization.Slices for extension.extension:caseFeaturePertinence This element must be supported. 0..1 code CPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
Immunization.Slices for extension.extension:basedOn This element must be supported. 0..1 Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
Immunization.Slices for extension.extension:pertinent This element must be supported. 0..* Reference() CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
Immunization.identifier This element must be supported. 0..* Identifier Business identifier
Immunization.statusReason This element must be supported. 0..1 CodeableConcept Reason not done
Immunization.patient This element must be supported. 1..1 Reference(Patient) Who was immunized
Immunization.encounter This element must be supported. 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.reasonCode This element must be supported. 0..* CodeableConcept Why immunization occurred
Immunization.reasonReference This element must be supported. 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:pertinenceRating 0..1 integer CPG Pertinence Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinenceRating
Immunization.Slices for extension.extension:pertinentTo 0..1 Reference() CPG Pertinent To Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinentTo
Immunization.Slices for extension.extension:instantiatesCaseFeature This element must be supported. 0..1 canonical(CPG Case Feature Definition) CPG Instantiates Case Feature Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
Immunization.Slices for extension.extension:caseFeatureType This element must be supported. 0..1 code CPG Case Feature Type Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType
Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
Immunization.Slices for extension.extension:caseFeaturePertinence This element must be supported. 0..1 code CPG Case Feature Pertinence Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence
Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
Immunization.Slices for extension.extension:basedOn This element must be supported. 0..1 Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
Immunization.Slices for extension.extension:pertinent This element must be supported. 0..* Reference() CPG Pertinent Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier This element must be supported. 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason This element must be supported. 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Immunization.patient This element must be supported. This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.encounter This element must be supported. 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element is included in summaries. 0..1 boolean Indicates context the data was recorded in
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer
Immunization.lotNumber 0..1 string Vaccine lot number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reasonCode This element must be supported. 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference This element must be supported. 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron