Uzbekistan Digital Health Platform
0.5.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.5.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 ImmunizationRecommendation ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-immunization-recommendation Version: 0.5.0
Active as of 2026-05-07 Computable Name: UZCoreImmunizationRecommendation

Uzbekistan Core ImmunizationRecommendation profile, used to represent guidance or recommendations related to immunization.

UZ Core ImmunizationRecommendation is a computed forecast of which vaccines a patient is due, overdue or scheduled for on the Digital Health Platform. It is generated automatically from the active national immunization schedule (see PlanDefinition), the patient's Immunization history, and their demographics - it is not hand-entered. Each recommendation entry names a vaccine and/or target disease, the forecast status (due, overdue, and so on), the dose number in the series, and the dates that drive the recommendation. It references the Patient the forecast is for.

Mandatory and Must Support data elements

The elements below must always be present (mandatory) or must be supported when the data is available (Must Support) - not all are required, but your system must populate each Must Support element when it has the data and process it on receipt. This is the human-readable summary; the formal views below give the exact cardinalities, types, and terminology bindings.

Each UZ Core ImmunizationRecommendation Must Have

Every ImmunizationRecommendation must name the patient the forecast is for, the date the recommendation was created, and at least one recommendation entry. Each entry must carry a forecast status (due, overdue, scheduled, etc.) and either a vaccine code or a target disease - the uzcore-imrec-1 rule requires at least one of the two - and where a date criterion is given, both its code (which kind of date) and its value (the date itself) are mandatory.

Each UZ Core ImmunizationRecommendation Must Support

  • a business identifier and the responsible authority organization;
  • within each recommendation entry: the vaccine code, target disease, any contraindicated vaccine code, the forecast reason, and the date criterion (e.g. earliest date to give, date due, date overdue);
  • the description, series name, dose number and total series doses;
  • the supporting immunization records and supporting patient information the forecast was based on.

This resource is produced by the recommendation engine. Clients read it to know what is due; they should not author it directly.

Building the JSON, step by step

This resource is produced by the recommendation engine, but it helps to know its shape when you read one. The examples below go from the smallest valid instance to a fully populated forecast - every value shown validates against this profile. The full reference instance is linked at the bottom of the page (example recommendation).

The smallest valid recommendation

A recommendation needs the patient it is for, the date it was created, and at least one recommendation entry. Each entry must carry a forecastStatus and either a vaccineCode or a targetDisease (the uzcore-imrec-1 rule requires at least one of the two). Every UZ Core resource also names the profile it claims to conform to in meta.profile. This much already validates:

{
  "resourceType": "ImmunizationRecommendation",
  "meta": {
    "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-immunization-recommendation"]
  },
  "patient": { "reference": "Patient/example-emma" },
  "date": "2025-08-01T10:00:00+05:00",
  "recommendation": [
    {
      "vaccineCode": [
        { "coding": [{ "system": "http://hl7.org/fhir/sid/cvx", "code": "03", "display": "measles, mumps and rubella virus vaccine" }] }
      ],
      "forecastStatus": {
        "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/immunization-recommendation-status", "code": "due", "display": "Due" }]
      }
    }
  ]
}

patient is a plain Reference to a Patient. vaccineCode is bound to the national vaccine value set (CVX above), and forecastStatus (due, overdue, scheduled, …) says where the patient stands in the schedule.

A fully populated forecast

In practice the engine emits much more: the responsible authority organization, the targetDisease the vaccine protects against, the forecastReason behind the status, a dateCriterion (when the dose is earliest, due or overdue), the series/doseNumber/seriesDoses, and the supportingImmunization and supportingPatientInformation the forecast was based on:

