JOjoincandidhealth
v1

Get Multi

Changed on

Searches for patients that match the query parameters.

get/patients/v1/get_multi

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/patients/v1/get_multi
  • Auth
    HTTP bearer

Query parameters

limitinteger
mrnstring
page_tokenstring

A token that can be used to retrieve the next or previous page of results

sort_fieldstring

The field to order by. Valid values are either keys on the patient object or a special ordering "similar_name:<search_string>" (Ex: similar_name:John). Similar name ordering uses trigrams to fuzzy match patient names to the search criteria.

sort_direction'asc' | 'desc'

Defaults to ascending.

redirect_to_primaryboolean

If true, then only return the primary version of any patients requested

Response

Response with status 200

next_page_tokenstring

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstring

A token that can be used to retrieve the next or previous page of results

totalinteger required

Changes

  • d8b0a61873e2Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 72fc5ca65ba5Revision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /////// to the response with the status