Skip to content

Retrieve a patient.

Request

Use this endpoint to retrieve a patient information.

Security
oauth_auth_code(Required scopes: read:patients)
Path
uuidstringrequired

Patient identifier

Query
expand[]Array of strings
Items Value:"patient.list_derived"
curl -i -X GET \
  'https://api.askara.ai/patients/{uuid}?expand%5B%5D=patient.list_derived' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

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. Must be strictly before today.

genderstring or null

Patient gender.

Default:"unknown"
Enum:"female""male""unknown"null
userUser-patient.read_patient.read_record_user.minimal (object) or null
Any of:

Patient author.

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"
maidenNamestring or null, <= 255 characters

Patient birth name, when it differs from the current legal name. Helps front-desk identity checks and the social-security link (the NIR is tied to the birth name). Not a dedup key: patient matching uses the NIR, or first name + last name + date of birth.

Example:"Moreau"
notesstring or null

Free-text practice notes about the patient record.

medicalAlertstring or null

Critical medical information (allergies, medical risks) meant to be surfaced prominently on the patient record, not buried in notes.

Example:"Allergie pénicilline — risque hémorragique (AVK)"
referringPractitionerUser-patient.read_patient.read_record_user.minimal (object) or null
Any of:

The internal practitioner designated as this patient's referring practitioner ("praticien référent"). Must belong to the same organization as the patient.

treatingPhysicianstring or null, <= 255 characters

The patient's declared "médecin traitant" (GP registered with health insurance), as free text.

Example:"Dr Martin Schmidt"
anonymousCodestring or null, <= 15 characters

Patient anonymous code.

streetAddressstring or null, <= 255 characters

Patient street address.

postalCodestring or null, <= 10 characters

Patient postal code.

citystring or null, <= 255 characters

Patient city.

recordNumberstring or null, <= 255 characters

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

heightinteger or null, [ 20 .. 280 ]

Patient height in centimeters.

weightnumber or null, [ 0.5 .. 500 ]

Patient weight in kilograms.

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
birthGivenNamesArray of strings or null

Civil-status given names in order, the first being the birth first name. Distinct from firstName, which stays the name the patient goes by. Populated from the Vitale card when available.

Example:
[ "Marie", "Claire" ]
birthPlaceCodestring or null, <= 5 characters

INSEE (COG) code of the birthplace, an INS identity trait. Five characters — Corsican codes are 2A/2B and a birth abroad carries a 99xxx country code.

Example:"75056"
insMatriculestring or null, <= 15 characters

National health identity (INS) matricule. Distinct from socialSecurityNumber: the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves.

Example:"269054958815799"
insOidstring or null, <= 32 characters

OID qualifying the INS matricule: 1.2.250.1.213.1.4.8 for a NIR, 1.2.250.1.213.1.4.9 for a NIA (temporary identifier).

Example:"1.2.250.1.213.1.4.8"
insStatusstring or null

INS qualification status: provisional | validated | retrieved | qualified. Only a qualified identity may be carried into an interoperable exchange (DMP, MSSanté, FSE). Read-only: the server derives it from the matricule's provenance — a manually entered matricule reads back as provisional.

Enum:"provisional""validated""retrieved""qualified"null
insSourcestring or null

Where the INS came from: manual | vitale | insi | import. Confidence levels — only the INSi teleservice can qualify an identity. Read-only: a matricule written through this API is manual by construction.

Enum:"manual""vitale""insi""import"null
insQualifiedAtstring or null, (date-time)

When the identity first became qualified, i.e. when both RNIV determinants were met. Read-only: only the document check and the INSi teleservice can produce a qualification.

insValidatedAtstring or null, (date-time)

When the identity traits were last checked against an identity document. Read-only — set by the validation endpoint.

insValidationDocumentTypestring or null

Which kind of high-trust identity document the traits were checked against. Read-only. The document number is never stored — the CNIL forbids it.

Enum:"national_id_card""passport""residence_permit""family_record_book""birth_certificate_extract""electronic_eidas_substantial""electronic_eidas_high"null
rightsVerifiedboolean or null

Whether the applicable coverage was certified by an online rights check (Vitale, ADRi or ApCV). Read-only, derived from the patient coverages — write rights through the coverage endpoints.

rightsVerifiedAtstring or null

When the online rights check certified the coverage (ISO 8601). Null when rights were never verified online.

todoArray of strings or null

What this record still needs, as stable codes: postal_address_missing, rights_to_verify. Wording is the client's. Contributions from other bricks (missing consents, unsigned quotes) are aggregated by the "À traiter" endpoints.

Example:
[ "postal_address_missing" ]
insiMissingTraitsArray of strings or null

RNIV strict traits missing from this record, as stable codes: birth_name, birth_given_name, birth_date, sex. Empty when the record is complete. A non-empty list means the INSi endpoints will refuse this record: fill these before calling them.

Example:
[ "sex" ]
insMatriculeTypestring or nullread-only

What the INS matricule is, read from its OID: nir for a definitive identifier, nia for a provisional one still awaiting a NIR. Null when the record carries no INS, or an OID outside the two documented namespaces.

Enum:"nir""nia"null
Example:"nir"
phonesArray of objectsread-only

All phone numbers, primary first. The primary one is also served as the legacy phone field. smsCapable is true only for a number labelled mobile — reminders never target the others.

emailsArray of objectsread-only

All email addresses, primary first. The primary one is also served as the legacy email field.

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", "firstName": "string", "lastName": "string", "isConventionne": true }, "visibilityOption": "shared", "email": "user@example.com", "phone": "+33757590893", "maidenName": "Moreau", "notes": "string", "medicalAlert": "Allergie pénicilline — risque hémorragique (AVK)", "referringPractitioner": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "firstName": "string", "lastName": "string", "isConventionne": true }, "treatingPhysician": "Dr Martin Schmidt", "anonymousCode": "string", "streetAddress": "string", "postalCode": "string", "city": "string", "recordNumber": "string", "height": 20, "weight": 0.5, "civility": "mr", "birthGivenNames": [ "Marie", "Claire" ], "birthPlaceCode": "75056", "insMatricule": "269054958815799", "insOid": "1.2.250.1.213.1.4.8", "insStatus": "provisional", "insSource": "manual", "insQualifiedAt": "2019-08-24T14:15:22Z", "insValidatedAt": "2019-08-24T14:15:22Z", "insValidationDocumentType": "national_id_card", "rightsVerified": true, "rightsVerifiedAt": "string", "todo": [ "postal_address_missing" ], "insiMissingTraits": [ "sex" ], "insMatriculeType": "nir", "phones": [ { … } ], "emails": [ { … } ] }