Aetna · Schema

Aetna FHIR R4 Immunization

JSON Schema for the FHIR R4 Immunization resource as Aetna profiles it. Derived mechanically from the components.schemas of openapi/aetna-patient-access-api-openapi.yml, which is assembled from the Swagger 2.0 documents Aetna publishes at https://developerportal.aetna.com/managedcontent/yaml/. Not authored - every constraint here is Aetna's. $refs rewritten from #/components/schemas/ to #/$defs/.

Health InsuranceHealthcareFHIRPatient AccessProvider DirectoryDrug FormularyPrior AuthorizationCMS InteroperabilitySMART on FHIRCARIN Blue ButtonDa VinciPayerFortune 100CVS Health
View JSON Schema on GitHub

JSON Schema

aetna-immunization.json Raw ↑
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "$id": "https://raw.githubusercontent.com/api-evangelist/aetna/refs/heads/main/json-schema/aetna-immunization.json",
 "title": "Aetna FHIR R4 Immunization",
 "description": "JSON Schema for the FHIR R4 Immunization resource as Aetna profiles it. Derived mechanically from the components.schemas of openapi/aetna-patient-access-api-openapi.yml, which is assembled from the Swagger 2.0 documents Aetna publishes at https://developerportal.aetna.com/managedcontent/yaml/. Not authored - every constraint here is Aetna's. $refs rewritten from #/components/schemas/ to #/$defs/.",
 "x-provenance": {
  "generated": "2026-08-30",
  "method": "derived",
  "source": "openapi/aetna-patient-access-api-openapi.yml"
 },
 "allOf": [
  {
   "$ref": "#/$defs/DomainResource"
  },
  {
   "type": "object",
   "required": [
    "patient",
    "status",
    "vaccineCode"
   ],
   "properties": {
    "primarySource": {
     "description": "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.",
     "type": "boolean"
    },
    "note": {
     "description": "Extra information about the immunization that is not conveyed by the other attributes.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/Annotation"
     }
    },
    "education": {
     "description": "Educational material presented to the patient (or guardian) at the time of vaccine administration.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/Immunization_Education"
     }
    },
    "doseQuantity": {
     "description": "The quantity of vaccine product that was administered.",
     "$ref": "#/$defs/SimpleQuantity"
    },
    "reasonReference": {
     "description": "Condition, Observation or DiagnosticReport that supports why the immunization was administered.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/Reference"
     }
    },
    "manufacturer": {
     "description": "Name of vaccine manufacturer.",
     "$ref": "#/$defs/Reference"
    },
    "programEligibility": {
     "description": "Indicates a patient's eligibility for a funding program.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/CodeableConcept"
     }
    },
    "statusReason": {
     "description": "Indicates the reason the immunization event was not performed.",
     "$ref": "#/$defs/CodeableConcept"
    },
    "isSubpotent": {
     "description": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.",
     "type": "boolean"
    },
    "patient": {
     "description": "The patient who either received or did not receive the immunization.",
     "$ref": "#/$defs/Reference"
    },
    "reasonCode": {
     "description": "Reasons why the vaccine was administered.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/CodeableConcept"
     }
    },
    "vaccineCode": {
     "description": "Vaccine that was administered or was to be administered.",
     "$ref": "#/$defs/CodeableConcept"
    },
    "expirationDate": {
     "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]))?)?",
     "description": "Date vaccine batch expires.",
     "type": "string"
    },
    "identifier": {
     "description": "A unique identifier assigned to this immunization record.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/Identifier"
     }
    },
    "performer": {
     "description": "Indicates who performed the immunization event.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/Immunization_Performer"
     }
    },
    "reaction": {
     "description": "Categorical data indicating that an adverse event is associated in time to an immunization.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/Immunization_Reaction"
     }
    },
    "subpotentReason": {
     "description": "Reason why a dose is considered to be subpotent.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/CodeableConcept"
     }
    },
    "encounter": {
     "description": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
     "$ref": "#/$defs/Reference"
    },
    "lotNumber": {
     "pattern": "[ \\r\\n\\t\\S]+",
     "description": "Lot number of the vaccine product.",
     "type": "string"
    },
    "recorded": {
     "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]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
     "description": "The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.",
     "type": "string"
    },
    "site": {
     "description": "Body site where vaccine was administered.",
     "$ref": "#/$defs/CodeableConcept"
    },
    "route": {
     "description": "The path by which the vaccine product is taken into the body.",
     "$ref": "#/$defs/CodeableConcept"
    },
    "protocolApplied": {
     "description": "The protocol (set of recommendations) being followed by the provider who administered the dose.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/Immunization_ProtocolApplied"
     }
    },
    "reportOrigin": {
     "description": "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": "#/$defs/CodeableConcept"
    },
    "occurrenceDateTime": {
     "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]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
     "description": "Date vaccine administered or was to be administered.",
     "type": "string"
    },
    "occurrenceString": {
     "pattern": "[ \\r\\n\\t\\S]+",
     "description": "Date vaccine administered or was to be administered.",
     "type": "string"
    },
    "location": {
     "description": "The service delivery location where the vaccine administration occurred.",
     "$ref": "#/$defs/Reference"
    },
    "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": "#/$defs/CodeableConcept"
    },
    "status": {
     "description": "Indicates the current status of the immunization event.",
     "type": "string",
     "enum": [
      "completed",
      "entered-in-error",
      "not-done"
     ]
    }
   }
  }
 ],
 "$defs": {
  "Address": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "properties": {
      "country": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "Country - a nation as commonly understood or generally accepted.",
       "type": "string"
      },
      "period": {
       "description": "Time period when address was/is in use.",
       "$ref": "#/$defs/Period"
      },
      "city": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "The name of the city, town, suburb, village or other community or delivery center.",
       "type": "string"
      },
      "use": {
       "description": "The purpose of this address.",
       "type": "string",
       "enum": [
        "home",
        "work",
        "temp",
        "old",
        "billing"
       ]
      },
      "line": {
       "description": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
       "type": "array",
       "items": {
        "pattern": "[ \\r\\n\\t\\S]+",
        "type": "string"
       }
      },
      "district": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "The name of the administrative area (county).",
       "type": "string"
      },
      "postalCode": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "A postal code designating a region defined by the postal service.",
       "type": "string"
      },
      "text": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
       "type": "string"
      },
      "state": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
       "type": "string"
      },
      "type": {
       "description": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
       "type": "string",
       "enum": [
        "postal",
        "physical",
        "both"
       ]
      }
     }
    }
   ]
  },
  "Age": {
   "allOf": [
    {
     "$ref": "#/$defs/Quantity"
    },
    {
     "type": "object"
    }
   ]
  },
  "Annotation": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "required": [
      "text"
     ],
     "properties": {
      "authorString": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "The individual responsible for making the annotation.",
       "type": "string"
      },
      "authorReference": {
       "description": "The individual responsible for making the annotation.",
       "$ref": "#/$defs/Reference"
      },
      "time": {
       "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]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
       "description": "Indicates when this particular annotation was made.",
       "type": "string"
      },
      "text": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "The text of the annotation in markdown format.",
       "type": "string"
      }
     }
    }
   ]
  },
  "Attachment": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "properties": {
      "data": {
       "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+",
       "description": "The actual data of the attachment - a sequence of bytes, base64 encoded.",
       "type": "string"
      },
      "size": {
       "format": "int32",
       "description": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
       "type": "integer"
      },
      "language": {
       "pattern": "[^\\s]+(\\s[^\\s]+)*",
       "description": "The human language of the content. The value can be any valid value according to BCP 47.",
       "type": "string"
      },
      "title": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "A label or set of text to display in place of the data.",
       "type": "string"
      },
      "contentType": {
       "pattern": "[^\\s]+(\\s[^\\s]+)*",
       "description": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
       "type": "string"
      },
      "url": {
       "pattern": "\\S*",
       "description": "A location where the data can be accessed.",
       "type": "string"
      },
      "hash": {
       "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+",
       "description": "The calculated hash of the data using SHA-1. Represented using base64.",
       "type": "string"
      },
      "creation": {
       "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]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
       "description": "The date that the attachment was first created.",
       "type": "string"
      }
     }
    }
   ]
  },
  "BackboneElement": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "properties": {
      "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's 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).",
       "type": "array",
       "items": {
        "$ref": "#/$defs/Extension"
       }
      }
     }
    }
   ]
  },
  "CodeableConcept": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "properties": {
      "coding": {
       "description": "A reference to a code defined by a terminology system.",
       "type": "array",
       "items": {
        "$ref": "#/$defs/Coding"
       }
      },
      "text": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
       "type": "string"
      }
     }
    }
   ]
  },
  "Coding": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "properties": {
      "system": {
       "pattern": "\\S*",
       "description": "The identification of the code system that defines the meaning of the symbol in the code.",
       "type": "string"
      },
      "code": {
       "pattern": "[^\\s]+(\\s[^\\s]+)*",
       "description": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
       "type": "string"
      },
      "userSelected": {
       "description": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
       "type": "boolean"
      },
      "display": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "A representation of the meaning of the code in the system, following the rules of the system.",
       "type": "string"
      },
      "version": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
       "type": "string"
      }
     }
    }
   ]
  },
  "ContactDetail": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "properties": {
      "name": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "The name of an individual to contact.",
       "type": "string"
      },
      "telecom": {
       "description": "The contact details for the individual (if a name was provided) or the organization.",
       "type": "array",
       "items": {
        "$ref": "#/$defs/ContactPoint"
       }
      }
     }
    }
   ]
  },
  "ContactPoint": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "properties": {
      "period": {
       "description": "Time period when the contact point was/is in use.",
       "$ref": "#/$defs/Period"
      },
      "system": {
       "description": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
       "type": "string",
       "enum": [
        "phone",
        "fax",
        "email",
        "pager",
        "url",
        "sms",
        "other"
       ]
      },
      "use": {
       "description": "Identifies the purpose for the contact point.",
       "type": "string",
       "enum": [
        "home",
        "work",
        "temp",
        "old",
        "mobile"
       ]
      },
      "rank": {
       "format": "int32",
       "description": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
       "type": "integer"
      },
      "value": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
       "type": "string"
      }
     }
    }
   ]
  },
  "Count": {
   "allOf": [
    {
     "$ref": "#/$defs/Quantity"
    },
    {
     "type": "object"
    }
   ]
  },
  "Distance": {
   "allOf": [
    {
     "$ref": "#/$defs/Quantity"
    },
    {
     "type": "object"
    }
   ]
  },
  "DomainResource": {
   "allOf": [
    {
     "$ref": "#/$defs/Resource"
    },
    {
     "type": "object",
     "properties": {
      "contained": {
       "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
       "type": "array",
       "items": {
        "$ref": "#/$defs/Resource"
       }
      },
      "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.",
       "type": "array",
       "items": {
        "$ref": "#/$defs/Extension"
       }
      },
      "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's 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).",
       "type": "array",
       "items": {
        "$ref": "#/$defs/Extension"
       }
      },
      "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": "#/$defs/Narrative"
      }
     }
    }
   ]
  },
  "Duration": {
   "allOf": [
    {
     "$ref": "#/$defs/Quantity"
    },
    {
     "type": "object"
    }
   ]
  },
  "Element": {
   "type": "object",
   "properties": {
    "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.",
     "type": "array",
     "items": {
      "$ref": "#/$defs/Extension"
     }
    },
    "id": {
     "pattern": "[A-Za-z0-9\\-\\.]{1,64}",
     "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
     "type": "string"
    }
   }
  },
  "Extension": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "required": [
      "url"
     ],
     "properties": {
      "valueBase64Binary": {
       "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueBoolean": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "boolean"
      },
      "valueCoding": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Coding"
      },
      "valueTime": {
       "pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueIdentifier": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Identifier"
      },
      "valueReference": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Reference"
      },
      "valueMoney": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Money"
      },
      "valueRange": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Range"
      },
      "valueSignature": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Signature"
      },
      "valueUri": {
       "pattern": "\\S*",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueDistance": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Distance"
      },
      "valueUrl": {
       "pattern": "\\S*",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueContactDetail": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/ContactDetail"
      },
      "valueMeta": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Meta"
      },
      "valueUuid": {
       "pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueCodeableConcept": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/CodeableConcept"
      },
      "valueRatio": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Ratio"
      },
      "valueMarkdown": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueAttachment": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Attachment"
      },
      "valueUsageContext": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/UsageContext"
      },
      "valueDateTime": {
       "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]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueInteger": {
       "format": "int32",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "integer"
      },
      "valueUnsignedInt": {
       "format": "int32",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "integer"
      },
      "valueHumanName": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/HumanName"
      },
      "valueQuantity": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Quantity"
      },
      "valueRelatedArtifact": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/RelatedArtifact"
      },
      "valueCanonical": {
       "pattern": "\\S*",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueCount": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Count"
      },
      "valueId": {
       "pattern": "[A-Za-z0-9\\-\\.]{1,64}",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueDecimal": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "number"
      },
      "valueCode": {
       "pattern": "[^\\s]+(\\s[^\\s]+)*",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueDate": {
       "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]))?)?",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valueOid": {
       "pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "url": {
       "pattern": "\\S*",
       "description": "Source of the definition for the extension code - a logical name or a URL.",
       "type": "string"
      },
      "valueAddress": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Address"
      },
      "valueContactPoint": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/ContactPoint"
      },
      "valueString": {
       "pattern": "[ \\r\\n\\t\\S]+",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valuePeriod": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Period"
      },
      "valueSampledData": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/SampledData"
      },
      "valueTiming": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Timing"
      },
      "valueInstant": {
       "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]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "string"
      },
      "valuePositiveInt": {
       "format": "int32",
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "type": "integer"
      },
      "valueDuration": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Duration"
      },
      "valueAge": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Age"
      },
      "valueAnnotation": {
       "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
       "$ref": "#/$defs/Annotation"
      }
     }
    }
   ]
  },
  "HumanName": {
   "allOf": [
    {
     "$ref": "#/$defs/Element"
    },
    {
     "type": "object",
     "properties": {
      "given": {
       "description": "Given name.",
       "type": "array",
       "items": {
        "pattern": "[ \\r\\n\\t\\S]+",
        "type": "string"
       }
      },
      "period": {
       "description": "Indicates the period of time when this name was valid for the named person.",
       "$ref": "#/$defs/Period"
      },
      "use": {
       "description": "Identifies the purpose for this name.",
       "type": "string",
       "enum": [
        "usual",
        "offic

# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aetna/refs/heads/main/json-schema/aetna-immunization.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/aetna-immunization"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.