WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build International flag

This is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc and changes regularly.

Resource Profile: Immunization (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-pre-uv-ips Version: 1.0.0
Active as of 2021-10-04 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.

This profile has been temporary added to this Implementation Guide, to allow the pre-adoption of some changes not yet officially published.
This profile is not an official IPS profile and it will be removed as soon as the next HL7 FHIR IPS release will be published.

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Immunization.vaccineCode is sliced based on the value of pattern:$this
  • The element Immunization.protocolApplied.targetDisease is sliced based on the value of pattern:$this

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization SImmunization
... status S
... Slices for 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.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.

.... vaccineCode:vaccineGPSCode S0..1Code for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
.... vaccineCode:atcClass S0..1WHO ATC classification
Binding: WHO ATC - IPS (required)
.... vaccineCode:absentOrUnknownImmunization S0..1Absent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
... patient SReference(Patient (IPS))
.... reference S1..
.... 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 CodeableConceptIPSBinding: Target Site - IPS (preferred)
... route SCodeableConceptIPSBinding: Medicine Route of Administration - IPS (preferred)
... performer S
.... actor S
... protocolApplied
.... Slices for targetDisease Slice: Unordered, Open by pattern:$this
Binding: Vaccine Target Diseases - IPS (preferred)
..... targetDisease:targetDiseaseGPSCode S0..1Code for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S0..*ImmunizationImmunization event information
... id Σ0..1stringLogical 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.

... Slices for vaccineCode SΣ1..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.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.

.... vaccineCode:vaccineGPSCode SΣ0..1CodeableConceptCode for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
.... vaccineCode:atcClass SΣ0..1CodeableConceptWHO ATC classification
Binding: WHO ATC - IPS (required)
.... vaccineCode:absentOrUnknownImmunization SΣ0..1CodeableConceptAbsent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
... 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ΣI1..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 S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Target Site - IPS (preferred)
... route S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣ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 SΣ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 I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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
.... Slices for targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Slice: Unordered, Open by pattern:$this
Binding: Vaccine Target Diseases - IPS (preferred)
..... targetDisease:targetDiseaseGPSCode S0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)
.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... status ?!Σ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... Slices for vaccineCode Σ1..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.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.

.... vaccineCode:vaccineGPSCode Σ0..1CodeableConceptCode for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
.... vaccineCode:atcClass Σ0..1CodeableConceptWHO ATC classification
Binding: WHO ATC - IPS (required)
.... vaccineCode:absentOrUnknownImmunization Σ0..1CodeableConceptAbsent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
... patient Σ1..1Reference(Patient (IPS))Who was immunized
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... occurrence[x]:All Types Content/Rules for all Types
..... data-absent-reason 0..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: Target Site - IPS (preferred)
... route 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... performer Σ0..*BackboneElementWho performed event
.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... targetDisease:targetDiseaseGPSCode 0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)

doco Documentation for this format

This structure is derived from Immunization

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Immunization.vaccineCode is sliced based on the value of pattern:$this
  • The element Immunization.protocolApplied.targetDisease is sliced based on the value of pattern:$this

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization SImmunization
... status S
... Slices for 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.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.

.... vaccineCode:vaccineGPSCode S0..1Code for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
.... vaccineCode:atcClass S0..1WHO ATC classification
Binding: WHO ATC - IPS (required)
.... vaccineCode:absentOrUnknownImmunization S0..1Absent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
... patient SReference(Patient (IPS))
.... reference S1..
.... 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 CodeableConceptIPSBinding: Target Site - IPS (preferred)
... route SCodeableConceptIPSBinding: Medicine Route of Administration - IPS (preferred)
... performer S
.... actor S
... protocolApplied
.... Slices for targetDisease Slice: Unordered, Open by pattern:$this
Binding: Vaccine Target Diseases - IPS (preferred)
..... targetDisease:targetDiseaseGPSCode S0..1Code for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S0..*ImmunizationImmunization event information
... id Σ0..1stringLogical 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.

... Slices for vaccineCode SΣ1..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.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.

.... vaccineCode:vaccineGPSCode SΣ0..1CodeableConceptCode for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
.... vaccineCode:atcClass SΣ0..1CodeableConceptWHO ATC classification
Binding: WHO ATC - IPS (required)
.... vaccineCode:absentOrUnknownImmunization SΣ0..1CodeableConceptAbsent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
... 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ΣI1..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 S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Target Site - IPS (preferred)
... route S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣ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 SΣ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 I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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
.... Slices for targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Slice: Unordered, Open by pattern:$this
Binding: Vaccine Target Diseases - IPS (preferred)
..... targetDisease:targetDiseaseGPSCode S0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)
.... 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodepreferredVaccinesUvIps
Immunization.vaccineCode:vaccineGPSCoderequiredVaccinesGpsUvIps
Immunization.vaccineCode:atcClassrequiredWhoAtcUvIps
Immunization.vaccineCode:absentOrUnknownImmunizationrequiredNoImmunizationInfoUvIps
Immunization.patient.typeextensibleResourceType
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.sitepreferredTargetSiteCodeUvIps
Immunization.routepreferredRouteOfAdminUvIps
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseasepreferredTargetDiseasesUvIps
Immunization.protocolApplied.targetDisease:targetDiseaseGPSCoderequiredTargetDiseasesGpsUvIps

Constraints

IdGradePathDetailsRequirements
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-1errorImmunization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.vaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.vaccineCode:vaccineGPSCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.vaccineCode:atcClassAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.vaccineCode:absentOrUnknownImmunizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.patient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.patient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.patient.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.patient.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.patient.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.patient.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.occurrence[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.occurrence[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.occurrence[x].extension:data-absent-reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.occurrence[x].extension:data-absent-reasonMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.recordedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.primarySourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.reportOriginAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.siteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.routeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.doseQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.performer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.performer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.performer.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.performer.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.performer.functionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.performer.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.isSubpotentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.subpotentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.educationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()
ele-1errorImmunization.education.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.education.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.education.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.education.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.education.documentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.education.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.education.publicationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.education.presentationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.programEligibilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.fundingSourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.reactionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.reaction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.reaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.reaction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.reaction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.reaction.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.reaction.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.reaction.reportedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.protocolAppliedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.protocolApplied.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.protocolApplied.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.protocolApplied.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorImmunization.protocolApplied.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorImmunization.protocolApplied.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.protocolApplied.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.protocolApplied.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.protocolApplied.targetDisease:targetDiseaseGPSCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.protocolApplied.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorImmunization.protocolApplied.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())