Patient Documents

Add a document via the portal queue

post/patients/{patient_id}/documents

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/patients/{patient_id}/documents
  • Auth: HTTP basic

Path parameters

patient_idinteger required

ID of patient

Query parameters

enqueueboolean

(true by default) If true, the system will insert the document into the active patient portal queue so that the clinic is notified and can review the proposed addition

Request body

pt_idinteger

(required) An integer identifier for the patient associated with the document.

mime_type'image/jpeg' | 'image/jpg' | 'image/gif' | 'image/png' | 'image/pngx' | 'image/bmp' | 'application/pdf' | 'application/x-pdf' | 'application/acrobat' | 'applications/vnd.pdf' | 'text/pdf' | 'text/x-pdf' | 'application/msword' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/rtf' | 'application/vnd.ms-excel' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/vnd.ms-powerpoint' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'application/vnd.ms-works' | 'audio/mpeg' | 'text/plain' | 'text/richtext' | 'text/csv' | 'text/html' | 'application/vnd.oasis.opendocument.text' | 'application/vnd.oasis.opendocument.graphics' | 'application/vnd.oasis.opendocument.presentation' | 'application/vnd.oasis.opendocument.chart'

(required) A string indicating the MIME type of the file.

namestring

(required) A string to be used as the title of the document.

base64_contentstring binary

(required) Binary data, encoded base64. Maximum file size is 16MB.

notesstring

(optional, enqueue=true only) A string to provide highlights or context about the document submission request when document is being enqueued (if accepted from the queue, this will get added to the document content section)

contentstring

(optional, enqueue=false only) A string to provide highlights or context about the document when document is being injected directly into the patient chart (enqueue=false)

folder'Name of existing top-level document folder as configured in the EHR'

(optional) Which tab to file a document under. Argument is ignored if the enqueue parameter is set to true.

subfolderstring

(optional) Name of subfolder to file document under. While this is a freetext valie, it is strongly recommended that standardized subfolders be used in each top-level folder to avoid creating large numbers of distict subfolders.

flagboolean

(optional) Set to true if this is a "key document" that will be accessibe on the first document tab of the patient dashboard

requires_reviewinteger

(optional) If set, the id of the provider who needs to review this document. Must be a non-deleted user ID or -1 if it should be assigned to all provider tasks lists

dr_reviewerinteger

(optional) If set, the id of the provider who signed off/reviewed this document. Set only if the document has been marked as reviewed

dr_review_datestring date-time

(optional) If dr_reviewer is set, the date/time when the provider reviewed the document

review_statusinteger

(optional) If the document still needs review by user specified by requires_review, set to 1

result_code0 | 1 | 2

(optional) If a document is known too represent abnormal findings for the patient, you can flag it as borderline or abnormal, which changes the way the document displays. Values: 0 = Normal, 1 = Borderline, 2 = Abnormal

follow_up_required_datestring date-time

(optional) The datetime that the system should notify clinician to re-review or follow up on document (creates a review task on this date)

pt_notified1 | 2

(optional) Specify whether the patient has already been notified about the contents of this document. Values: 1 = Notification not needed, 2 = Patient has been notified

pt_notified_method'Patient Portal' | 'Phone' | 'Email' | 'Office Visit' | 'Telemed Visit' | 'House Call' | 'Mail'

(optional) If pt_notified is set to '2' (patient has been notified), you can specify how they were notified. You can submit any string <155 characters but we recommend specifying from this list where appropriate

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.