Skip to content
/Patient

Askara API (1.0.0)

Askara.ai open API

Languages
Servers
Production

https://api.askara.ai/

Contact

Resource 'Contact' operations.

Operations

Document

Resource 'Document' operations.

Operations

Organization

Resource 'Organization' operations.

Operations

Patient

Resource 'Patient' operations.

Operations

Retrieve collection of patients.

Request

Use this endpoint to retrieve the collection of patient information.

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 100 ]

The number of items per page

Default 20
order[uuid]string
Enum"asc""desc"
order[firstName]string
Enum"asc""desc"
order[lastName]string
Enum"asc""desc"
order[languageSpoken]string
Enum"asc""desc"
order[createdAt]string
Enum"asc""desc"
order[updatedAt]string
Enum"asc""desc"
order[synchronizedAt]string
Enum"asc""desc"
order[dateOfBirth]string
Enum"asc""desc"
order[gender]string
Enum"asc""desc"
order[user]string
Enum"asc""desc"
order[visibilityOption]string
Enum"asc""desc"
order[email]string
Enum"asc""desc"
order[phone]string
Enum"asc""desc"
order[client]string
Enum"asc""desc"
order[anonymousCode]string
Enum"asc""desc"
searchstring

Global case-insensitive text search.

uuidstring
uuid[]Array of strings
firstNamestring
firstName[]Array of strings
lastNamestring
lastName[]Array of strings
languageSpokenstring
languageSpoken[]Array of strings
dateOfBirthstring
dateOfBirth[]Array of strings
genderstring
gender[]Array of strings
user.emailstring
user.email[]Array of strings
visibilityOptionstring
visibilityOption[]Array of strings
emailstring
email[]Array of strings
phonestring
phone[]Array of strings
anonymousCodestring
anonymousCode[]Array of strings
createdAt[between]string
createdAt[gt]string
createdAt[gte]string
createdAt[lt]string
createdAt[lte]string
updatedAt[between]string
updatedAt[gt]string
updatedAt[gte]string
updatedAt[lt]string
updatedAt[lte]string
synchronizedAt[between]string
synchronizedAt[gt]string
synchronizedAt[gte]string
synchronizedAt[lt]string
synchronizedAt[lte]string
user.uuidstring
user.uuid[]Array of strings
curl -i -X GET \
  'https://api.askara.ai/patients?page=1&itemsPerPage=20&order%5Buuid%5D=asc&order%5BfirstName%5D=asc&order%5BlastName%5D=asc&order%5BlanguageSpoken%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&order%5BsynchronizedAt%5D=asc&order%5BdateOfBirth%5D=asc&order%5Bgender%5D=asc&order%5Buser%5D=asc&order%5BvisibilityOption%5D=asc&order%5Bemail%5D=asc&order%5Bphone%5D=asc&order%5Bclient%5D=asc&order%5BanonymousCode%5D=asc&search=string&uuid=string&uuid%5B%5D=string&firstName=string&firstName%5B%5D=string&lastName=string&lastName%5B%5D=string&languageSpoken=string&languageSpoken%5B%5D=string&dateOfBirth=string&dateOfBirth%5B%5D=string&gender=string&gender%5B%5D=string&user.email=string&user.email%5B%5D=string&visibilityOption=string&visibilityOption%5B%5D=string&email=string&email%5B%5D=string&phone=string&phone%5B%5D=string&anonymousCode=string&anonymousCode%5B%5D=string&createdAt%5Bbetween%5D=string&createdAt%5Bgt%5D=string&createdAt%5Bgte%5D=string&createdAt%5Blt%5D=string&createdAt%5Blte%5D=string&updatedAt%5Bbetween%5D=string&updatedAt%5Bgt%5D=string&updatedAt%5Bgte%5D=string&updatedAt%5Blt%5D=string&updatedAt%5Blte%5D=string&synchronizedAt%5Bbetween%5D=string&synchronizedAt%5Bgt%5D=string&synchronizedAt%5Bgte%5D=string&synchronizedAt%5Blt%5D=string&synchronizedAt%5Blte%5D=string&user.uuid=string&user.uuid%5B%5D=string'

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.

genderstring or null

Patient gender.

Default "unknown"
Enum"female""male""unknown"null
visibilityOptionstring or null
Default "private"
Enum"shared""private"null
emailstring or null(email)

Patient email address.

https://schema.org/email
phonestring or null

Patient phone number.

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

Patient anonymous code.

]
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",
    "visibilityOption": "shared",
    "email": "user@example.com",
    "phone": "+33757590893",
    "anonymousCode": "string"
  }
]

Create a patient.

Request

Use this endpoint to create a patient entity.

Body
required

The new Patient resource

firstNamestring or nullrequired

Patient first name.

lastNamestring or nullrequired

Patient last name.

languageSpokenstring

Patient language.

dateOfBirthstring or null(date-time)

Patient date of birth.

genderstring or null

Patient gender.

Default "unknown"
Enum"female""male""unknown"null
visibilityOptionstring or null
Default "private"
Enum"shared""private"null
externalIdstring or null

Patient external app identifier.

externalCreatedAtstring or null(date-time)

Patient creation date from external app.

emailstring or null(email)

Patient email address.

https://schema.org/email
phonestring or null

Patient phone number.

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

Patient anonymous code.

curl -i -X POST \
  https://api.askara.ai/patients \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "languageSpoken": "string",
    "dateOfBirth": "2019-08-24T14:15:22Z",
    "gender": "female",
    "visibilityOption": "shared",
    "externalId": "string",
    "externalCreatedAt": "2019-08-24T14:15:22Z",
    "email": "user@example.com",
    "phone": "+33757590893",
    "anonymousCode": "string"
  }'

Responses

Patient resource created

Body
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.

genderstring or null

Patient gender.

Default "unknown"
Enum"female""male""unknown"null
userUser-patient.read_user.list (object) or null
Any of:
visibilityOptionstring or null
Default "private"
Enum"shared""private"null
emailstring or null(email)

Patient email address.

https://schema.org/email
phonestring or null

Patient phone number.

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

Patient anonymous code.

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": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "email": "user@example.com",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "lastName": "string",
    "gender": "female",
    "phone": "+33757590893",
    "rpps": "10101748050",
    "am": "394003552"
  },
  "visibilityOption": "shared",
  "email": "user@example.com",
  "phone": "+33757590893",
  "anonymousCode": "string"
}

Retrieve a patient.

Request

Use this endpoint to retrieve a patient information.

Path
uuidstringrequired

Patient identifier

curl -i -X GET \
  'https://api.askara.ai/patients/{uuid}'

Responses

Patient resource

Body
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.

genderstring or null

Patient gender.

Default "unknown"
Enum"female""male""unknown"null
userUser-patient.read_user.list (object) or null
Any of:
visibilityOptionstring or null
Default "private"
Enum"shared""private"null
emailstring or null(email)

Patient email address.

https://schema.org/email
phonestring or null

Patient phone number.

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

Patient anonymous code.

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": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "email": "user@example.com",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "lastName": "string",
    "gender": "female",
    "phone": "+33757590893",
    "rpps": "10101748050",
    "am": "394003552"
  },
  "visibilityOption": "shared",
  "email": "user@example.com",
  "phone": "+33757590893",
  "anonymousCode": "string"
}

User

Resource 'User' operations.

Operations

Webhook

Resource 'Webhook' operations.

Operations