11.9.11 JSON Schema for ImmunizationRecommendation

Public Health and Emergency Response Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Patient

This is a representation of the json schema for ImmunizationRecommendation, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/ImmunizationRecommendation",
  "$ref": "#/definitions/ImmunizationRecommendation",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "ImmunizationRecommendation": {
      "description": "A patient\u0027s point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.",
      "properties": {
        "resourceType": {
          "description": "This is a ImmunizationRecommendation resource",
          "const": "ImmunizationRecommendation"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "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.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "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.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "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.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "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.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "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 manageable, 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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "A unique identifier assigned to this particular recommendation record.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "instantiatesCanonical": {
          "description": "The URL pointing to a FHIR-defined protocol, guideline or other definition that is adhered to in whole or in part by this ImmunizationRecommendation.",
          "items": {
            "$ref": "canonical.schema.json#/definitions/canonical"
          },
          "type": "array"
        },
        "instantiatesUri": {
          "description": "The URL pointing to an externally maintained protocol, guideline or other definition that is adhered to in whole or in part by this ImmunizationRecommendation.",
          "items": {
            "$ref": "#/definitions/uri"
          },
          "type": "array"
        },
        "_instantiatesUri": {
          "description": "Extensions for instantiatesUri",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "patient": {
          "description": "The patient the recommendation(s) are for.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "date": {
          "description": "The date the immunization recommendation(s) were created.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "authority": {
          "description": "Indicates the authority who published the protocol (e.g. ACIP).",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "recommendation": {
          "description": "Vaccine administration recommendations.",
          "items": {
            "$ref": "#/definitions/ImmunizationRecommendation_Recommendation"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "patient",
        "recommendation",
        "resourceType"
      ]
    },
    "ImmunizationRecommendation_Recommendation": {
      "description": "A patient\u0027s point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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 manageable, 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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "vaccineCode": {
          "description": "Vaccine(s) or vaccine group that pertain to the recommendation.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "targetDisease": {
          "description": "The targeted disease for the recommendation.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "contraindicatedVaccineCode": {
          "description": "Vaccine(s) which should not be used to fulfill the recommendation.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "forecastStatus": {
          "description": "Indicates the patient status with respect to the path to immunity for the target disease.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "forecastReason": {
          "description": "The reason for the assigned forecast status.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "dateCriterion": {
          "description": "Vaccine date recommendations.  For example, earliest date to administer, latest date to administer, etc.",
          "items": {
            "$ref": "#/definitions/ImmunizationRecommendation_DateCriterion"
          },
          "type": "array"
        },
        "description": {
          "description": "Contains the description about the protocol under which the vaccine was administered.",
          "$ref": "#/definitions/string"
        },
        "_description": {
          "description": "Extensions for description",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "series": {
          "description": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
          "$ref": "#/definitions/string"
        },
        "_series": {
          "description": "Extensions for series",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "doseNumber": {
          "description": "Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose).",
          "$ref": "#/definitions/string"
        },
        "_doseNumber": {
          "description": "Extensions for doseNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "seriesDoses": {
          "description": "The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process.",
          "$ref": "#/definitions/string"
        },
        "_seriesDoses": {
          "description": "Extensions for seriesDoses",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "supportingImmunization": {
          "description": "Immunization event history and/or evaluation that supports the status and recommendation.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "supportingPatientInformation": {
          "description": "Patient Information that supports the status and recommendation.  This includes patient observations, adverse reactions and allergy/intolerance information.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "forecastStatus"
      ]
    },
    "ImmunizationRecommendation_DateCriterion": {
      "description": "A patient\u0027s point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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 manageable, 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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "code": {
          "description": "Date classification of recommendation.  For example, earliest date to give, latest date to give, etc.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "value": {
          "description": "The date whose meaning is specified by dateCriterion.code.",
          "$ref": "#/definitions/dateTime"
        },
        "_value": {
          "description": "Extensions for value",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false,
      "required": [
        "code"
      ]
    }
  }
}