Unsolicited Documents

[POST] Documents

The POST documents method allows for an external vendor to save documents and mark them for review (optional). These documents would be checked for malware and subsequently saved to eDocuments (Patient, Payer, or Resource). If a document DOES NOT contain all necessary pieces of data, the request will either be rejected or will be found within My Tasks - eDocuments > Unsolicited Documents based upon the practice's Unsolicited Document Setup.

As of 8/25/23 this API ONLY ACCEPTS .pdf documents. Support for other document types will be supported in future versions.

Prerequisites & Configurations

Each practice has different requirements and configurations within its database that may be configured in order to further control specific workflows and ensure all appropriate data is either included, required, or defaulted to a practice-specified value. Related configurations:

*Vendor/Practice has received an apiKey from iSalus (see Access to RESTful Webservices)
*iSalus has enabled the "Unsolicited Documents" product flag enabled (iSalus Administrator Required)
Unsolicited Document Setup screen configured by a practice administrator or iSalus project contact

Unsolicited Document Setup: Determines required fields, defaults, and practice-defined values. Coordinate with the practice or project contact to gain further insight into any additional requirements that may have been configured.

Authentication & Headers

See Access to RESTful Webservices
Header = 'X-Api-Key: {apiKey}'
Header = 'X-Choice-Webservice-Account: {WebserviceAccountGUID}'

The X-Choice-Webservice-Account is a temporary requirement. In a near-term release, this will no longer be required in the request.

Endpoint Information

HTTP Method: POST
URL: https://api.isalushealthcare.com/api/documents

Parameter(s)

**Varied based upon the practice's Unsolicited Document Setup.

Name	Data Type	Location	Required	Description
comment	string	query	no	Intended for a short description/additional context
officeMenuId	integer ($int32)	query	varied**	Folder identifier within eDocuments the file should be saved to. A supplemental method is available to retrieve practice-specific values. See [GET] Folders
documentTypeId	integer ($int32)	query	varied**	See [GET] Document Types for more information
identifierType	string	query	no	Patient, Payer, Resource - corresponds to the different eDocument sections. 'Practice' is NOT supported.
identifierId	integer ($int32)	query	no	Patient ID, Resource ID, or Payer ID Supplemental Methods: [GET] Patients [GET] Resources [GET] Payers
externalId	string	query	no	Optional external identifier to assist with auditing and troubleshooting. It is recommended to include a unique identifier from the vendor system
reviewers	string	query	varied**	The reviewers parameter accepts a JSON string that identifies either the user or the user group. Identifiers can be found using the supplemental methods: [GET] Users [GET] User Groups
uploadedDocument	string ($binary)	body	yes	Include the binary data for the document within the request body

Sample Request

curl -X 'POST' \
  'https://api.isalushealthcare.com/api/documents?comment=This%20is%20a%20document&officeMenuId=6&documentTypeId=1&externalId=CBH-3' \
  -H 'accept: */*' \
  -H 'X-Choice-Webservice-Account: {REDACTED}' \
  -H 'X-Api-Key: {REDACTED}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'uploadedDocument=@Testing.pdf;type=application/pdf'

Sample Response Body

{
  "success": true,
  "errorMessage": ""
}