--- title: "Retrieve an observation" url: "https://docs.unified.to/healthcare/observation/Retrieve_an_observation" description: "Retrieve an observation with Unified's Observation API (GET /healthcare/{connection_id}/observation/{id}). Filter by fields and raw. Supported by 13 Observation integrations." --- # Retrieve an observation GET/healthcare/{connection\_id}/observation/{id} ## Parameters **fields**string array id created\_at updated\_at patient\_id encounter\_id practitioner\_id name codes status type value\_number value\_unit value\_text interpretation reference\_range components observed\_at issued\_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 Observation ## Returns [HealthcareObservation](https://docs.unified.to/healthcare/observation/model.md) | Response field | Type | Required | Description | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | id | string | No | Unique identifier for the observation | | created\_at | string (date-time) | No | When the observation record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the observation record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | patient\_id | string | No | The patient the observation is about | | encounter\_id | string | No | The encounter in which the observation was made | | practitioner\_id | string | No | The practitioner who performed the observation | | name | string | No | Human-readable name of what was observed | | codes | [HealthcareCode](https://docs.unified.to/healthcare/observation/Retrieve%5Fan%5Fobservation.md#HealthcareCode)\[\] | No | Codings for what was observed (e.g. LOINC) | | 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 observation result Values: REGISTERED, PRELIMINARY, FINAL, AMENDED, CORRECTED, CANCELLED, ENTERED\_IN\_ERROR, UNKNOWN, OTHER | | type | enum | No | Category of the observation Values: LABORATORY, VITAL\_SIGNS, SOCIAL\_HISTORY, IMAGING, SURVEY, EXAM, PROCEDURE, THERAPY, ACTIVITY, OTHER | | value\_number | number | No | Numeric result value | | value\_unit | string | No | Unit of the numeric result (e.g. mg/dL) | | value\_text | string | No | Text or coded result value | | interpretation | enum | No | Interpretation of the result (e.g. high, low) Values: NORMAL, ABNORMAL, LOW, HIGH, CRITICAL\_LOW, CRITICAL\_HIGH, OTHER | | reference\_range | object | No | Normal range for the result | | reference\_range.low\_value | number | No | Lower bound of the range | | reference\_range.high\_value | number | No | Upper bound of the range | | reference\_range.unit | string | No | Unit of the range bounds | | reference\_range.text | string | No | Text description of the range | | components | [HealthcareObservationComponent](https://docs.unified.to/healthcare/observation/Retrieve%5Fan%5Fobservation.md#HealthcareObservationComponent)\[\] | No | Component results (e.g. systolic and diastolic blood pressure) | | components\[\].name | string | No | Human-readable name of the component | | components\[\].codes | [HealthcareCode](https://docs.unified.to/healthcare/observation/Retrieve%5Fan%5Fobservation.md#HealthcareCode)\[\] | No | Codings for the component (e.g. LOINC) | | components\[\].codes\[\].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) | | components\[\].codes\[\].code | string | No | The code within the system | | components\[\].codes\[\].display | string | No | Human-readable display text for the code | | components\[\].value\_number | number | No | Numeric component value | | components\[\].value\_unit | string | No | Unit of the numeric component value | | components\[\].value\_text | string | No | Text or coded component value | | components\[\].interpretation | enum | No | Interpretation of the component value Values: NORMAL, ABNORMAL, LOW, HIGH, CRITICAL\_LOW, CRITICAL\_HIGH, OTHER | | observed\_at | string (date-time) | No | When the observation was made (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | issued\_at | string (date-time) | No | When the result was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | notes | string | No | Free-text notes about the observation | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/observation/Retrieve%5Fan%5Fobservation.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.getHealthcareObservation({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/observation/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/observation/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/observation/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/observation/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/observation/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/observation/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/observation/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```