General Information
The connectivity of this FHIR endpoint is as follows:
- HTTP Method
- GET, POST
- URL Template
- https://portal.viewmymed.com/fhir/Immunization?_id=token&
patient=reference& _count=number& date=date& status=token& _pretty=boolean& _revinclude=static - Supported OAuth 2.0 User Types
- Backend Systems, Clinicians or Administrative Users, Patients
- Operations Supported
- read search-type vread history-instance
- Scopes Supported
-
- patient/Immunization
- user/Immunization
- system/Immunization
- system/*.read
- system/*.rs
- Profiles Supported
-
- Us Core Immunization
Request Parameters
The following fields and datatypes are the parameters for the request string. All fields are optional, however if no settings are set, all values will be exported up to the maximum count of 100
| Name (type) | Description (bindings) |
|---|---|
| _id (token) |
A single or comma separated list of Immunization ids. It is a required field if the patient field is not given. |
| patient (reference) |
Who the immunization is for. It is a required field if the _id field is not given. |
| _count (number) |
The maximum number of results to return in a page. Not honored when '_id' is set. |
| date (date) |
A date or date range from which to find immunization. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for immunization at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for immunization within a specific range. The date prefix pair must create a closed range. |
| status (token) |
The overall status of the immunization. |
| _pretty (boolean) |
set to false to disable formatted output. |
| _revinclude (static) |
_revinclude parameter may be provided once with the value Provenance:target to pull the relevant Provenance information. Example: _revinclude=Provenance:target |
Returned Data Fields
The following fields and bindings are returned if valued
| Field (type) | Description (bindings) | Opt? |
|---|---|---|
| id (Id) |
Id |
|
| patient (Reference) |
Reference to a patient resource for whom the report is relevant |
|
| encounter (Reference) |
Reference to a patient resource for whom the report is relevant |
|
| status (String) |
Indicates the current status of the immunization event. |
|
| manufacturer (String) |
Name of vaccine manufacturer. |
|
| expirationDate (DateTime) |
Date vaccine batch expires. |
|
| lotNumber (String) |
Lot number of the vaccine product. |
|
| occurrence_x_ (DateTime) |
Date vaccine administered or was to be administered. |
|
| vaccineCode (CodeableConcept) |
Vaccine that was administered or was to be administered. |
|
| statusReason (Reference) |
Indicates the reason the immunization event was not performed. |
Default Patient Query
The following are live queries representative of a data request on our sandbox environment.
Headers
Accept: application/fhir+json Authorization: <OAuth2 Bearer Token>
Request
GET https://portal.viewmymed.com/fhir/Immunization?patient=99999.122753-00&_count=1
HTTP/1.0 200 OK
Cache-Control: no-cache, private
Content-Type: application/fhir+json
Date: Mon, 02 Feb 2026 13:36:08 GMT
Etag: W/"1"
{
"resourceType": "Bundle",
"id": "6980a848497d06980a848497d2",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://portal.viewmymed.com/api/Immunization"
}
],
"entry": [
{
"fullUrl": "https://portal.viewmymed.com/fhir/Immunization/3ff07885a16040439dc6d09218774fe4",
"resource": {
"resourceType": "Immunization",
"id": "3ff07885a16040439dc6d09218774fe4",
"meta": {
"versionId": "3ff07885a16040439dc6d09218774fe4",
"lastUpdated": "2023-01-26T06:33:04+00:00"
},
"text": {
"status": "generated",
"div": "Description: PPD
\nDate: 01/20/23
\nCVX: NONE
\nStatus: given
\nLot #:
\nManufacturer: NONE
\nNote: Immunization Given
\n"
},
"patient": {
"reference": "Patient/99997.122753-00"
},
"encounter": {
"reference": "Encounter/fb9f088c689044da7a617c6ae144be05"
},
"manufacturer": {
"display": "NONE"
},
"status": "completed",
"expirationDate": "2023-01-26",
"lotNumber": "Unknown",
"occurrenceDateTime": "2023-01-20T00:00:00+00:00",
"vaccineCode": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown"
}
]
},
"primarySource": true
}
}
]
}
Error Codes / Outcomes
All endpoints share the same error codes and common outcomes.