v1

latestSwagger 2.02026-08-061791731.4 MB
Clinical Notes

{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/documents

Adds a document for the specified person and encounter.

This POST route does not use a simple JSON request body - this route requires a multipart/form-data request structure (and a Content-Type header of multipart/form-data that also includes a boundary definition). Comments (which each begin with //DELETE ME) have been inserted into the POST body in this documentation. Removing each of these comment lines will result in a valid request body schema.

When comments are removed and values are entered for each variable request element, this will result in a request body with the structure shown in the example below:

Example Request Header:

"Content-Type": "multipart/form data; boundary=threequarksformustermark"

Example Multipart Request Body:

--thr33quarks4mustermark Content-Disposition: form-data; name="request" Content-Type: application/json { "documentType": "EHRImage", "fileDescription": "Text Description of Document to Appear in UI" }

--thr33quarks4mustermark Content-Disposition: form-data; name="file"; filename="this-will-be-the-filename.PDF" Content-Type: application/pdf

%PDF-1.7 %µµµµ //truncated for brevity; %%EOF

--thr33quarks4mustermark--

post/persons/{personId}/chart/encounters/{encounterId}/documents

Path parameters

personIdstring required

(Required) (Required) The person identifier.

encounterIdstring required

(Required) (Required) The encounter id to associate this document with.

Headers

Content-Type'application/json'
Acceptstring required

Request body

string required

Example request

"<string>"

Response

OK

object required