CareTend APIs

Creates a new patient document.

post
https://integrationhub.wellsky.io/commands/v4/documents/patient
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The requested API version

Body Params
date-time

Optional date when the document becomes active.
Specific to patient documents.

string
enum
file

The image file of the document to be uploaded.

int64

The ID of the entity to assign this document to.
Must be used together with AssignmentType.

boolean

Indicates whether the inventory item should be printed with the delivery ticket.
Only applicable when AssignmentType is InventoryItem.

boolean

Indicates whether the inventory item should be printed with the delivery ticket only for the first fill.
Only applicable when AssignmentType is InventoryItem.

string
enum
Allowed:
CompanyId
array of int64s
required
length ≥ 1

Company ID(s) to associate with the document.
The field can be sent multiple times for multiple IDs.
At least one company ID is required.

CompanyId*
string
required

Description of the document. This will be used as the document name
and is also stored in the DocumentTracking.Description field.

string
length between 1 and 255

Optional document category name. If provided, the system will look up the category ID by this name.

string
length ≤ 50

Optional keywords to associate with the document.
Used for searching and categorizing documents.

string

Optional notes to be stored with the document.

date-time

Optional date when the document was received.

Responses

Updated 3 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?