Fetch Patient

GET

1 curl https://app.impiloplatform.com/api/v3/patient/1000000 \
2      -H "Impilo-API-Key: <apiKey>"

Play

200patient

1 {
2   "firstName": "John",
3   "lastName": "Doe",
4   "id": 456,
5   "externalIdentifier": "external-identifier-123",
6   "dateOfBirth": "1987-09-13",
7   "email": "email@example.com",
8   "phoneNumber": "111-222-3333",
9   "archived": true,
10   "address": {
11     "lineOne": "1234 Market Street",
12     "city": "Philadelphia",
13     "state": "PA",
14     "zipCode": "19137",
15     "country": "USA",
16     "lineTwo": "Suite 110",
17     "lineThree": "lineThree",
18     "note": "note"
19   },
20   "site": {
21     "id": 1,
22     "name": "name",
23     "active": true,
24     "phoneNumber": "phoneNumber",
25     "address": {
26       "lineOne": "lineOne",
27       "city": "city",
28       "state": "state",
29       "zipCode": "zipCode",
30       "country": "country",
31       "lineTwo": "lineTwo",
32       "lineThree": "lineThree",
33       "note": "note"
34     }
35   },
36   "enrolled": true,
37   "sex": "unknown"
38 }

Fetches details of a specific patient by their unique ID.

Path parameters

patientIdlongRequired

Response

This endpoint returns an object.

firstNamestring

The patient’s first name.

lastNamestring

The patient’s last name.

idlongOptional

Unique identifier for the patient, managed by Impilo.

externalIdentifierstringOptional

Unique external identifier for the patient, managed by the customer.

dateOfBirthstringOptional

The patient’s date of birth in the format YYYY-MM-DD.

emailstringOptional

The patient’s email.

phoneNumberstringOptional

The patient’s phone number.

archivedbooleanOptional

True if the patient is archived, false otherwise.

addressobjectOptional

The patient’s shipping address. Required on all endpoints except PATCH patient.

siteobjectOptional

The site responsible for this patient.

enrolledbooleanOptional

The enrollment status. False if disenrolled.

sexenumOptional

Allowed values:

Path parameters

Headers

Response