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 / Solution | Create | Read | Update | Search |
|---|---|---|---|---|
| GEHRIMED | - | Yes | - | Yes |
| myAvatar | Yes | Yes | Yes | Yes |
| myEvolv | - | Yes | - | Yes |
| myUnity | - | Yes | - | Yes |
| Referral Manager | - | - | - | - |
Search
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
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" \
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" \