Patients

Find all patients matching criteria

get/patients/search

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/patients/search
  • Auth: HTTP basic

Query parameters

limitinteger

defaults to 100, but can be overridden (max is 100)

offsetinteger

If the returned data indicates that there is more than the limit responses (has_more: true), then it will offset the list to allow you to cycle through long patient list

last_namestring

Match patients with given last name. Allows wildcard: smith% will match “Smith”,”Smithson”,”Simthe” etc)

first_namestring

Match patients with given first name Allows wildcard: ben% will match “Ben”,”Benjamin”,”Bennett” etc)

emailstring

Match patients with given email as their primary or secondary address Allows wildcard: %@gmail.com will match all patients with Gmail addresses

usernamestring

Match patients with given patient portal username

dobstring

Match patients with given date of birth (preferred format is yyyy-mmdd). No wildcards allowed

timezonestring

Match patients with given timezone (Must be a canonical timezone https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

Response

Successful response

Changes

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