--- title: "Retrieve an immunization" url: "https://docs.unified.to/healthcare/immunization/Retrieve_an_immunization" description: "Retrieve an immunization with Unified's Immunization API (GET /healthcare/{connection_id}/immunization/{id}). Filter by fields and raw. Supported by 14 Immunization integrations." --- # Retrieve an immunization GET/healthcare/{connection\_id}/immunization/{id} ## Parameters **fields**string array id created\_at updated\_at patient\_id encounter\_id practitioner\_id location\_id name codes status administered\_at lot\_number expires\_at notes metadata raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection **id**string required ID of the Immunization ## Returns [HealthcareImmunization](https://docs.unified.to/healthcare/immunization/model.md) | Response field | Type | Required | Description | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------- | | id | string | No | Unique identifier for the immunization | | created\_at | string (date-time) | No | When the immunization record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the immunization record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | patient\_id | string | No | The patient who was immunized | | encounter\_id | string | No | The encounter in which the vaccine was administered | | practitioner\_id | string | No | The practitioner who administered the vaccine | | location\_id | string | No | Where the vaccine was administered | | name | string | No | Human-readable name of the vaccine | | codes | [HealthcareCode](https://docs.unified.to/healthcare/immunization/Retrieve%5Fan%5Fimmunization.md#HealthcareCode)\[\] | No | Codings for the vaccine (e.g. CVX) | | codes\[\].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) | | codes\[\].code | string | No | The code within the system | | codes\[\].display | string | No | Human-readable display text for the code | | status | enum | No | Status of the immunization Values: COMPLETED, NOT\_DONE, ENTERED\_IN\_ERROR, OTHER | | administered\_at | string (date-time) | No | When the vaccine was administered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | lot\_number | string | No | Vaccine lot number | | expires\_at | string (date-time) | No | Vaccine expiration date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | notes | string | No | Free-text notes about the immunization | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/immunization/Retrieve%5Fan%5Fimmunization.md#HealthcareMetadata)\[\] | No | | | metadata\[\].id | string | No | | | metadata\[\].value | object | No | | | metadata\[\].namespace | string | No | | | metadata\[\].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT | | metadata\[\].extra\_data | object | No | | | metadata\[\].slug | string | No | | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.healthcare.getHealthcareImmunization({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/immunization/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("GET", "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/immunization/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/healthcare/5de520f96e439b002043d8dc/immunization/5de520f96e439b002043d8d8?fields=&raw= req, _ := http.NewRequest("GET", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/immunization/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.get(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/immunization/5de520f96e439b002043d8d8?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/healthcare/5de520f96e439b002043d8dc/immunization/5de520f96e439b002043d8d8?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request GET \ --url 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/immunization/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```