Immunization

Overview

The Immunization resource represents vaccination events or immunization records as reported by patients, clinicians, or other parties. This resource is essential for tracking vaccination history and supporting public health initiatives.

Important: Always validate Immunization resource support and available operations by retrieving the current CapabilityStatement from /metadata before implementing integrations.

Resource Schema

The Immunization resource follows the HL7 FHIR R4 Immunization specification.

Key elements include:

identifier - Business identifier for the immunization
status - Completed, entered-in-error, not-done
statusReason - Reason for current status
vaccineCode - Vaccine product administered
patient - Who was immunized
encounter - Encounter immunization was part of
occurrenceDateTime - Vaccine administration date
recorded - When immunization was first captured
primarySource - Indicates if record is from primary source
reportOrigin - Source of secondhand report
location - Where immunization occurred
manufacturer - Vaccine manufacturer
lotNumber - Vaccine lot number
expirationDate - Vaccine expiration date
site - Body site vaccine was administered
route - How vaccine entered body
doseQuantity - Amount of vaccine administered
performer - Who performed event
note - Additional immunization notes
reasonCode - Why immunization occurred
reasonReference - Why immunization occurred
isSubpotent - Dose potency
subpotentReason - Reason for being subpotent
education - Educational material presented
programEligibility - Patient eligibility for vaccination program
fundingSource - Funding source for vaccine
reaction - Details of reaction
protocolApplied - Protocol followed

Example Immunization Resource

{
  "resourceType": "Immunization",
  "id": "12345",
  "identifier": [{
    "system": "http://hospital.example.org/immunizations",
    "value": "IMM-2024-001"
  }],
  "status": "completed",
  "vaccineCode": {
    "coding": [{
      "system": "http://hl7.org/fhir/sid/cvx",
      "code": "207",
      "display": "COVID-19, mRNA, LNP-S, PF, 30 mcg/0.3 mL dose"
    }]
  },
  "patient": {
    "reference": "Patient/12345"
  },
  "occurrenceDateTime": "2024-01-15T10:30:00Z",
  "recorded": "2024-01-15T10:35:00Z",
  "primarySource": true,
  "location": {
    "reference": "Location/clinic-123"
  },
  "manufacturer": {
    "display": "Pfizer-BioNTech"
  },
  "lotNumber": "ABC123",
  "expirationDate": "2024-12-31",
  "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"
    }]
  },
  "doseQuantity": {
    "value": 0.3,
    "unit": "mL",
    "system": "http://unitsofmeasure.org",
    "code": "mL"
  },
  "performer": [{
    "function": {
      "coding": [{
        "system": "http://terminology.hl7.org/CodeSystem/v2-0443",
        "code": "AP",
        "display": "Administering Provider"
      }]
    },
    "actor": {
      "reference": "Practitioner/67890"
    }
  }]
}

Supported Profiles

This API supports the following FHIR profiles:

HL7 FHIR R4 Immunization

Operations

The General Purpose FHIR R4 Immunization resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / Solution	Create	Read	Update	Search
GEHRIMED	-	Yes	-	Yes
myAvatar	Yes	Yes	Yes	Yes
myEvolv	-	Yes	-	Yes
myUnity	-	Yes	-	Yes
Referral Manager	-	-	-	-

Search

info

Not all Netsmart solutions support Immunization search. See supported operations table above and consult your target solution's documentation for more information.

This resource supports a combination of standard and custom search parameters in addition to the common parameters.

Standard Parameters

Name	Type	Description
patient	reference	REQUIRED The patient for the vaccination record
performer	reference	The practitioner or organization who played a role in the vaccination
date	date	Vaccination (non)-Administration Date

Custom Parameters

Name	Type	Description
end	date	Deprecated. Use `date` parameter with `le` prefix instead.
start	date	Deprecated. Use `date` parameter with `ge` prefix instead.

Search Examples

The POST method is recommended as it keeps health information out of the URL.

Production
Preview

Search Immunizations by Patient
curl -X POST https://fhir.netsmartcloud.com/v4/Immunization/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/345" \
    

Search Immunizations by Patient
curl -X POST https://fhirtest.netsmartcloud.com/v4/Immunization/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/345" \
    

Error Handling

For information about error responses when working with Immunization resources, see Common Errors.

Common Immunization-related errors include:

Missing required patient reference
Invalid vaccine codes or CVX codes
Malformed administration dates
Invalid performer or location references

Integration Patterns

Vaccination History

Retrieve patient's complete immunization record:

# Get all immunizations for patient
curl -X GET "https://fhir.netsmartcloud.com/v4/Immunization?patient=12345" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Public Health Reporting

Track immunizations by date range:

# Get recent immunizations
curl -X GET "https://fhir.netsmartcloud.com/v4/Immunization?patient=12345&date=ge2024-01-01" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Provider Performance

Track immunizations by performer:

# Get immunizations by provider
curl -X GET "https://fhir.netsmartcloud.com/v4/Immunization?performer=Practitioner/67890" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Clinical Decision Support

Check immunization status for care decisions:

# Get completed immunizations
curl -X GET "https://fhir.netsmartcloud.com/v4/Immunization?patient=12345&status=completed" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Relationships to Other Resources

The Immunization resource connects to several clinical and administrative resources:

Patient - The individual who received the immunization
Practitioner - Healthcare providers administering vaccines
Location - Where immunizations were administered
Encounter - Clinical encounters during which immunizations occurred
Organization - Healthcare organizations providing immunizations
Observation - Clinical observations related to immunizations

Support

For questions about Immunization resource implementation or vaccination tracking workflows, contact Netsmart support through your designated support channels.

Overview​

Resource Schema​

Example Immunization Resource​

Supported Profiles​

Operations​

Search​

Standard Parameters​

Custom Parameters​

Search Examples​

Error Handling​

Integration Patterns​

Vaccination History​

Public Health Reporting​

Provider Performance​

Clinical Decision Support​

Relationships to Other Resources​

Support​