Use this endpoint to update a patient entity.
The updated Patient resource
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.
Critical medical information (allergies, medical risks) meant to be surfaced prominently on the patient record, not buried in notes.
The internal practitioner designated as this patient's referring practitioner ("praticien référent"). Must belong to the same organization as the patient.
The patient's declared "médecin traitant" (GP registered with health insurance), as free text.
Patient record/folder number from the source software (e.g. Logosw).
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.
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.
[ "Marie", "Claire" ]
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.
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.
- Productionhttps://api.askara.ai/patients/{uuid}
curl -i -X PATCH \
'https://api.askara.ai/patients/{uuid}?expand%5B%5D=patient.list_derived' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/merge-patch+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",
"maidenName": "Moreau",
"notes": "string",
"medicalAlert": "Allergie pénicilline — risque hémorragique (AVK)",
"referringPractitioner": "123e4567-e89b-12d3-a456-426614174000",
"treatingPhysician": "Dr Martin Schmidt",
"anonymousCode": "string",
"customPrompt": "string",
"socialSecurityNumber": "269054958815799",
"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"
}'Patient resource updated
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.
Critical medical information (allergies, medical risks) meant to be surfaced prominently on the patient record, not buried in notes.
The internal practitioner designated as this patient's referring practitioner ("praticien référent"). Must belong to the same organization as the patient.
The patient's declared "médecin traitant" (GP registered with health insurance), as free text.
Patient record/folder number from the source software (e.g. Logosw).
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.
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.
[ "Marie", "Claire" ]
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.
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.
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).
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.
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.
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.
When the identity traits were last checked against an identity document. Read-only — set by the validation endpoint.
Which kind of high-trust identity document the traits were checked against. Read-only. The document number is never stored — the CNIL forbids it.
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.
When the online rights check certified the coverage (ISO 8601). Null when rights were never verified online.
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.
[ "postal_address_missing" ]
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.
[ "sex" ]
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.
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.
{ "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": [ { … } ] }