11.7.12 JSON Schema for Immunization

Public Health and Emergency Response Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Patient, Practitioner

This is a representation of the json schema for Immunization, 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/Immunization",
  "$ref": "#/definitions/Immunization",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Immunization": {
      "description": "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.",
      "properties": {
        "resourceType": {
          "description": "This is a Immunization resource",
          "const": "Immunization"
        },
        "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. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "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 immunization record.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "basedOn": {
          "description": "A plan, order or recommendation fulfilled in whole or in part by this immunization.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "status": {
          "description": "Indicates the current status of the immunization event.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "statusReason": {
          "description": "Indicates the reason the immunization event was not performed.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "vaccineCode": {
          "description": "Vaccine that was administered or was to be administered.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "administeredProduct": {
          "description": "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.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "manufacturer": {
          "description": "Name of vaccine manufacturer.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "lotNumber": {
          "description": "Lot number of the  vaccine product.",
          "$ref": "#/definitions/string"
        },
        "_lotNumber": {
          "description": "Extensions for lotNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "expirationDate": {
          "description": "Date vaccine batch expires.",
          "$ref": "#/definitions/date"
        },
        "_expirationDate": {
          "description": "Extensions for expirationDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "patient": {
          "description": "The patient who either received or did not receive the immunization.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "encounter": {
          "description": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "supportingInformation": {
          "description": "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.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "occurrenceDateTime": {
          "description": "Date vaccine administered or was to be administered.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$",
          "type": "string"
        },
        "_occurrenceDateTime": {
          "description": "Extensions for occurrenceDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "occurrenceString": {
          "description": "Date vaccine administered or was to be administered.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_occurrenceString": {
          "description": "Extensions for occurrenceString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "primarySource": {
          "description": "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 \u0027secondary reported\u0027 data documented by a third party. A value of \u0027true\u0027 means this data originated with the individual/organization which was responsible for the administration of the vaccine.",
          "$ref": "#/definitions/boolean"
        },
        "_primarySource": {
          "description": "Extensions for primarySource",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "informationSource": {
          "description": "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.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "location": {
          "description": "The service delivery location where the vaccine administration occurred.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "site": {
          "description": "Body site where vaccine was administered.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "route": {
          "description": "The path by which the vaccine product is taken into the body.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "doseQuantity": {
          "description": "The quantity of vaccine product that was administered.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "performer": {
          "description": "Indicates who performed the immunization event.",
          "items": {
            "$ref": "#/definitions/Immunization_Performer"
          },
          "type": "array"
        },
        "note": {
          "description": "Extra information about the immunization that is not conveyed by the other attributes.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        },
        "reason": {
          "description": "Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.",
          "items": {
            "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
          },
          "type": "array"
        },
        "isSubpotent": {
          "description": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.",
          "$ref": "#/definitions/boolean"
        },
        "_isSubpotent": {
          "description": "Extensions for isSubpotent",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "subpotentReason": {
          "description": "Reason why a dose is considered to be subpotent.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "programEligibility": {
          "description": "Indicates a patient\u0027s eligibility for a funding program.",
          "items": {
            "$ref": "#/definitions/Immunization_ProgramEligibility"
          },
          "type": "array"
        },
        "fundingSource": {
          "description": "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).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "reaction": {
          "description": "Categorical data indicating that an adverse event is associated in time to an immunization.",
          "items": {
            "$ref": "#/definitions/Immunization_Reaction"
          },
          "type": "array"
        },
        "protocolApplied": {
          "description": "The protocol (set of recommendations) being followed by the provider who administered the dose.",
          "items": {
            "$ref": "#/definitions/Immunization_ProtocolApplied"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "patient",
        "vaccineCode",
        "resourceType"
      ]
    },
    "Immunization_Performer": {
      "description": "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.",
      "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"
        },
        "function": {
          "description": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "actor": {
          "description": "The practitioner or organization who performed the action.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "actor"
      ]
    },
    "Immunization_ProgramEligibility": {
      "description": "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.",
      "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"
        },
        "program": {
          "description": "Indicates which program the patient had their eligility evaluated for.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "programStatus": {
          "description": "Indicates the patient\u0027s eligility status for for a specific payment program.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "program",
        "programStatus"
      ]
    },
    "Immunization_Reaction": {
      "description": "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.",
      "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"
        },
        "date": {
          "description": "Date of reaction to the immunization.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "manifestation": {
          "description": "Details of the reaction.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "reported": {
          "description": "Self-reported indicator.",
          "$ref": "#/definitions/boolean"
        },
        "_reported": {
          "description": "Extensions for reported",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "Immunization_ProtocolApplied": {
      "description": "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.",
      "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"
        },
        "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"
        },
        "authority": {
          "description": "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "targetDisease": {
          "description": "The vaccine preventable disease the dose is being administered against.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "doseNumber": {
          "description": "Nominal position in a series as intended by the practitioner administering the 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 intended by the practitioner administering the dose.",
          "$ref": "#/definitions/string"
        },
        "_seriesDoses": {
          "description": "Extensions for seriesDoses",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}