Skip to main content

R4 Immunization

The Immunization resource describes the "event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party." (HL7 FHIR R4 Immunization)

Supported Profiles

This API supports the following FHIR profiles:

Operations

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

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED-Yes-Yes
myAvatarYesYesYesYes
myEvolv-Yes-Yes
myUnity-Yes-Yes
Referral Manager----
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

NameTypeDescription
patientreferenceREQUIRED The patient for the vaccination record
performerreferenceThe practitioner or organization who played a role in the vaccination
datedateVaccination (non)-Administration Date

Custom Parameters

NameTypeDescription
enddateDeprecated. Use date parameter with le prefix instead.
startdateDeprecated. Use date parameter with ge prefix instead.

Search Examples

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

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" \