Immunization resource (FHIR R4)
Immunization is a FHIR R4 resource. The Pidgeon engine generates synthetic Immunization instances and validates them against the R4 structure definitions.
| Resource | Immunization |
|---|---|
| FHIR version | R4 (4.0.1) |
| Canonical URL | http://hl7.org/fhir/StructureDefinition/Immunization |
| Required elements | status (1..1), vaccineCode (1..1), patient (1..1), occurrence[x] (1..1) |
| IG profiles in this catalog | 1 |
Example
{
"resourceType": "Immunization",
"id": "immunization-64a2e245ff5fc6f5239f2308aa24fb0d",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "20",
"display": "Diphtheria, tetanus toxoids, pertussis"
},
{
"system": "http://snomed.info/sct",
"code": "omitted",
"display": "SNOMED CT code omitted from this published example"
}
],
"text": "Diphtheria, tetanus toxoids, pertussis"
},
"patient": {
"reference": "Patient/patient-L46A6EIB9J"
},
"occurrenceDateTime": "2026-03-28T12:00:00Z",
"lotNumber": "LOT-89283-A",
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
"code": "LA",
"display": "Left arm"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
"code": "IM",
"display": "Injection, intramuscular"
}
]
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP",
"display": "Administering Provider"
}
]
},
"actor": {
"display": "Nurse Smith, RN"
}
}
]
}Generated by the Pidgeon engine: pidgeon generate Immunization --seed 20260722. Codes from licensed terminologies (LOINC, SNOMED CT, CPT, RxNorm) are omitted from published examples.
Validation context
- strict pidgeon validate grades a Immunization instance against the base R4 structure definition: missing required elements raise REQUIRED_FIELD_MISSING and cardinality violations raise CARDINALITY_MIN or CARDINALITY_MAX.(REQUIRED_FIELD_MISSING)
- strict Profile validation grades the same instance against an installed IG profile: profile cardinality findings carry FHIR-PROFILE-CARDINALITY and terminology binding findings carry FHIR-PROFILE-BINDING.(FHIR-PROFILE-CARDINALITY)
This answer, in your terminal
pidgeon lookup ImmunizationWire it into your AI agent:
claude mcp add pidgeon -- npx -y @pidgeonhealth/mcpDownload Post free to browse this reference with generation attached.