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

Payload

idstring

Unique identifier for the document

created_atdate-time

When the document record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

When the document record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

patient_idstring

The patient the document is about

encounter_idstring

The encounter the document relates to

practitioner_idstring

The practitioner who authored the document

namestring

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

filenamestring

File name of the document

mime_typestring

MIME type of the document content (e.g. text/plain, application/pdf)

document_urlstring

Download link for the document content, expires after 1 hour

document_datastring

Base64-encoded document content for create

authored_atdate-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

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[]	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[]	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).

{
  "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.

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);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.healthcare.createHealthcareDocument({ connectionId, healthcareDocument: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

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

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

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

import requests

url = "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/document?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.post(url, headers=headers)

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

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

curl --request POST \
  --url 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/document?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?