--- title: "Retrieve a careplan" url: "https://docs.unified.to/healthcare/careplan/Retrieve_a_careplan" description: "Retrieve a careplan with Unified's Careplan API (GET /healthcare/{connection_id}/careplan/{id}). Filter by fields and raw. Supported by 25 Careplan integrations." date: "2026-10-24T20:36:42.560Z" updated: "2026-10-24T20:36:42.560Z" --- # Retrieve a careplan Updated: October 24, 2026 GET/healthcare/{connection\_id}/careplan/{id} Retrieves a single HealthcareCareplan by its \`id\`. Obtain \`id\` values from the corresponding list endpoint. Use \`fields\` to return only the fields you need. ## Parameters **fields**string array id created\_at updated\_at patient\_id encounter\_id practitioner\_ids condition\_ids goal\_ids name description codes status start\_at end\_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 Careplan ## Returns [HealthcareCareplan](https://docs.unified.to/healthcare/careplan/model.md) | Response field | Type | Required | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | id | string | No | Unique identifier for the care plan | | created\_at | string (date-time) | No | When the care plan record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the care plan record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | patient\_id | string | No | The patient the care plan is for | | encounter\_id | string | No | The encounter in which the care plan was created | | practitioner\_ids | string\[\] | No | The practitioners who authored or contributed to the care plan | | condition\_ids | string\[\] | No | Conditions addressed by the care plan | | goal\_ids | string\[\] | No | Goals the care plan is working towards | | name | string | No | Title of the care plan | | description | string | No | Summary of the care plan | | codes | [HealthcareCode](https://docs.unified.to/healthcare/careplan/Retrieve%5Fa%5Fcareplan.md#HealthcareCode)\[\] | No | Codings for the kind of care plan (e.g. assessment and plan of treatment) | | 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 care plan Values: DRAFT, ACTIVE, ON\_HOLD, REVOKED, COMPLETED, ENTERED\_IN\_ERROR, UNKNOWN, OTHER | | start\_at | string (date-time) | No | When the care plan starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | end\_at | string (date-time) | No | When the care plan ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | notes | string | No | Free-text notes about the care plan | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/careplan/Retrieve%5Fa%5Fcareplan.md#HealthcareMetadata)\[\] | No | Custom field values | | metadata\[\].id | string | No | Identifier of the custom field | | metadata\[\].value | object | No | The custom field value | | metadata\[\].namespace | string | No | The scope or origin of the custom field | | metadata\[\].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT | | metadata\[\].extra\_data | object | No | Additional data about the custom field | | metadata\[\].slug | string | No | The custom field key | ## 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.getHealthcareCareplan({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/careplan/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/careplan/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/careplan/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/careplan/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/careplan/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/careplan/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/careplan/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```