Skip to main content

Immunization

Overview​

The Immunization resource covers the recording of current and historical administration of vaccines to patients across all healthcare disciplines, care settings, and regions. This includes both completed immunizations and immunization events that were not completed.

Resource Schema​

Key fields in the Immunization resource:

{
  "resourceType": "Immunization",
  "id": "example-immunization-123",
  "status": "completed",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "140",
        "display": "Influenza, seasonal, injectable, preservative free"
      }
    ]
  },
  "patient": {
    "reference": "Patient/123456"
  },
  "occurrenceDateTime": "2023-09-15",
  "primarySource": true,
  "performer": [
    {
      "actor": {
        "reference": "Practitioner/789"
      }
    }
  ],
  "location": {
    "reference": "Location/456"
  },
  "lotNumber": "ABC123",
  "expirationDate": "2024-09-30"
}

Operations​

The Immunization resource supports Read and Search operations. Support varies by CareRecord solution.

CareRecord / SolutionReadSearch
GEHRIMED✅✅
myAvatar✅✅
myEvolv✅✅
myUnity✅✅
TheraOffice✅✅

Read​

Retrieves a specific Immunization resource by ID.

HTTP Method: GET
URL: /Immunization/{id}

Examples​

curl -X GET https://fhir.netsmartcloud.com/uscore/v1/Immunization/123456 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Retrieves Immunization resources matching specified criteria.

HTTP Method: GET or POST
URL: /Immunization or /Immunization/_search

Search Parameters​

Patient-based Search:

ParameterTypeRequiredDescriptionExample
patientreferenceYesREQUIRED The patient for the vaccination recordpatient=value
datedateNoVaccination (non)-Administration Datedate=value
pagestringNoZero-based page indexpage=value
performerreferenceNoThe practitioner or organization who played a role in the vaccinationperformer=value
_revincludespecialNoInclude Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"_revinclude=value

ID-based Search:

ParameterTypeRequiredDescriptionExample
datedateNoVaccination (non)-Administration Datedate=value
pagestringNoZero-based page indexpage=value
performerreferenceNoThe practitioner or organization who played a role in the vaccinationperformer=value
_revincludespecialNoInclude Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"_revinclude=value

Examples​

POST Method (Recommended)​
Search by Patient
curl -X POST https://fhir.netsmartcloud.com/uscore/v1/Immunization/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/123"
GET Method​
Search by Patient
curl -X GET https://fhir.netsmartcloud.com/uscore/v1/Immunization?patient=Patient/123 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Integration Patterns​

Common Workflows​

  1. Immunization History - Retrieve all vaccinations for a patient
  2. Vaccine Verification - Check specific immunization records
  3. Public Health Reporting - Extract immunization data for reporting

Relationships to Other Resources​

The Immunization resource relates to:

  • Patient - Subject of the immunization
  • Practitioner - Who administered the vaccine
  • Encounter - Healthcare encounter when immunization was given
  • Location - Where the immunization was administered
  • Organization - Healthcare organization providing the vaccine

Error Handling​

For common errors and troubleshooting guidance, see Common Errors.

Supported Profiles​

Profiles supported by this resource (as defined in the CapabilityStatement):