List Patients

List Patients

GET /v1.0/patients

Retrieves a list of patients.

Parameters

Name

In

Type

Description

Required

x-sully-organization-id

header

string

Organization ID for multi-tenant support.

Yes

x-sully-transaction-id

header

string

Transaction ID for tracking purposes.

Yes

practitioner_id

query

string

Practitioner’s ID.

No

practitioner_email

query

string

Email of the practitioner (required if practitionerFirstName and practitionerLastName are not provided).

No

practitioner_first_name

query

string

First name of the practitioner (required if practitionerEmail is not provided).

No

practitioner_last_name

query

string

Last name of the practitioner (required if practitionerEmail is not provided).

No

count

query

integer

Number of items to retrieve. Default is 10.

No

include_raw

query

boolean

Include raw data in the response.

No

include_fhir

query

boolean

Include FHIR format in the response.

No

Responses

  • 200: A list of patients. application/json

  • 501: The requested operation is not implemented. application/json

Last updated