Skip to content
/Patient

Patient

Resource 'Patient' operations.

Operations

Retrieve collection of patients.

Request

Use this endpoint to retrieve the collection of patient information.

Security
oauth_auth_code(Required scopes: read:patients)
Query
pageinteger

The collection page number

Default:1
itemsPerPageinteger, [ 0 .. 100 ]

The number of items per page

Default:20
searchstring

Patient search

expand[]Array of strings
Items Value:"patient.list_derived"
uuidstring

Patient uuid

firstNamestring

Patient firstName

lastNamestring

Patient lastName

languageSpokenstring

Patient languageSpoken

dateOfBirthstring

Patient dateOfBirth

genderstring

Patient gender

user.emailstring

Patient user.email

visibilityOptionstring

Patient visibilityOption

emailstring

Patient email

phonestring

Patient phone

anonymousCodestring

Patient anonymousCode

createdAtstring

Patient createdAt

updatedAtstring

Patient updatedAt

synchronizedAtstring

Patient synchronizedAt

user.uuidstring

Patient user.uuid

lastConsultationAt[between]string, (date-time)

Last consultation within the range, bounds included ("min..max"). The consultation date is the most recent recording made BY THE CALLER for that patient, the same value the lastConsultationAt property exposes. Patients the caller has no recording for are excluded as soon as this filter is used, whichever operator is passed.

lastConsultationAt[gt]string, (date-time)

Last consultation strictly after the given date. The consultation date is the most recent recording made BY THE CALLER for that patient, the same value the lastConsultationAt property exposes. Patients the caller has no recording for are excluded as soon as this filter is used, whichever operator is passed.

lastConsultationAt[gte]string, (date-time)

Last consultation on or after the given date. The consultation date is the most recent recording made BY THE CALLER for that patient, the same value the lastConsultationAt property exposes. Patients the caller has no recording for are excluded as soon as this filter is used, whichever operator is passed.

lastConsultationAt[lt]string, (date-time)

Last consultation strictly before the given date. The consultation date is the most recent recording made BY THE CALLER for that patient, the same value the lastConsultationAt property exposes. Patients the caller has no recording for are excluded as soon as this filter is used, whichever operator is passed.

lastConsultationAt[lte]string, (date-time)

Last consultation on or before the given date. The consultation date is the most recent recording made BY THE CALLER for that patient, the same value the lastConsultationAt property exposes. Patients the caller has no recording for are excluded as soon as this filter is used, whichever operator is passed.

curl -i -X GET \
  'https://api.askara.ai/patients?page=1&itemsPerPage=20&search=string&expand%5B%5D=patient.list_derived&uuid=string&firstName=string&lastName=string&languageSpoken=string&dateOfBirth=string&gender=string&user.email=string&visibilityOption=string&email=string&phone=string&anonymousCode=string&createdAt=string&updatedAt=string&synchronizedAt=string&user.uuid=string&lastConsultationAt%5Bbetween%5D=2019-08-24T14%3A15%3A22Z&lastConsultationAt%5Bgt%5D=2019-08-24T14%3A15%3A22Z&lastConsultationAt%5Bgte%5D=2019-08-24T14%3A15%3A22Z&lastConsultationAt%5Blt%5D=2019-08-24T14%3A15%3A22Z&lastConsultationAt%5Blte%5D=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Patient collection

Body
Array [
uuidstring, (uuid)

Patient unique identifier.

firstNamestring or nullrequired

Patient first name.

lastNamestring or nullrequired

Patient last name.

languageSpokenstring

Patient language.

createdAtstring, (date-time)

Patient creation date.

updatedAtstring, (date-time)

Patient update date.

synchronizedAtstring or null, (date-time)

Patient synchronization date.

dateOfBirthstring or null, (date-time)

Patient date of birth. Must be strictly before today.

genderstring or null

Patient gender.

Default:"unknown"
Enum:"female""male""unknown"null
userstring or null, (uuid)

Patient author.

Example:"123e4567-e89b-12d3-a456-426614174000"
visibilityOptionstring or null
Default:"shared"
Enum:"shared""private"null
emailstring or null, (email)

Patient email address.

Find more info here
phonestring or null

Patient phone number.

Example:"+33757590893"
anonymousCodestring or null, <= 15 characters

Patient anonymous code.

recordNumberstring or null, <= 255 characters

Patient record/folder number from the source software (e.g. Logosw).

civilitystring or null

How the patient is addressed: mr | mrs | dr | pr | none. Null means nobody has declared it — clients fall back to the gender-derived form. Distinct from gender: a patient who is a doctor is addressed "Dr" whatever their gender.

Enum:"mr""mrs""dr""pr""none"null
]
Response
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "firstName": "string",
    "lastName": "string",
    "languageSpoken": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "synchronizedAt": "2019-08-24T14:15:22Z",
    "dateOfBirth": "2019-08-24T14:15:22Z",
    "gender": "female",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "visibilityOption": "shared",
    "email": "user@example.com",
    "phone": "+33757590893",
    "anonymousCode": "string",
    "recordNumber": "string",
    "civility": "mr"
  }
]