{
  "resourceType": "ImmunizationRecommendation",
  "meta": {
    "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-immunization-recommendation"]
  },
  "patient": { "reference": "Patient/example-emma" },
  "date": "2025-08-01T10:00:00+05:00",
  "authority": { "reference": "Organization/example-organization" },
  "recommendation": [
    {
      "vaccineCode": [
        { "coding": [{ "system": "http://hl7.org/fhir/sid/cvx", "code": "03", "display": "measles, mumps and rubella virus vaccine" }] }
      ],
      "targetDisease": [
        { "coding": [{ "system": "http://snomed.info/sct", "code": "14189004", "display": "Measles" }] }
      ],
      "forecastStatus": {
        "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/immunization-recommendation-status", "code": "due", "display": "Due" }]
      },
      "forecastReason": [
        { "coding": [{ "system": "http://snomed.info/sct", "code": "77386006", "display": "Pregnancy" }] }
      ],
      "dateCriterion": [
        {
          "code": { "coding": [{ "system": "http://loinc.org", "code": "30981-5", "display": "Earliest date to give" }] },
          "value": "2025-08-10T09:00:00+05:00"
        }
      ],
      "description": "Patient is recommended to receive measles vaccination according to the national immunization schedule.",
      "series": "Routine measles immunization series",
      "doseNumber": "1",
      "seriesDoses": "2",
      "supportingImmunization": [ { "reference": "Immunization/example-measles-immunization" } ],
      "supportingPatientInformation": [ { "reference": "Condition/example-pregnancy" } ]
    }
  ]
}

authority, supportingImmunization (to an Immunization) and supportingPatientInformation are all plain Reference types. dateCriterion.code selects which date the value is (earliest to give, due, overdue); see Terminology for the bound value sets.

