{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/august-health/json-schema/august-health-com-august-api-integrations-models-immunizations-v1-immunization-schema.json",
  "title": "com.august.api.integrations.models.immunizations.v1.Immunization",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/august-health-immunizations-v1-api-openapi.yml#/components/schemas/com.august.api.integrations.models.immunizations.v1.Immunization",
  "properties": {
    "id": {
      "description": "The immunization's ID",
      "type": "string"
    },
    "lotNumber": {
      "description": "The vaccine lot number",
      "type": "string"
    },
    "manufacturer": {
      "$ref": "#/$defs/com.august.api.integrations.models.immunizations.v1.Manufacturer",
      "description": "The organization that manufactured the vaccine"
    },
    "note": {
      "$ref": "#/$defs/com.august.api.integrations.models.immunizations.v1.Note",
      "description": "A free-text note about the immunization"
    },
    "occurrenceDate": {
      "format": "date",
      "type": "string"
    },
    "performer": {
      "description": "The person who administered the immunization",
      "type": "string"
    },
    "personId": {
      "description": "The resident this immunization belongs to",
      "type": "string"
    },
    "protocolApplied": {
      "$ref": "#/$defs/com.august.api.integrations.models.immunizations.v1.Protocol",
      "description": "The immunization protocol that was followed"
    },
    "route": {
      "$ref": "#/$defs/com.august.api.integrations.models.medication_orders.v1.CodeableConcept",
      "description": "The route by which the immunization was administered"
    },
    "site": {
      "$ref": "#/$defs/com.august.api.integrations.models.medication_orders.v1.CodeableConcept",
      "description": "The body site where the immunization was administered"
    }
  },
  "required": [
    "id",
    "personId",
    "occurrenceDate",
    "protocolApplied"
  ],
  "$defs": {
    "com.august.api.integrations.models.common_metadata.v1.Address": {
      "properties": {
        "city": {
          "type": "string"
        },
        "line": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "postalCode": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "text": {
          "type": "string"
        },
        "use": {
          "$ref": "#/$defs/com.august.protos.address.Address.AddressUse"
        }
      },
      "required": [
        "line"
      ]
    },
    "com.august.api.integrations.models.common_metadata.v1.HumanName": {
      "properties": {
        "family": {
          "type": "string"
        },
        "given": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "maiden": {
          "type": "string"
        },
        "preferredName": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        },
        "pronouns": {
          "$ref": "#/$defs/com.august.protos.human_name.HumanName.Pronouns"
        },
        "suffix": {
          "type": "string"
        }
      },
      "required": [
        "given"
      ]
    },
    "com.august.api.integrations.models.common_metadata.v1.UserReference": {
      "properties": {
        "userId": {
          "description": "The user's ID",
          "type": "string"
        },
        "userName": {
          "$ref": "#/$defs/com.august.api.integrations.models.common_metadata.v1.HumanName",
          "description": "The user's name"
        }
      }
    },
    "com.august.api.integrations.models.contacts.v1.ContactPoint": {
      "properties": {
        "rank": {
          "format": "int32",
          "type": "integer"
        },
        "system": {
          "$ref": "#/$defs/com.august.protos.contact_point.ContactPoint.ContactPointSystem"
        },
        "use": {
          "$ref": "#/$defs/com.august.protos.contact_point.ContactPoint.ContactPointUse"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "system",
        "use"
      ]
    },
    "com.august.api.integrations.models.contacts.v1.GenericOrganizationContact": {
      "properties": {
        "address": {
          "$ref": "#/$defs/com.august.api.integrations.models.common_metadata.v1.Address"
        },
        "name": {
          "$ref": "#/$defs/com.august.api.integrations.models.common_metadata.v1.HumanName"
        },
        "telecom": {
          "items": {
            "$ref": "#/$defs/com.august.api.integrations.models.contacts.v1.ContactPoint"
          },
          "type": "array"
        }
      },
      "required": [
        "telecom"
      ]
    },
    "com.august.api.integrations.models.immunizations.v1.Manufacturer": {
      "properties": {
        "address": {
          "description": "Addresses for the manufacturer",
          "items": {
            "$ref": "#/$defs/com.august.api.integrations.models.common_metadata.v1.Address",
            "description": "Addresses for the manufacturer"
          },
          "type": "array"
        },
        "contact": {
          "description": "Named contacts at the manufacturer for a specific purpose",
          "items": {
            "$ref": "#/$defs/com.august.api.integrations.models.contacts.v1.GenericOrganizationContact",
            "description": "Named contacts at the manufacturer for a specific purpose"
          },
          "type": "array"
        },
        "name": {
          "description": "The manufacturer's name",
          "type": "string"
        },
        "telecom": {
          "description": "Contact details (phone, email, etc.) for the manufacturer",
          "items": {
            "$ref": "#/$defs/com.august.api.integrations.models.contacts.v1.ContactPoint",
            "description": "Contact details (phone, email, etc.) for the manufacturer"
          },
          "type": "array"
        }
      }
    },
    "com.august.api.integrations.models.immunizations.v1.Note": {
      "properties": {
        "author": {
          "$ref": "#/$defs/com.august.api.integrations.models.common_metadata.v1.UserReference",
          "description": "The user who wrote the note"
        },
        "text": {
          "description": "The note text",
          "type": "string"
        },
        "time": {
          "description": "When the note was written",
          "format": "date-time",
          "type": "string"
        }
      }
    },
    "com.august.api.integrations.models.immunizations.v1.Protocol": {
      "properties": {
        "doseNumber": {
          "$ref": "#/$defs/com.august.protos.immunization.DoseNumber",
          "description": "The dose number within the series"
        },
        "seriesDoses": {
          "description": "The total number of doses in the series",
          "format": "int32",
          "type": "integer"
        },
        "targetDisease": {
          "$ref": "#/$defs/com.august.api.integrations.models.medication_orders.v1.CodeableConcept",
          "description": "The disease the immunization targets"
        }
      },
      "required": [
        "targetDisease"
      ]
    },
    "com.august.api.integrations.models.medication_orders.v1.CodeableConcept": {
      "properties": {
        "coding": {
          "description": "Structured identifiers from coding systems (e.g., NDC, RxNorm, SNOMED CT)",
          "items": {
            "$ref": "#/$defs/com.august.api.integrations.models.medication_orders.v1.Coding",
            "description": "Structured identifiers from coding systems (e.g., NDC, RxNorm, SNOMED CT)"
          },
          "type": "array"
        },
        "text": {
          "description": "Human-readable display name",
          "type": "string"
        }
      },
      "required": [
        "coding",
        "text"
      ]
    },
    "com.august.api.integrations.models.medication_orders.v1.Coding": {
      "properties": {
        "code": {
          "description": "The code value within the system",
          "type": "string"
        },
        "display": {
          "description": "Human-readable description of the code",
          "type": "string"
        },
        "system": {
          "$ref": "#/$defs/com.august.protos.codeable_concept.SystemUrl",
          "description": "The coding system (e.g., RXNORM, NDC, SNOMED_CT)"
        }
      },
      "required": [
        "system",
        "code",
        "display"
      ]
    },
    "com.august.protos.address.Address.AddressUse": {
      "enum": [
        "ADDRESS_USE_HOME",
        "ADDRESS_USE_WORK",
        "ADDRESS_USE_TEMP",
        "ADDRESS_USE_OLD",
        "ADDRESS_USE_BILLING"
      ],
      "type": "string"
    },
    "com.august.protos.codeable_concept.SystemUrl": {
      "enum": [
        "SYSTEM_URL_RXNORM",
        "SYSTEM_URL_SNOMED_CT",
        "SYSTEM_URL_NDC",
        "SYSTEM_URL_ICD_10",
        "SYSTEM_URL_DEA",
        "SYSTEM_URL_EDQM",
        "SYSTEM_URL_GPI",
        "SYSTEM_URL_NPI",
        "SYSTEM_URL_UPC"
      ],
      "type": "string"
    },
    "com.august.protos.contact_point.ContactPoint.ContactPointSystem": {
      "enum": [
        "CONTACT_POINT_SYSTEM_PHONE",
        "CONTACT_POINT_SYSTEM_FAX",
        "CONTACT_POINT_SYSTEM_EMAIL"
      ],
      "type": "string"
    },
    "com.august.protos.contact_point.ContactPoint.ContactPointUse": {
      "enum": [
        "CONTACT_POINT_USE_HOME",
        "CONTACT_POINT_USE_WORK",
        "CONTACT_POINT_USE_MOBILE",
        "CONTACT_POINT_USE_PAGER",
        "CONTACT_POINT_USE_EMERGENCY"
      ],
      "type": "string"
    },
    "com.august.protos.human_name.HumanName.Pronouns": {
      "enum": [
        "PRONOUNS_SHE_HER",
        "PRONOUNS_HE_HIM",
        "PRONOUNS_THEY_THEM",
        "PRONOUNS_SHE_THEY",
        "PRONOUNS_HE_THEY",
        "PRONOUNS_ZE_HIR"
      ],
      "type": "string"
    },
    "com.august.protos.immunization.DoseNumber": {
      "enum": [
        "DOSE_NUMBER_1",
        "DOSE_NUMBER_2",
        "DOSE_NUMBER_BOOSTER",
        "DOSE_NUMBER_BOOSTER_2",
        "DOSE_NUMBER_BOOSTER_3",
        "DOSE_NUMBER_BOOSTER_4"
      ],
      "type": "string"
    }
  }
}