--- title: "Create a document" url: "https://docs.unified.to/healthcare/document/Create_a_document" description: "Create a document with Unified's Document API (POST /healthcare/{connection_id}/document). Filter by fields and raw. Supported by 8 Document integrations." date: "2026-10-24T20:36:42.560Z" updated: "2026-10-24T20:36:42.560Z" --- # Create a document Updated: October 24, 2026 POST/healthcare/{connection\_id}/document Creates a HealthcareDocument. Provide the unified HealthcareDocument fields in the request body; they are mapped to the provider's API. Returns the created HealthcareDocument. ## Parameters **fields**string array id created\_at updated\_at patient\_id encounter\_id practitioner\_id name type codes status filename mime\_type document\_url document\_data authored\_at 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 ## Payload **id**string Unique identifier for the document **created\_at**date-time When the document record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date-time When the document record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **patient\_id**string The patient the document is about **encounter\_id**string The encounter the document relates to **practitioner\_id**string The practitioner who authored the document **name**string Title or description of the document **type** enum Valid values: "PROGRESS\_NOTE" "CONSULTATION\_NOTE" "HISTORY\_AND\_PHYSICAL" "DISCHARGE\_SUMMARY" "PROCEDURE\_NOTE" "REFERRAL\_NOTE" "SUMMARY" "LABORATORY\_REPORT" "IMAGING\_REPORT" "CONSENT" "OTHER" Unified, normalized kind of clinical document (OTHER when unmappable) **codes** array Codings for the kind of document (e.g. LOINC document type) **status** enum Valid values: "CURRENT" "SUPERSEDED" "ENTERED\_IN\_ERROR" "OTHER" Status of the document **filename**string File name of the document **mime\_type**string MIME type of the document content (e.g. text/plain, application/pdf) **document\_url**string Download link for the document content, expires after 1 hour **document\_data**string Base64-encoded document content for create **authored\_at**date-time When the document was written (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **metadata** array Custom field values **raw** Raw data from integration ## Returns [HealthcareDocument](https://docs.unified.to/healthcare/document/model.md) | Response field | Type | Required | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | Unique identifier for the document | | created\_at | string (date-time) | No | When the document record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the document record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | patient\_id | string | No | The patient the document is about | | encounter\_id | string | No | The encounter the document relates to | | practitioner\_id | string | No | The practitioner who authored the document | | name | string | No | Title or description of the document | | type | enum | No | Unified, normalized kind of clinical document (OTHER when unmappable) Values: PROGRESS\_NOTE, CONSULTATION\_NOTE, HISTORY\_AND\_PHYSICAL, DISCHARGE\_SUMMARY, PROCEDURE\_NOTE, REFERRAL\_NOTE, SUMMARY, LABORATORY\_REPORT, IMAGING\_REPORT, CONSENT, OTHER | | codes | [HealthcareCode](https://docs.unified.to/healthcare/document/Create%5Fa%5Fdocument.md#HealthcareCode)\[\] | No | Codings for the kind of document (e.g. LOINC document type) | | 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 document Values: CURRENT, SUPERSEDED, ENTERED\_IN\_ERROR, OTHER | | filename | string | No | File name of the document | | mime\_type | string | No | MIME type of the document content (e.g. text/plain, application/pdf) | | document\_url | string | No | Download link for the document content, expires after 1 hour | | document\_data | string | No | Base64-encoded document content for create | | authored\_at | string (date-time) | No | When the document was written (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/document/Create%5Fa%5Fdocument.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 results = await sdk.healthcare.createHealthcareDocument({ connectionId, healthcareDocument: { }, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'POST', url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/document', headers: { authorization: 'bearer .....' }, data: undefined, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("POST", "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/document?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/document?fields=&raw= req, _ := http.NewRequest("POST", 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/document?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.post(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/document?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/healthcare/5de520f96e439b002043d8dc/document?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request POST \ --url 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/document?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```