International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1 International flag

This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Immunization (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips Version: 1.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: ImmunizationUvIps

This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile.

It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.

This profile constrains the representation of a record of a vaccination of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... status S1..1codecompleted | entered-in-error | not-done
... vaccineCode S1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.

Additional BindingsPurposeDocumentation
Vaccines - SNOMED CT IPS Free SetCandidate Validation Binding
For when codes from the SNOMED CT IPS free set are preferred
Vaccines WHO ATC - IPSCandidate Validation Binding
For when WHO ATC code system is preferred
Absent or Unknown Immunization - IPSCandidate Validation Binding
"known absent" and "not known", for use with other value sets
... patient S1..1Reference(Patient (IPS))Who was immunized
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
.... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... site 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (preferred)
... route 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... targetDisease 0..*CodeableConceptVaccine preventable disease being targeted
Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.

Additional BindingsPurpose
Vaccine Target Diseases - SNOMED CT IPS Free SetCandidate Validation Binding

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.vaccineCodepreferredVaccinesUvIps
Additional Bindings Purpose Documentation
Vaccines - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a vaccines value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Vaccines WHO ATC - IPS Candidate Validation Binding

Additional conformance binding to a vaccines value set from the WHO ATC code system for use in specific jurisdictional or other contexts where use of the ATC terminology is preferred.

Absent or Unknown Immunization - IPS Candidate Validation Binding

Additional conformance binding for "known absent" and "not known" immunization data. This value set binding is intended to be used as part of a combined value set along with one of the other "additional binding" value sets.

Immunization.sitepreferredSNOMEDCTBodyStructures
Immunization.routepreferredMedicineRouteOfAdministrationUvIps
Immunization.protocolApplied.targetDiseasepreferredVaccineTargetDiseasesUvIps
Additional Bindings Purpose Documentation
Vaccine Target Diseases - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a target diseases value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... patient SΣ1..1Reference(Patient (IPS))Who was immunized
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
... occurrence[x] SΣ1..1Vaccine administration date
.... occurrence[x]:All Types Content/Rules for all Types
..... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... occurrenceDateTimedateTime
.... occurrenceStringstring
... site 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (preferred)
... route 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... isSubpotent ?!Σ0..1booleanDose potency
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... targetDisease 0..*CodeableConceptVaccine preventable disease being targeted
Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.

Additional BindingsPurpose
Vaccine Target Diseases - SNOMED CT IPS Free SetCandidate Validation Binding

.... doseNumber[x] 1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.statusrequiredImmunizationStatusCodes
Immunization.vaccineCodepreferredVaccinesUvIps
Additional Bindings Purpose Documentation
Vaccines - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a vaccines value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Vaccines WHO ATC - IPS Candidate Validation Binding

Additional conformance binding to a vaccines value set from the WHO ATC code system for use in specific jurisdictional or other contexts where use of the ATC terminology is preferred.

Absent or Unknown Immunization - IPS Candidate Validation Binding

Additional conformance binding for "known absent" and "not known" immunization data. This value set binding is intended to be used as part of a combined value set along with one of the other "additional binding" value sets.

Immunization.sitepreferredSNOMEDCTBodyStructures
Immunization.routepreferredMedicineRouteOfAdministrationUvIps
Immunization.protocolApplied.targetDiseasepreferredVaccineTargetDiseasesUvIps
Additional Bindings Purpose Documentation
Vaccine Target Diseases - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a target diseases value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... vaccineCode S1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.

Additional BindingsPurposeDocumentation
Vaccines - SNOMED CT IPS Free SetCandidate Validation Binding
For when codes from the SNOMED CT IPS free set are preferred
Vaccines WHO ATC - IPSCandidate Validation Binding
For when WHO ATC code system is preferred
Absent or Unknown Immunization - IPSCandidate Validation Binding
"known absent" and "not known", for use with other value sets
... patient SΣ1..1Reference(Patient (IPS))Who was immunized
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1Vaccine administration date
.... occurrence[x]:All Types Content/Rules for all Types
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates 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.

... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (preferred)
... route 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer Σ0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventable disease being targeted
Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.

Additional BindingsPurpose
Vaccine Target Diseases - SNOMED CT IPS Free SetCandidate Validation Binding

.... doseNumber[x] 1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodepreferredVaccinesUvIps
Additional Bindings Purpose Documentation
Vaccines - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a vaccines value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Vaccines WHO ATC - IPS Candidate Validation Binding

Additional conformance binding to a vaccines value set from the WHO ATC code system for use in specific jurisdictional or other contexts where use of the ATC terminology is preferred.

Absent or Unknown Immunization - IPS Candidate Validation Binding

Additional conformance binding for "known absent" and "not known" immunization data. This value set binding is intended to be used as part of a combined value set along with one of the other "additional binding" value sets.

Immunization.patient.typeextensibleResourceType
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.sitepreferredSNOMEDCTBodyStructures
Immunization.routepreferredMedicineRouteOfAdministrationUvIps
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseasepreferredVaccineTargetDiseasesUvIps
Additional Bindings Purpose Documentation
Vaccine Target Diseases - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a target diseases value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

Summary

Mandatory: 3 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 2

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... status S1..1codecompleted | entered-in-error | not-done
... vaccineCode S1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.

Additional BindingsPurposeDocumentation
Vaccines - SNOMED CT IPS Free SetCandidate Validation Binding
For when codes from the SNOMED CT IPS free set are preferred
Vaccines WHO ATC - IPSCandidate Validation Binding
For when WHO ATC code system is preferred
Absent or Unknown Immunization - IPSCandidate Validation Binding
"known absent" and "not known", for use with other value sets
... patient S1..1Reference(Patient (IPS))Who was immunized
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
.... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... site 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (preferred)
... route 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... targetDisease 0..*CodeableConceptVaccine preventable disease being targeted
Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.

Additional BindingsPurpose
Vaccine Target Diseases - SNOMED CT IPS Free SetCandidate Validation Binding

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.vaccineCodepreferredVaccinesUvIps
Additional Bindings Purpose Documentation
Vaccines - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a vaccines value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Vaccines WHO ATC - IPS Candidate Validation Binding

Additional conformance binding to a vaccines value set from the WHO ATC code system for use in specific jurisdictional or other contexts where use of the ATC terminology is preferred.

Absent or Unknown Immunization - IPS Candidate Validation Binding

Additional conformance binding for "known absent" and "not known" immunization data. This value set binding is intended to be used as part of a combined value set along with one of the other "additional binding" value sets.

Immunization.sitepreferredSNOMEDCTBodyStructures
Immunization.routepreferredMedicineRouteOfAdministrationUvIps
Immunization.protocolApplied.targetDiseasepreferredVaccineTargetDiseasesUvIps
Additional Bindings Purpose Documentation
Vaccine Target Diseases - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a target diseases value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... patient SΣ1..1Reference(Patient (IPS))Who was immunized
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
... occurrence[x] SΣ1..1Vaccine administration date
.... occurrence[x]:All Types Content/Rules for all Types
..... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... occurrenceDateTimedateTime
.... occurrenceStringstring
... site 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (preferred)
... route 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... isSubpotent ?!Σ0..1booleanDose potency
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... targetDisease 0..*CodeableConceptVaccine preventable disease being targeted
Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.

Additional BindingsPurpose
Vaccine Target Diseases - SNOMED CT IPS Free SetCandidate Validation Binding

.... doseNumber[x] 1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.statusrequiredImmunizationStatusCodes
Immunization.vaccineCodepreferredVaccinesUvIps
Additional Bindings Purpose Documentation
Vaccines - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a vaccines value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Vaccines WHO ATC - IPS Candidate Validation Binding

Additional conformance binding to a vaccines value set from the WHO ATC code system for use in specific jurisdictional or other contexts where use of the ATC terminology is preferred.

Absent or Unknown Immunization - IPS Candidate Validation Binding

Additional conformance binding for "known absent" and "not known" immunization data. This value set binding is intended to be used as part of a combined value set along with one of the other "additional binding" value sets.

Immunization.sitepreferredSNOMEDCTBodyStructures
Immunization.routepreferredMedicineRouteOfAdministrationUvIps
Immunization.protocolApplied.targetDiseasepreferredVaccineTargetDiseasesUvIps
Additional Bindings Purpose Documentation
Vaccine Target Diseases - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a target diseases value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... vaccineCode S1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.

Additional BindingsPurposeDocumentation
Vaccines - SNOMED CT IPS Free SetCandidate Validation Binding
For when codes from the SNOMED CT IPS free set are preferred
Vaccines WHO ATC - IPSCandidate Validation Binding
For when WHO ATC code system is preferred
Absent or Unknown Immunization - IPSCandidate Validation Binding
"known absent" and "not known", for use with other value sets
... patient SΣ1..1Reference(Patient (IPS))Who was immunized
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1Vaccine administration date
.... occurrence[x]:All Types Content/Rules for all Types
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates 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.

... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (preferred)
... route 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer Σ0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventable disease being targeted
Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.

Additional BindingsPurpose
Vaccine Target Diseases - SNOMED CT IPS Free SetCandidate Validation Binding

.... doseNumber[x] 1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodepreferredVaccinesUvIps
Additional Bindings Purpose Documentation
Vaccines - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a vaccines value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Vaccines WHO ATC - IPS Candidate Validation Binding

Additional conformance binding to a vaccines value set from the WHO ATC code system for use in specific jurisdictional or other contexts where use of the ATC terminology is preferred.

Absent or Unknown Immunization - IPS Candidate Validation Binding

Additional conformance binding for "known absent" and "not known" immunization data. This value set binding is intended to be used as part of a combined value set along with one of the other "additional binding" value sets.

Immunization.patient.typeextensibleResourceType
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.sitepreferredSNOMEDCTBodyStructures
Immunization.routepreferredMedicineRouteOfAdministrationUvIps
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseasepreferredVaccineTargetDiseasesUvIps
Additional Bindings Purpose Documentation
Vaccine Target Diseases - SNOMED CT IPS Free Set Candidate Validation Binding

Additional conformance binding to a target diseases value set from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

Summary

Mandatory: 3 elements
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron