Uzbekistan Digital Health Platform
0.13.0 - ci-build Uzbekistan flag

Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.13.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions

Resource Profile: UZ Core Immunization - Detailed Descriptions

Active as of 2025-08-01

Definitions for the uz-core-immunization resource profile

See the documentation on how to interpret the contents of this table

0. Immunization
Definition

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

ShortImmunization event information
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Immunization.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Immunization.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. Immunization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Immunization.identifier
Definition

A unique identifier assigned to this immunization record.

ShortBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Immunization.basedOn
Definition

A plan, order or recommendation fulfilled in whole or in part by this immunization.

ShortThe legal basis for the eventAuthority that the immunization event is based on
Comments

Allows tracing of an authorization for the Immunization.

Control0..*
TypeReference(UZ Core CarePlan, MedicationRequest, ServiceRequest, UZ Core ImmunizationRecommendation, CarePlan, ImmunizationRecommendation)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Immunization.status
Definition

Indicates the current status of the immunization event.

ShortVaccination statuscompleted | entered-in-error | not-done
Comments

Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from ImmunizationStatusVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-status|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-status-vs|0.13.0)
Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Immunization.statusReason
Definition

Indicates the reason the immunization event was not performed.

ShortStatus ReasonReason for current status
Comments

This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

Control0..1
BindingThe codes SHALL be taken from For example codes, see ImmunizationStatusReasonVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-status-reason|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-status-reason-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Immunization.vaccineCode
Definition

Vaccine that was administered or was to be administered.

ShortAdministered vaccineVaccine administered
Comments

The code for the administered vaccine may be reported at various levels of granularity from a very generic code for a general type of vaccine (e.g. the SNOMED or CVX code for the flu vaccine) to a very discrete code for a specific product including the form and packaging (e.g. an NDC code). Because vaccineCode uses the CodeableConcept data type, multiple codes at different levels of granularity may be reported for a single immunization event provided that all codes are appropriate for the same vaccine. For example, both NDC and CVX codes may be provided for a given immunization event by repeating the coding element within vaccineCode.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from For example codes, see VaccineCodeVS (0.13.0)http://hl7.org/fhir/ValueSet/vaccine-code|5.0.0
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/vaccine-code-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Immunization.administeredProduct
Definition

An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.

ShortVaccine productProduct that was administered
Control0..1
TypeCodeableReference(UZ Core Medication, Medication)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Immunization.lotNumber
Definition

Lot number of the vaccine product.

ShortVaccine batch number (lot number)Vaccine lot number
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Immunization.expirationDate
Definition

Date vaccine batch expires.

ShortVaccine expiry dateVaccine expiration date
Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Immunization.patient
Definition

The patient who either received or did not receive the immunization.

ShortPatientWho was immunized
Control1..1
TypeReference(UZ Core Patient, Patient)
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Immunization.encounter
Definition

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

ShortRelated contactEncounter immunization was part of
Control0..1
TypeReference(UZ Core Encounter, Encounter)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Immunization.supportingInformation
Definition

Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.

ShortAdditional informationAdditional information in support of the immunization
Control0..*
TypeReference(UZ Core Observation, UZ Core Condition, Resource)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Immunization.occurrence[x]
Definition

Date vaccine administered or was to be administered.

ShortDate of vaccine administrationVaccine administration date
Comments

When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

Control1..1
TypeChoice of: dateTime, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Immunization.occurrence[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

32. Immunization.occurrence[x]:occurrenceDateTime
Slice NameoccurrenceDateTime
Definition

Date vaccine administered or was to be administered.

ShortDate (dateTime)Vaccine administration date
Comments

When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

Control01..1
TypedateTime, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Immunization.occurrence[x]:occurrenceString
Slice NameoccurrenceString
Definition

Date vaccine administered or was to be administered.

ShortDate (string)Vaccine administration date
Comments

When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

Control01..1
Typestring, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Immunization.primarySource
Definition

Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.

ShortPrimary sourceIndicates context the data was captured in
Comments

Reflects the “reliability” of the content.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Immunization.informationSource
Definition

Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

ShortData sourceIndicates the source of a reported record
Comments

Typically will not be populated if primarySource = True, not required even if primarySource = False.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from For example codes, see ImmunizationOriginVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-origin|5.0.0
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-origin-vs|0.13.0)
TypeCodeableReference(UZ Core Patient, UZ Core Practitioner, UZ Core PractitionerRole, UZ Core RelatedPerson, UZ Core Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Organization)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Immunization.location
Definition