For example API calls and a sample payload, see the Quick Start at the bottom of this page.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(5.0.0) Guidance or advice relating to an immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... patient SΣ 1..1 Reference(UZ Core Patient(0.5.0)) Patient for whom the recommendation is intended
... date SΣ 1..1 dateTime Recommendation creation date
... authority S 0..1 Reference(UZ Core Organization(0.5.0)) Responsible organization
... recommendation SΣC 1..* BackboneElement Vaccination recommendation
Constraints: imr-1, uzcore-imrec-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... vaccineCode SΣC 0..* CodeableConcept Recommended vaccine or vaccine group
Binding: VaccineCodeVS (0.5.0) (extensible)
.... targetDisease SΣC 0..* CodeableConcept Disease against which immunization is recommended
Binding: TargetDiseaseVS (0.5.0) (example)
.... contraindicatedVaccineCode SΣ 0..* CodeableConcept Contraindicated vaccine
Binding: VaccineCodeVS (0.5.0) (example)
.... forecastStatus ?!SΣ 1..1 CodeableConcept Immunization recommendation status
Binding: RecommendationforecastStatusVS (0.5.0) (example)
.... forecastReason SΣ 0..* CodeableConcept Reason for recommendation status
Binding: RecommendationReasonVS (0.5.0) (example)
.... dateCriterion S 0..* BackboneElement Dates used to guide the recommended immunization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code S 1..1 CodeableConcept Date criterion type
Binding: RecommendationDateCriterionVS (0.5.0) (example)
..... value S 1..1 dateTime Recommended date
.... description S 0..1 markdown Vaccination protocol details
.... series S 0..1 string Vaccination series name
.... doseNumber SΣ 0..1 string Recommended dose number in the series
.... seriesDoses S 0..1 string Recommended number of doses for immunity
.... supportingImmunization S 0..* Reference(UZ Core Immunization(0.5.0) | ImmunizationEvaluation) Previous immunizations supporting the recommendation
.... supportingPatientInformation S 0..* Reference(Resource) Patient information supporting the recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base extensible Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base example Target disease value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization recommendation forecast status value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization recommendation reason value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization recommendation date criterion value set 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation 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 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.series, ImmunizationRecommendation.recommendation.doseNumber, ImmunizationRecommendation.recommendation.seriesDoses, ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()
uzcore-imrec-1 error ImmunizationRecommendation.recommendation Either vaccineCode or targetDisease SHALL be present. vaccineCode.exists() or targetDisease.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(5.0.0) Guidance or advice relating to an immunization
... identifier S 0..* Identifier Business identifier
... patient S 1..1 Reference(UZ Core Patient(0.5.0)) Patient for whom the recommendation is intended
... date S 1..1 dateTime Recommendation creation date
... recommendation SC 1..* BackboneElement Vaccination recommendation
.... vaccineCode S 0..* CodeableConcept Recommended vaccine or vaccine group
Binding: VaccineCodeVS (0.5.0) (extensible)
.... targetDisease S 0..* CodeableConcept Disease against which immunization is recommended
Binding: TargetDiseaseVS (0.5.0) (example)
.... contraindicatedVaccineCode S 0..* CodeableConcept Contraindicated vaccine
Binding: VaccineCodeVS (0.5.0) (example)
.... forecastStatus S 1..1 CodeableConcept Immunization recommendation status
Binding: RecommendationforecastStatusVS (0.5.0) (example)
.... forecastReason S 0..* CodeableConcept Reason for recommendation status
Binding: RecommendationReasonVS (0.5.0) (example)
.... dateCriterion S 0..* BackboneElement Dates used to guide the recommended immunization
..... code S 1..1 CodeableConcept Date criterion type
Binding: RecommendationDateCriterionVS (0.5.0) (example)
..... value S 1..1 dateTime Recommended date
.... description S 0..1 markdown Vaccination protocol details
.... series S 0..1 string Vaccination series name
.... doseNumber S 0..1 string Recommended dose number in the series
.... seriesDoses S 0..1 string Recommended number of doses for immunity
.... supportingImmunization S 0..* Reference(UZ Core Immunization(0.5.0) | ImmunizationEvaluation) Previous immunizations supporting the recommendation
.... supportingPatientInformation S 0..* Reference(Resource) Patient information supporting the recommendation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base extensible Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base example Target disease value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization recommendation forecast status value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization recommendation reason value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization recommendation date criterion value set 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(5.0.0) Guidance or advice relating to an immunization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier SΣ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(UZ Core Patient(0.5.0)) Patient for whom the recommendation is intended
... date SΣ 1..1 dateTime Recommendation creation date
... authority S 0..1 Reference(UZ Core Organization(0.5.0)) Responsible organization
... recommendation SΣC 1..* BackboneElement Vaccination recommendation
Constraints: imr-1, uzcore-imrec-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... vaccineCode SΣC 0..* CodeableConcept Recommended vaccine or vaccine group
Binding: VaccineCodeVS (0.5.0) (extensible)
.... targetDisease SΣC 0..* CodeableConcept Disease against which immunization is recommended
Binding: TargetDiseaseVS (0.5.0) (example)
.... contraindicatedVaccineCode SΣ 0..* CodeableConcept Contraindicated vaccine
Binding: VaccineCodeVS (0.5.0) (example)
.... forecastStatus ?!SΣ 1..1 CodeableConcept Immunization recommendation status
Binding: RecommendationforecastStatusVS (0.5.0) (example)
.... forecastReason SΣ 0..* CodeableConcept Reason for recommendation status
Binding: RecommendationReasonVS (0.5.0) (example)
.... dateCriterion S 0..* BackboneElement Dates used to guide the recommended immunization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code S 1..1 CodeableConcept Date criterion type
Binding: RecommendationDateCriterionVS (0.5.0) (example)
..... value S 1..1 dateTime Recommended date
.... description S 0..1 markdown Vaccination protocol details
.... series S 0..1 string Vaccination series name
.... doseNumber SΣ 0..1 string Recommended dose number in the series
.... seriesDoses S 0..1 string Recommended number of doses for immunity
.... supportingImmunization S 0..* Reference(UZ Core Immunization(0.5.0) | ImmunizationEvaluation) Previous immunizations supporting the recommendation
.... supportingPatientInformation S 0..* Reference(Resource) Patient information supporting the recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​language Base required All Languages 📍5.0.0 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base extensible Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base example Target disease value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization recommendation forecast status value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization recommendation reason value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization recommendation date criterion value set 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation 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 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImmunizationRecommendation.meta, ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.language, ImmunizationRecommendation.text, ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.series, ImmunizationRecommendation.recommendation.doseNumber, ImmunizationRecommendation.recommendation.seriesDoses, ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()
uzcore-imrec-1 error ImmunizationRecommendation.recommendation Either vaccineCode or targetDisease SHALL be present. vaccineCode.exists() or targetDisease.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(5.0.0) Guidance or advice relating to an immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... patient SΣ 1..1 Reference(UZ Core Patient(0.5.0)) Patient for whom the recommendation is intended
... date SΣ 1..1 dateTime Recommendation creation date
... authority S 0..1 Reference(UZ Core Organization(0.5.0)) Responsible organization
... recommendation SΣC 1..* BackboneElement Vaccination recommendation
Constraints: imr-1, uzcore-imrec-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... vaccineCode SΣC 0..* CodeableConcept Recommended vaccine or vaccine group
Binding: VaccineCodeVS (0.5.0) (extensible)
.... targetDisease SΣC 0..* CodeableConcept Disease against which immunization is recommended
Binding: TargetDiseaseVS (0.5.0) (example)
.... contraindicatedVaccineCode SΣ 0..* CodeableConcept Contraindicated vaccine
Binding: VaccineCodeVS (0.5.0) (example)
.... forecastStatus ?!SΣ 1..1 CodeableConcept Immunization recommendation status
Binding: RecommendationforecastStatusVS (0.5.0) (example)
.... forecastReason SΣ 0..* CodeableConcept Reason for recommendation status
Binding: RecommendationReasonVS (0.5.0) (example)
.... dateCriterion S 0..* BackboneElement Dates used to guide the recommended immunization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code S 1..1 CodeableConcept Date criterion type
Binding: RecommendationDateCriterionVS (0.5.0) (example)
..... value S 1..1 dateTime Recommended date
.... description S 0..1 markdown Vaccination protocol details
.... series S 0..1 string Vaccination series name
.... doseNumber SΣ 0..1 string Recommended dose number in the series
.... seriesDoses S 0..1 string Recommended number of doses for immunity
.... supportingImmunization S 0..* Reference(UZ Core Immunization(0.5.0) | ImmunizationEvaluation) Previous immunizations supporting the recommendation
.... supportingPatientInformation S 0..* Reference(Resource) Patient information supporting the recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base extensible Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base example Target disease value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization recommendation forecast status value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization recommendation reason value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization recommendation date criterion value set 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation 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 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.series, ImmunizationRecommendation.recommendation.doseNumber, ImmunizationRecommendation.recommendation.seriesDoses, ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()
uzcore-imrec-1 error ImmunizationRecommendation.recommendation Either vaccineCode or targetDisease SHALL be present. vaccineCode.exists() or targetDisease.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(5.0.0) Guidance or advice relating to an immunization
... identifier S 0..* Identifier Business identifier
... patient S 1..1 Reference(UZ Core Patient(0.5.0)) Patient for whom the recommendation is intended
... date S 1..1 dateTime Recommendation creation date
... recommendation SC 1..* BackboneElement Vaccination recommendation
.... vaccineCode S 0..* CodeableConcept Recommended vaccine or vaccine group
Binding: VaccineCodeVS (0.5.0) (extensible)
.... targetDisease S 0..* CodeableConcept Disease against which immunization is recommended
Binding: TargetDiseaseVS (0.5.0) (example)
.... contraindicatedVaccineCode S 0..* CodeableConcept Contraindicated vaccine
Binding: VaccineCodeVS (0.5.0) (example)
.... forecastStatus S 1..1 CodeableConcept Immunization recommendation status
Binding: RecommendationforecastStatusVS (0.5.0) (example)
.... forecastReason S 0..* CodeableConcept Reason for recommendation status
Binding: RecommendationReasonVS (0.5.0) (example)
.... dateCriterion S 0..* BackboneElement Dates used to guide the recommended immunization
..... code S 1..1 CodeableConcept Date criterion type
Binding: RecommendationDateCriterionVS (0.5.0) (example)
..... value S 1..1 dateTime Recommended date
.... description S 0..1 markdown Vaccination protocol details
.... series S 0..1 string Vaccination series name
.... doseNumber S 0..1 string Recommended dose number in the series
.... seriesDoses S 0..1 string Recommended number of doses for immunity
.... supportingImmunization S 0..* Reference(UZ Core Immunization(0.5.0) | ImmunizationEvaluation) Previous immunizations supporting the recommendation
.... supportingPatientInformation S 0..* Reference(Resource) Patient information supporting the recommendation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base extensible Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base example Target disease value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization recommendation forecast status value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization recommendation reason value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization recommendation date criterion value set 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(5.0.0) Guidance or advice relating to an immunization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier SΣ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(UZ Core Patient(0.5.0)) Patient for whom the recommendation is intended
... date SΣ 1..1 dateTime Recommendation creation date
... authority S 0..1 Reference(UZ Core Organization(0.5.0)) Responsible organization
... recommendation SΣC 1..* BackboneElement Vaccination recommendation
Constraints: imr-1, uzcore-imrec-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... vaccineCode SΣC 0..* CodeableConcept Recommended vaccine or vaccine group
Binding: VaccineCodeVS (0.5.0) (extensible)
.... targetDisease SΣC 0..* CodeableConcept Disease against which immunization is recommended
Binding: TargetDiseaseVS (0.5.0) (example)
.... contraindicatedVaccineCode SΣ 0..* CodeableConcept Contraindicated vaccine
Binding: VaccineCodeVS (0.5.0) (example)
.... forecastStatus ?!SΣ 1..1 CodeableConcept Immunization recommendation status
Binding: RecommendationforecastStatusVS (0.5.0) (example)
.... forecastReason SΣ 0..* CodeableConcept Reason for recommendation status
Binding: RecommendationReasonVS (0.5.0) (example)
.... dateCriterion S 0..* BackboneElement Dates used to guide the recommended immunization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code S 1..1 CodeableConcept Date criterion type
Binding: RecommendationDateCriterionVS (0.5.0) (example)
..... value S 1..1 dateTime Recommended date
.... description S 0..1 markdown Vaccination protocol details
.... series S 0..1 string Vaccination series name
.... doseNumber SΣ 0..1 string Recommended dose number in the series
.... seriesDoses S 0..1 string Recommended number of doses for immunity
.... supportingImmunization S 0..* Reference(UZ Core Immunization(0.5.0) | ImmunizationEvaluation) Previous immunizations supporting the recommendation
.... supportingPatientInformation S 0..* Reference(Resource) Patient information supporting the recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​language Base required All Languages 📍5.0.0 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base extensible Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base example Target disease value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Code ValueSet 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization recommendation forecast status value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization recommendation reason value set 📍0.5.0 This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization recommendation date criterion value set 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation 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 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImmunizationRecommendation.meta, ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.language, ImmunizationRecommendation.text, ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.series, ImmunizationRecommendation.recommendation.doseNumber, ImmunizationRecommendation.recommendation.seriesDoses, ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()
uzcore-imrec-1 error ImmunizationRecommendation.recommendation Either vaccineCode or targetDisease SHALL be present. vaccineCode.exists() or targetDisease.exists()

 

