Patient Portal

Get all enqueued portal requests for a patient

Please note: All dates listed are listed in UTC, so you'll want to adjust for your local timezone. Also, the API responses include some routes that may not be available for your instance. For the most part adding to the patient portal is going to be made through message-type specific endpoints (i.e. the /patients/:pt_id/questionnairesendpoint or the/patients/:pt_id/rxs endpoint) and the documentation for those posts are listed alongside other related calls. However, if you're just looking to summarize or manage posts that are already in queue (before they've been dismissed) you can use the calls below:

get/patients/{pt_id}/portal/enqueued

Request

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

Path parameters

pt_idinteger required

ID of patient

Query parameters

request_typestring

return only specific types of requests

request_statusstring

return requests of a specific status (defaults to “pending”). Accepted values are “pending”, “accepted”, “rejected”, “any”

Response

Successful response

Changes

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