Encounters

Get All Encounters for a Patient

Please note: All dates listed (creation times, sign dates, date of service, update-times) are listed in UTC, so you'll want to adjust for your local timezone. The returned JSON will include prescribed medications, supplements, recommendations (and other alternate plan items), diagnoses. One thing to note: the API is designed to return attachments (documents and images that are included in the encounter) with the response, but currently this functionality is disabled and an empty array will always be returned.

get/patients/{patient_id}/encounters

Request

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

Path parameters

patient_idinteger required

The ID of the patient.

Query parameters

limitinteger

The maximum number of encounters to return (default is 100).

offsetinteger

Offset the list to allow cycling through encounter notes.

typestring

Limit results to a specific encounter note type (e.g., "ov" for office visit).

signed_onlyboolean

If included and set to "false," return all encounter notes, including those not marked as signed.

Response

Successful response

Changes

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