v1

latestOpenAPI 3.0.0Apache 2.02026-07-246175132.0 KB

Patients

Get Patient

get/api/v2/patients/{id}

Path parameters

idstring required

Patient ID or Particle Patient ID

Response

address_citystring required

The patient's home city.

address_linesstring[]

The patient's home street address. This should not include the patient's city, state, or zip code.

address_statestring required

The patient's home state.

date_of_birthstring required

The patient's date of birth, this field is required and must be of the format YYYY-MM-DD.

emailstring

The patient's email, must be a valid email address.

family_namestring required

The patient's family name (last name), this field is required.

genderstring required

The patient's gender, must be either FEMALE or MALE.

given_namestring required

The patient's given name (first name), this field is required.

particle_patient_idstring

The Particle Assigned Patient ID. Output only.

patient_idstring required

The unique patient id in an external system.

postal_codestring required

The patient's home postal (zip) code.

ssnstring

The patient's social security number, must be a valid US social security number.

telephonestring

The patient's telephone number.

Example response

{
  "address_city": "Brooklyn",
  "address_lines": [
    "999 Dev Drive"
  ],
  "address_state": "New York",
  "consent": [
    {
      "consent_date": "2021-01-01",
      "partner": "Healthix",
      "permission": "permit"
    }
  ],
  "date_of_birth": "1954-12-01",
  "email": "john@doe.com",
  "family_name": "Quark",
  "gender": "MALE",
  "given_name": "Kam",
  "particle_patient_id": "1aa50979-1a8e-416d-8c13-a529033cc898",
  "patient_id": "pati-enti-d123-4567",
  "postal_code": "11111",
  "ssn": "123-45-6789",
  "telephone": "234-567-8910"
}