The service delivery location where the vaccine administration occurred.

ShortVaccination locationWhere immunization occurred
Control0..1
TypeReference(UZ Core Location, Location)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Immunization.site
Definition

Body site where vaccine was administered.

ShortAdministration siteBody site vaccine was administered
Control0..1
BindingUnless not suitable, these codes SHALL be taken from For example codes, see ImmunizationSiteVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-site|5.0.0
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-site-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Immunization.route
Definition

The path by which the vaccine product is taken into the body.

ShortRoute of administrationHow vaccine entered body
Control0..1
BindingFor example codes, see RouteCodeVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-route|5.0.0
(example to https://terminology.dhp.uz/fhir/core/ValueSet/route-code-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Immunization.doseQuantity
Definition

The quantity of vaccine product that was administered.

ShortDoseAmount of vaccine administered
Control0..1
TypeQuantity(SimpleQuantity)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
48. Immunization.performer
Definition

Indicates who performed the immunization event.

ShortPerformerWho performed event
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Immunization.performer.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
52. Immunization.performer.function
Definition

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

ShortRoleWhat type of performance was done
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function|5.0.0
(extensible to http://hl7.org/fhir/ValueSet/immunization-function|5.0.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Immunization.performer.actor
Definition

The practitioner or organization who performed the action.

ShortWho completedIndividual or organization who was performing
Comments

When the individual practitioner who performed the action is known, it is best to send.

Control1..1
TypeReference(UZ Core Practitioner, UZ Core PractitionerRole, UZ Core Organization, UZ Core Patient, UZ Core RelatedPerson, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Immunization.note
Definition

Extra information about the immunization that is not conveyed by the other attributes.

ShortNotesAdditional immunization notes
Control0..*
TypeAnnotation
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Immunization.reason
Definition

Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.

ShortVaccination reasonWhy immunization occurred
Control0..*
BindingFor example codes, see ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason|5.0.0
(example to http://hl7.org/fhir/ValueSet/immunization-reason|5.0.0)
TypeCodeableReference(UZ Core Condition, UZ Core Observation, UZ Core DiagnosticReport, Condition, Observation, DiagnosticReport)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Immunization.isSubpotent
Definition

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

ShortSubpotentDose potency
Comments

Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.

Control0..1
Typeboolean
Is Modifiertrue because This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Meaning if MissingBy default, a dose should be considered to be potent.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Immunization.subpotentReason
Definition

Reason why a dose is considered to be subpotent.

ShortSubpotent reasonReason for being subpotent
Control0..*
BindingFor example codes, see SubpotentReasonVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-subpotent-reason|5.0.0
(example to https://terminology.dhp.uz/fhir/core/ValueSet/subpotent-reason-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Immunization.programEligibility
Definition

Indicates a patient's eligibility for a funding program.

ShortVaccination programPatient eligibility for a specific vaccination program
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Immunization.programEligibility.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
68. Immunization.programEligibility.program
Definition

Indicates which program the patient had their eligility evaluated for.

ShortProgramThe program that eligibility is declared for
Control1..1
BindingFor example codes, see CodesForVaccineFundingProgramshttp://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program|5.0.0
(example to http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program|5.0.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Immunization.programEligibility.programStatus
Definition

Indicates the patient's eligility status for for a specific payment program.

ShortParticipation statusThe patient's eligibility status for the program
Control1..1
BindingFor example codes, see ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility|5.0.0
(example to http://hl7.org/fhir/ValueSet/immunization-program-eligibility|5.0.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Immunization.fundingSource
Definition

Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

ShortFunding SourceFunding source for the vaccine
Control0..1
BindingFor example codes, see FundingSourceVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-funding-source|5.0.0
(example to https://terminology.dhp.uz/fhir/core/ValueSet/funding-source-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Immunization.reaction
Definition

Categorical data indicating that an adverse event is associated in time to an immunization.

ShortReactionDetails of a reaction that follows immunization
Comments

A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Immunization.reaction.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
78. Immunization.reaction.date
Definition

Date of reaction to the immunization.

ShortReaction dateWhen reaction started
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Immunization.reaction.manifestation
Definition

Details of the reaction.

ShortManifestationAdditional information on reaction
Control0..1
BindingThe codes SHALL be taken from For codes, see ReactionTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/reaction-type-vs|0.13.0)
TypeCodeableReference(UZ Core Observation, Observation)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Immunization.reaction.reported
Definition

Self-reported indicator.

ShortSelf-reportedIndicates self-reported reaction
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Immunization.protocolApplied
Definition

The protocol (set of recommendations) being followed by the provider who administered the dose.

ShortProtocolProtocol followed by the provider
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Immunization.protocolApplied.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
88. Immunization.protocolApplied.series
Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

ShortSeriesName of vaccine series
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Immunization.protocolApplied.authority
Definition

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

ShortAuthority organizationWho is responsible for publishing the recommendations
Control0..1
TypeReference(UZ Core Organization, Organization)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Immunization.protocolApplied.targetDisease
Definition

The vaccine preventable disease the dose is being administered against.

ShortTarget DiseaseVaccine preventatable disease being targeted
Control0..*
BindingThe codes SHOULD be taken from For example codes, see TargetDiseaseVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-target-disease|5.0.0
(preferred to https://terminology.dhp.uz/fhir/core/ValueSet/target-disease-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Immunization.protocolApplied.targetDisease. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

94. Immunization.protocolApplied.targetDisease:dhpTargetDisease
Slice NamedhpTargetDisease
Definition

The vaccine preventable disease the dose is being administered against.

ShortTarget disease from the national value setVaccine preventatable disease being targeted
Control0..*
BindingThe codes SHALL be taken from For example codes, see TargetDiseaseVS (0.13.0)http://hl7.org/fhir/ValueSet/immunization-target-disease|5.0.0
(required to https://terminology.dhp.uz/fhir/core/ValueSet/target-disease-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Immunization.protocolApplied.doseNumber
Definition

Nominal position in a series as intended by the practitioner administering the dose.

ShortDose numberDose number within series
Comments

The use of an integer is preferred if known. Text should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Immunization.protocolApplied.seriesDoses
Definition

The recommended number of doses to achieve immunity as intended by the practitioner administering the dose.

ShortTotal dosesRecommended number of doses for immunity
Comments

The use of an integer is preferred if known.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. Immunization
2. Immunization.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
4. Immunization.basedOn
ShortThe legal basis for the event
TypeReference(UZ Core CarePlan, MedicationRequest, ServiceRequest, UZ Core ImmunizationRecommendation)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
6. Immunization.status
ShortVaccination status
BindingThe codes SHALL be taken from ImmunizationStatusVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-status-vs|0.13.0)
Must Supporttrue
8. Immunization.statusReason
ShortStatus Reason
BindingThe codes SHALL be taken from ImmunizationStatusReasonVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-status-reason-vs|0.13.0)
Must Supporttrue
10. Immunization.vaccineCode
ShortAdministered vaccine
BindingUnless not suitable, these codes SHALL be taken from VaccineCodeVS (0.13.0)
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/vaccine-code-vs|0.13.0)
Must Supporttrue
12. Immunization.administeredProduct
ShortVaccine product
TypeCodeableReference(UZ Core Medication)
Must Supporttrue
14. Immunization.lotNumber
ShortVaccine batch number (lot number)
Must Supporttrue
16. Immunization.expirationDate
ShortVaccine expiry date
Must Supporttrue
18. Immunization.patient
ShortPatient
TypeReference(UZ Core Patient)
Must Supporttrue
20. Immunization.encounter
ShortRelated contact
TypeReference(UZ Core Encounter)
Must Supporttrue
22. Immunization.supportingInformation
ShortAdditional information
TypeReference(UZ Core Observation, UZ Core Condition)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
24. Immunization.occurrence[x]
ShortDate of vaccine administration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Must Supporttrue
SlicingThis element introduces a set of slices on Immunization.occurrence[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

26. Immunization.occurrence[x]:occurrenceDateTime
Slice NameoccurrenceDateTime
ShortDate (dateTime)
Control0..1
TypedateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
28. Immunization.occurrence[x]:occurrenceString
Slice NameoccurrenceString
ShortDate (string)
Control0..1
Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
30. Immunization.primarySource
ShortPrimary source
Must Supporttrue
32. Immunization.informationSource
ShortData source
BindingUnless not suitable, these codes SHALL be taken from ImmunizationOriginVS (0.13.0)
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-origin-vs|0.13.0)
TypeCodeableReference(UZ Core Patient, UZ Core Practitioner, UZ Core PractitionerRole, UZ Core RelatedPerson, UZ Core Organization)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
34. Immunization.location
ShortVaccination location
TypeReference(UZ Core Location)
Must Supporttrue
36. Immunization.site
ShortAdministration site
BindingUnless not suitable, these codes SHALL be taken from ImmunizationSiteVS (0.13.0)
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-site-vs|0.13.0)
Must Supporttrue
38. Immunization.route
ShortRoute of administration
BindingFor example codes, see RouteCodeVS (0.13.0)
(example to https://terminology.dhp.uz/fhir/core/ValueSet/route-code-vs|0.13.0)
Must Supporttrue
40. Immunization.doseQuantity
ShortDose
Must Supporttrue
42. Immunization.performer
ShortPerformer
Must Supporttrue
44. Immunization.performer.function
ShortRole
Must Supporttrue
46. Immunization.performer.actor
ShortWho completed
TypeReference(UZ Core Practitioner, UZ Core PractitionerRole, UZ Core Organization, UZ Core Patient, UZ Core RelatedPerson)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
48. Immunization.note
ShortNotes
Must Supporttrue
50. Immunization.reason
ShortVaccination reason
TypeCodeableReference(UZ Core Condition, UZ Core Observation, UZ Core DiagnosticReport)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
52. Immunization.isSubpotent
ShortSubpotent
Must Supporttrue
54. Immunization.subpotentReason
ShortSubpotent reason
BindingFor example codes, see SubpotentReasonVS (0.13.0)
(example to https://terminology.dhp.uz/fhir/core/ValueSet/subpotent-reason-vs|0.13.0)
Must Supporttrue
56. Immunization.programEligibility
ShortVaccination program
Must Supporttrue
58. Immunization.programEligibility.program
ShortProgram
Must Supporttrue
60. Immunization.programEligibility.programStatus
ShortParticipation status
Must Supporttrue
62. Immunization.fundingSource
ShortFunding Source
BindingFor example codes, see FundingSourceVS (0.13.0)
(example to https://terminology.dhp.uz/fhir/core/ValueSet/funding-source-vs|0.13.0)
Must Supporttrue
64. Immunization.reaction
ShortReaction
Must Supporttrue
66. Immunization.reaction.date
ShortReaction date
Must Supporttrue
68. Immunization.reaction.manifestation
ShortManifestation
BindingThe codes SHALL be taken from ReactionTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/reaction-type-vs|0.13.0)
TypeCodeableReference(UZ Core Observation)
Must Supporttrue
70. Immunization.reaction.reported
ShortSelf-reported
Must Supporttrue
72. Immunization.protocolApplied
ShortProtocol
Must Supporttrue
74. Immunization.protocolApplied.series
ShortSeries
Must Supporttrue
76. Immunization.protocolApplied.authority
ShortAuthority organization
TypeReference(UZ Core Organization)
Must Supporttrue
78. Immunization.protocolApplied.targetDisease
ShortTarget Disease
BindingThe codes SHOULD be taken from TargetDiseaseVS (0.13.0)
(preferred to https://terminology.dhp.uz/fhir/core/ValueSet/target-disease-vs|0.13.0)
Must Supporttrue
SlicingThis element introduces a set of slices on Immunization.protocolApplied.targetDisease. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

80. Immunization.protocolApplied.targetDisease:dhpTargetDisease
Slice NamedhpTargetDisease
ShortTarget disease from the national value set
Control0..*
BindingThe codes SHALL be taken from TargetDiseaseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/target-disease-vs|0.13.0)
Must Supporttrue
82. Immunization.protocolApplied.doseNumber
ShortDose number
Must Supporttrue
84. Immunization.protocolApplied.seriesDoses
ShortTotal doses
Must Supporttrue

See the documentation on how to interpret the contents of this table

0. Immunization
Definition

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

ShortImmunization event information
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Immunization.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. Immunization.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Immunization.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Immunization.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Immunization.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Immunization.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Immunization.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Immunization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Immunization.identifier
Definition

A unique identifier assigned to this immunization record.

ShortBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Immunization.basedOn
Definition

A plan, order or recommendation fulfilled in whole or in part by this immunization.

ShortThe legal basis for the event
Comments

Allows tracing of an authorization for the Immunization.

Control0..*
TypeReference(UZ Core CarePlan, MedicationRequest, ServiceRequest, UZ Core ImmunizationRecommendation)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Immunization.status
Definition

Indicates the current status of the immunization event.

ShortVaccination status
Comments

Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from ImmunizationStatusVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-status-vs|0.13.0)
Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Immunization.statusReason
Definition

Indicates the reason the immunization event was not performed.

ShortStatus Reason
Comments

This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

Control0..1
BindingThe codes SHALL be taken from ImmunizationStatusReasonVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-status-reason-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Immunization.vaccineCode
Definition

Vaccine that was administered or was to be administered.

ShortAdministered vaccine
Comments

The code for the administered vaccine may be reported at various levels of granularity from a very generic code for a general type of vaccine (e.g. the SNOMED or CVX code for the flu vaccine) to a very discrete code for a specific product including the form and packaging (e.g. an NDC code). Because vaccineCode uses the CodeableConcept data type, multiple codes at different levels of granularity may be reported for a single immunization event provided that all codes are appropriate for the same vaccine. For example, both NDC and CVX codes may be provided for a given immunization event by repeating the coding element within vaccineCode.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from VaccineCodeVS (0.13.0)
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/vaccine-code-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Immunization.administeredProduct
Definition

An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.

ShortVaccine product
Control0..1
TypeCodeableReference(UZ Core Medication)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Immunization.manufacturer
Definition

Name of vaccine manufacturer.

ShortVaccine manufacturer
Control0..1
TypeCodeableReference(Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Immunization.lotNumber
Definition

Lot number of the vaccine product.

ShortVaccine batch number (lot number)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Immunization.expirationDate
Definition

Date vaccine batch expires.

ShortVaccine expiry date
Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Immunization.patient
Definition

The patient who either received or did not receive the immunization.

ShortPatient
Control1..1
TypeReference(UZ Core Patient)
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Immunization.encounter
Definition

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

ShortRelated contact
Control0..1
TypeReference(UZ Core Encounter)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Immunization.supportingInformation
Definition

Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.

ShortAdditional information
Control0..*
TypeReference(UZ Core Observation, UZ Core Condition)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Immunization.occurrence[x]
Definition

Date vaccine administered or was to be administered.

ShortDate of vaccine administration
Comments

When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

Control1..1
TypeChoice of: dateTime, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Immunization.occurrence[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

44. Immunization.occurrence[x]:occurrenceDateTime
Slice NameoccurrenceDateTime
Definition

Date vaccine administered or was to be administered.

ShortDate (dateTime)
Comments

When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

Control0..1
TypedateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Immunization.occurrence[x]:occurrenceString
Slice NameoccurrenceString
Definition

Date vaccine administered or was to be administered.

ShortDate (string)
Comments

When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

Control0..1
Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Immunization.primarySource
Definition

Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.

ShortPrimary source
Comments

Reflects the “reliability” of the content.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Immunization.informationSource
Definition

Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

ShortData source
Comments

Typically will not be populated if primarySource = True, not required even if primarySource = False.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from ImmunizationOriginVS (0.13.0)
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-origin-vs|0.13.0)
TypeCodeableReference(UZ Core Patient, UZ Core Practitioner, UZ Core PractitionerRole, UZ Core RelatedPerson, UZ Core Organization)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Immunization.location
Definition

The service delivery location where the vaccine administration occurred.

ShortVaccination location
Control0..1
TypeReference(UZ Core Location)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Immunization.site
Definition

Body site where vaccine was administered.

ShortAdministration site
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ImmunizationSiteVS (0.13.0)
(extensible to https://terminology.dhp.uz/fhir/core/ValueSet/immunization-site-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Immunization.route
Definition

The path by which the vaccine product is taken into the body.

ShortRoute of administration
Control0..1
BindingFor example codes, see RouteCodeVS (0.13.0)
(example to https://terminology.dhp.uz/fhir/core/ValueSet/route-code-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Immunization.doseQuantity
Definition

The quantity of vaccine product that was administered.

ShortDose
Control0..1
TypeQuantity(SimpleQuantity)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
60. Immunization.performer
Definition

Indicates who performed the immunization event.

ShortPerformer
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Immunization.performer.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
64. Immunization.performer.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
66. Immunization.performer.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
68. Immunization.performer.function
Definition

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

ShortRole
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ImmunizationFunctionCodes
(extensible to http://hl7.org/fhir/ValueSet/immunization-function|5.0.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Immunization.performer.actor
Definition

The practitioner or organization who performed the action.

ShortWho completed
Comments

When the individual practitioner who performed the action is known, it is best to send.

Control1..1
TypeReference(UZ Core Practitioner, UZ Core PractitionerRole, UZ Core Organization, UZ Core Patient, UZ Core RelatedPerson)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Immunization.note
Definition

Extra information about the immunization that is not conveyed by the other attributes.

ShortNotes
Control0..*
TypeAnnotation
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Immunization.reason
Definition

Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.

ShortVaccination reason
Control0..*
BindingFor example codes, see ImmunizationReasonCodes
(example to http://hl7.org/fhir/ValueSet/immunization-reason|5.0.0)
TypeCodeableReference(UZ Core Condition, UZ Core Observation, UZ Core DiagnosticReport)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Immunization.isSubpotent
Definition

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

ShortSubpotent
Comments

Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.

Control0..1
Typeboolean
Is Modifiertrue because This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Meaning if MissingBy default, a dose should be considered to be potent.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Immunization.subpotentReason
Definition

Reason why a dose is considered to be subpotent.

ShortSubpotent reason
Control0..*
BindingFor example codes, see SubpotentReasonVS (0.13.0)
(example to https://terminology.dhp.uz/fhir/core/ValueSet/subpotent-reason-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Immunization.programEligibility
Definition

Indicates a patient's eligibility for a funding program.

ShortVaccination program
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Immunization.programEligibility.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
84. Immunization.programEligibility.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
86. Immunization.programEligibility.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
88. Immunization.programEligibility.program
Definition

Indicates which program the patient had their eligility evaluated for.

ShortProgram
Control1..1
BindingFor example codes, see CodesForVaccineFundingPrograms
(example to http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program|5.0.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Immunization.programEligibility.programStatus
Definition

Indicates the patient's eligility status for for a specific payment program.

ShortParticipation status
Control1..1
BindingFor example codes, see ImmunizationProgramEligibility
(example to http://hl7.org/fhir/ValueSet/immunization-program-eligibility|5.0.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Immunization.fundingSource
Definition

Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

ShortFunding Source
Control0..1
BindingFor example codes, see FundingSourceVS (0.13.0)
(example to https://terminology.dhp.uz/fhir/core/ValueSet/funding-source-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Immunization.reaction
Definition

Categorical data indicating that an adverse event is associated in time to an immunization.

ShortReaction
Comments

A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Immunization.reaction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
98. Immunization.reaction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
100. Immunization.reaction.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
102. Immunization.reaction.date
Definition

Date of reaction to the immunization.

ShortReaction date
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Immunization.reaction.manifestation
Definition

Details of the reaction.

ShortManifestation
Control0..1
BindingThe codes SHALL be taken from ReactionTypeVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/reaction-type-vs|0.13.0)
TypeCodeableReference(UZ Core Observation)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Immunization.reaction.reported
Definition

Self-reported indicator.

ShortSelf-reported
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Immunization.protocolApplied
Definition

The protocol (set of recommendations) being followed by the provider who administered the dose.

ShortProtocol
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Immunization.protocolApplied.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
112. Immunization.protocolApplied.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
114. Immunization.protocolApplied.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
116. Immunization.protocolApplied.series
Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

ShortSeries
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Immunization.protocolApplied.authority
Definition

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

ShortAuthority organization
Control0..1
TypeReference(UZ Core Organization)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. Immunization.protocolApplied.targetDisease
Definition

The vaccine preventable disease the dose is being administered against.

ShortTarget Disease
Control0..*
BindingThe codes SHOULD be taken from TargetDiseaseVS (0.13.0)
(preferred to https://terminology.dhp.uz/fhir/core/ValueSet/target-disease-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Immunization.protocolApplied.targetDisease. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

122. Immunization.protocolApplied.targetDisease:dhpTargetDisease
Slice NamedhpTargetDisease
Definition

The vaccine preventable disease the dose is being administered against.

ShortTarget disease from the national value set
Control0..*
BindingThe codes SHALL be taken from TargetDiseaseVS (0.13.0)
(required to https://terminology.dhp.uz/fhir/core/ValueSet/target-disease-vs|0.13.0)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. Immunization.protocolApplied.doseNumber
Definition

Nominal position in a series as intended by the practitioner administering the dose.

ShortDose number
Comments

The use of an integer is preferred if known. Text should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. Immunization.protocolApplied.seriesDoses
Definition

The recommended number of doses to achieve immunity as intended by the practitioner administering the dose.

ShortTotal doses
Comments

The use of an integer is preferred if known.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))