Other representations of profile: CSV, Excel, Schematron

Quick Start

Common API interactions for this profile. Requests require a JWT access token - see Security and authentication. [base] is the FHIR server base URL; | separates a token system from its value and must be URL-encoded as %7C. These interactions use standard FHIR R5 search parameters; see the CapabilityStatement as it is finalized for this resource.

Read a recommendation by server id

GET [base]/ImmunizationRecommendation/[id]

Useful searches

# the current forecast for a patient
GET [base]/ImmunizationRecommendation?patient=Patient/[id]

# most recent forecast first
GET [base]/ImmunizationRecommendation?patient=Patient/[id]&_sort=-date

# what a patient is due for, by status, target disease or vaccine type
GET [base]/ImmunizationRecommendation?patient=Patient/[id]&status=due
GET [base]/ImmunizationRecommendation?patient=Patient/[id]&target-disease=http://snomed.info/sct%7C14189004
GET [base]/ImmunizationRecommendation?patient=Patient/[id]&vaccine-type=http://hl7.org/fhir/sid/cvx%7C03

Create a recommendation

POST [base]/ImmunizationRecommendation
{
  "resourceType": "ImmunizationRecommendation",
  "meta": {
    "profile": [
      "https://dhp.uz/fhir/core/StructureDefinition/uz-core-immunization-recommendation"
    ]
  },
  ...
}

This resource is normally generated by the recommendation engine from the active schedule and the patient's immunization history, rather than authored by hand.

Update a recommendation (the engine replaces the forecast as new history arrives)

PUT [base]/ImmunizationRecommendation/[id]
If-Match: W/"3"   # the ETag from your last read; 412 if it changed since
{
  "resourceType": "ImmunizationRecommendation",
  "id": "[id]",
  "meta": {
    "profile": [
      "https://dhp.uz/fhir/core/StructureDefinition/uz-core-immunization-recommendation"
    ]
  },
  ...
}