Immunization

The Immunization resource provides "to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines in all care settings and all regions." (HL7 FHIR R4 Immunization)

Supported Profiles

This API supports the following FHIR profiles:

• HL7 FHIR R4 Immunization
• US Core Immunization

Operations

The Certified API 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
myEvolv	-	Yes	-	Yes
myUnity	-	Yes	-	Yes
TheraOffice	-	Yes	-	Yes

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 operation retrieves a list of resources by these query parameters.

Standard Parameters

Name	Type	Description
patient	reference	REQUIRED The patient for the vaccination record
date	date	Vaccination (non)-Administration Date
page	string	Zero-based page index
performer	reference	The practitioner or organization who played a role in the vaccination
_revinclude	special	Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"

Search Example

Via POST

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

Production

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"

Preview

Search by Patient

curl -X POST https://fhirtest.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"

Via GET

Production

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"

Preview

Search by Patient

curl -X GET https://fhirtest.netsmartcloud.com/uscore/v1/Immunization?patient=Patient/123 \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"