Get Patient Record

GET /v1.0/patients/record

Retrieves a comprehensive patient record.

Requires either (firstName, lastName, and dateOfBirth) OR (phoneNumber).

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

patient_first_name

query

string

Patient’s first name (required if phone_number is not provided).

Conditional

patient_last_name

query

string

Patient’s last name (required if phone_number is not provided).

Conditional

patient_date_of_birth

query

string

Patient’s date of birth (YYYY-MM-DD, required if phone_number is not provided).

Conditional

patient_phone_number

query

string

Patient’s phone number (required if first_name, last_name, and date_of_birth are not all provided).

Conditional

patient_email

query

string

Patient’s email address (required if first_name, last_name, and date_of_birth are not all provided).

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: Patient record found. application/json

  • 404: Patient does not exist in the system. application/json

Record Schema (partial)

  • encounter_notes: array of objects

  • medications: array of objects

  • vital_signs: array of objects

  • lab_results: array of objects

  • insurance: object

  • ehr_raw: array of objects

  • ehr_fhir: array of objects

Last updated