All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- API version updated.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- API version bumped to 1.96.0.
- API version updated to 1.95.0.
- API version bumped to 1.94.0 with no public contract changes.
- API version bump only — no public contract changes.
- API version updated.
- API version bumped to 1.91.0.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- API version bumped to 1.88.0.
- API version updated.
- API version bump only — no public contract changes.
- API version updated to 1.85.0.
- API version bump only — no public contract changes.
anesthesiologistenum value added to theclaimedByClientfield in document integrations.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- The OAuth 2.0 security scheme is renamed from
oauthAuthCodetooauth_auth_code. - The authorization URL is now
https://app.askara.ai/authorize(previouslyhttps://app.askara.ai/oauth/authorize). - The API-wide security requirement referenced a
JWTscheme that was never defined. It now points to the definedoauth_auth_codescheme. Authentication itself is unchanged.
- API version updated.
- API version updated.
- Added optional
audio.uuidquery parameter.
- Optional field
user - Optional query parameter
uuid - Optional query parameters
archivedAt,createdAt,updatedAt - Optional query parameter
audioWorkflowStepV3 - Optional query parameter
documents - Optional query parameter
exists[archivedAt] - Optional query parameter
expand[] - Optional query parameter
languageSpoken - Optional query parameter
patient - Optional query parameter
search - Optional query parameter
user - Optional query parameters
city,country,email,firstName,gender,lastName,legalName,phone,postalCode,specialty,streetAddress - Optional query parameters
user.email,user.uuid - Optional query parameter
visibilityOption - Optional query parameter
encounteredAt - Optional query parameters
patient.id,patient.email,patient.uuid - Optional query parameter
genericContactSpecialty - Optional query parameter
isAnonymized - Optional query parameter
patientEmailStatus - Optional query parameter
pdf - Optional query parameter
synchronized - Optional query parameter
type - Optional query parameters
am,language,rpps,studentStatus,groups - Optional query parameter
audio - Optional query parameter
exists[meeting] - Optional query parameters
order[createdAt],order[type],order[updatedAt],order[uuid] - Optional query parameters
latitude,longitude - Optional query parameters
dentalNomenclatureSystem,finess,images,name - Optional query parameters
organizationUsers,preferredCurrency,secretariatEmail,siret,subscriptions,timezone,vatNumber,webhooks,website - Optional query parameter
synchronizedAt - Optional query parameters
anonymousCode,dateOfBirth - Optional query parameters
lastConsultationAt[between],lastConsultationAt[gt],lastConsultationAt[gte],lastConsultationAt[lt],lastConsultationAt[lte] - Optional query parameters
certificateVerificationDisabled,enabled - Optional query parameter
organization - Optional query parameter
url
- (breaking) Required query parameter
uuidadded - (breaking) Removed enum value
ascfrom query parameterorder[createdAt] - (breaking) Removed enum value
ascfrom query parameterorder[type] - (breaking) Removed enum value
ascfrom query parameterorder[updatedAt] - (breaking) Removed enum value
ascfrom query parameterorder[uuid] - (breaking) Removed enum value
descfrom query parameterorder[createdAt] - (breaking) Removed enum value
descfrom query parameterorder[type] - (breaking) Removed enum value
descfrom query parameterorder[updatedAt] - (breaking) Removed enum value
descfrom query parameterorder[uuid] - Query parameter
exists[archivedAt]type widened frombooleantostring - Query parameter
isAnonymizedtype widened frombooleantostring - Query parameter
exists[meeting]type widened frombooleantostring - Query parameter
certificateVerificationDisabledtype widened frombooleantostring - Query parameter
enabledtype widened frombooleantostring - visibilityOption default value changed from
privatetosharedin request and response bodies
- Query parameters
archivedAt[between],archivedAt[gt],archivedAt[gte],archivedAt[lt],archivedAt[lte] - Query parameters
createdAt[between],createdAt[gt],createdAt[gte],createdAt[lt],createdAt[lte] - Query parameters
documents[],exists[meeting], `language
- API version updated to 1.75.0.
- API version updated to 1.74.0 with no breaking changes to the public contract.
- API version updated to 1.73.0.
- API version bump only — no public contract changes.
- Added a
200success response to an endpoint.
- Optional fields
avatar,height,insiMissingTraits,isConventionne,referringPractitioner,treatingPhysician, andweightin request and response schemas - New schema components
Image-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list,Image.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list, andImage.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list
- Breaking change detected: version incremented from
1.69.0to1.70.0without a major version bump - Removed schemas
Image-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list,Image.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list,Image.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list,Organization-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list,Organization.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list,Organization.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list,User-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list,User.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list, andUser.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
Auto-generated from the OpenAPI diff (oasdiff). Review wording before release.
- Optional field
isOrganizationAdmin - Optional field
undefined
- (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/clientTypesbecame nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/clientTypes/items/became nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/countriesbecame nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/specialtiesbecame nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/specialties/items/became nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/systemsbecame nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/systems/items/became nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/clientTypesbecame nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/clientTypes/items/became nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/countriesbecame nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/specialtiesbecame nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/specialties/items/became nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/systemsbecame nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/claimedByClient/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/systems/items/became nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/clientTypesbecame nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/clientTypes/items/became nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/countriesbecame nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/specialtiesbecame nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/specialties/items/became nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/systemsbecame nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/systems/items/became nullable for the status200(media type: application/json) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/clientTypesbecame nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/clientTypes/items/became nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/countriesbecame nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/specialtiesbecame nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/specialties/items/became nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/systemsbecame nullable for the status200(media type: multipart/form-data) - (breaking) the response property
documents/items/documentIntegrations/items/client/anyOf[#/components/schemas/Client.multipart-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/systems/items/became nullable for the status200(media type: multipart/form-data) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/claimedByClient/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/clientTypesbecame nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/claimedByClient/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/clientTypes/items/became nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/claimedByClient/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/countriesbecame nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/claimedByClient/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/specialtiesbecame nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/claimedByClient/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/specialties/items/became nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/claimedByClient/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/systemsbecame nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/claimedByClient/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/systems/items/became nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/client/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/clientTypesbecame nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/client/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/clientTypes/items/became nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/client/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/countriesbecame nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/client/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/specialtiesbecame nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/client/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/specialties/items/became nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/client/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/systemsbecame nullable for the status200(media type: application/ld+json) - the response property
allOf[subschema #2]/documents/items/allOf[subschema #2]/documentIntegrations/items/allOf[subschema #2]/client/anyOf[#/components/schemas/Client.jsonld-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list]/allOf[subschema #2]/systems/items/became nullable for the status200(media type: application/ld+json) - a breaking change was detected but the major version did not increase, from
1.63.0to1.64.0
- Field
socialSecurityNumber
- API version bump only — no public contract changes.
- New
client_error_unclaimedenum value added to theerrorCodefield in Document Integrations responses.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- Optional field
officePhotosin response bodies.
- API version bump only — no public contract changes.
- API version bump only — no public contract changes.
- Optional
primaryColorfield added to multiple response schemas.
GET /public/directory/facetsGET /public/directory/nearby-practitionersGET /public/directory/nearbyGET /public/directory/searchGET /public/directory/suggestionsPOST /public/directory/claimsPOST /public/directory/sheet/readPOST /public/directory/sheet/update
- API version updated to 1.55.0.
- API version bumped to 1.54.0.
- New endpoint
GET /public/directory/nearby-practitioners - Optional field
bookingEnabledCountin response
- Added optional
bookingEnabledquery parameter toGET /public/directory/nearby-practitioners
Patients:
GET /patientsaccepts five new optional query parameters to filter on the date of the last consultation:lastConsultationAt[gt],lastConsultationAt[gte],lastConsultationAt[lt],lastConsultationAt[lte], andlastConsultationAt[between](an inclusive"<min>..<max>"range). All take an RFC 3339 date-time, and they combine with the existing filters and sorts.The consultation date is the most recent recording made by the caller for that patient: the same value the
lastConsultationAtproperty already exposes, so the filter and the field can never disagree.⚠️ Because the filter reads a date that only exists once the caller has recorded something, patients the caller has no recording for are excluded as soon as any of these operators is used, whichever operator it is. This is deliberate: a patient with no consultation has no date to compare against, and silently treating "never" as "very old" would put them in every
lastConsultationAt[lt]result. To list those patients, omit the filter.Purely additive: no existing parameter, field, or default changed, and a request that does not pass one of these five behaves exactly as before.
Optional
insMatriculeTypefield to Patient responses.Optional
patientEmailStatusquery parameter for filtering.
- Optional query parameter
expand[] - Optional field
insValidatedAtto User responses - Optional field
insValidationDocumentTypeto User responses - Optional field
patientEmailStatusto User responses
- User response schemas now include minimal variants (
User-patient.read_patient.read_record_user.minimal,User-patient.read_user.minimal,User.jsonld-patient.read_patient.read_record_user.minimal,User.jsonld-patient.read_user.minimal,User.multipart-patient.read_patient.read_record_user.minimal,User.multipart-patient.read_user.minimal) in place of list variants
- Request fields
insQualifiedAt,insSource, andinsStatusfrom User - List schema variants for Patient and User (
Patient-patient.read_patient.read_record_user.list,Patient-patient.read_user.list,Patient.jsonld-patient.read_patient.read_record_user.list,Patient.jsonld-patient.read_user.list,Patient.multipart-patient.read_patient.read_record_user.list,Patient.multipart-patient.read_user.list,User-patient.read_patient.read_record_user.list,User-patient.read_user.list,User.jsonld-patient.read_patient.read_record_user.list,User.jsonld-patient.read_user.list,User.multipart-patient.read_patient.read_record_user.list,User.multipart-patient.read_user.list)
- Optional query parameter
facilityTypesto filter results - Optional field
facilityTypesin response bodies
Patients: the patient record now carries a real civil status.
civility(mr|mrs|dr|pr|none) is stored rather than inferred fromgender: a gender is not a form of address, and a patient who is a doctor is addressed "Dr" whatever theirs is.nullmeans nobody has declared one, and clients are expected to fall back to the gender-derived form themselves.birthGivenNamesholds the civil-status given names in order, the first being the birth first name. It is deliberately separate fromfirstName, which stays the name the patient actually goes by: the two are different fields, and a feuille de soins needs the civil-status spelling while every screen keeps showing the used one.birthPlaceCodecarries the INSEE (COG) code of the birthplace. Five characters and a string: Corsican codes are2A/2Band a birth abroad carries a99xxxcountry code, so anything parsing it as a number is already wrong.Patients: national health identity (INS), modelled as a value plus its qualification rather than a bare string:
insMatricule,insOid(1.2.250.1.213.1.4.8for a NIR,…4.9for a temporary NIA),insStatus(provisional|validated|retrieved|qualified),insSource(manual|vitale|insi|import) andinsQualifiedAt. Only a qualified identity may be carried into an interoperable exchange, and a matricule on its own cannot say whether this one may.⚠️
insMatriculeis notsocialSecurityNumber. Both are fifteen characters and often hold the same number, but the NIR on a record is the number the patient is covered under (a minor carries a parent's), while the INS identifies the patient themselves. The two are stored separately and neither ever falls back to the other; reading one as the other is how sibling records get merged.Patients:
phones[]andemails[]list every way of reaching a patient, primary first, each entry carryinguuid,labelandisPrimary. Phone entries also carrysmsCapable, true only for a number labelledmobile.Backward compatible: the existing
phoneandemailfields are unchanged and keep being served: they are now the projection of the primary entry. No client has to migrate, and nothing was removed.Patients:
photoUrlandphotoThumbnailUrlexpose the patient's identification photo as short-lived pre-signed URLs. They expire: display them, never store them.nullwhen the record has no photo.Patients:
rightsVerifiedandrightsVerifiedAtreport whether the applicable coverage was certified by an online rights check (Vitale, ADRi or ApCV). Read-only and derived from the patient's coverages, so acertifiedAtsitting on a merely declared coverage is not reported as a verification.Patients:
todolists what the record still needs, as stable codes (postal_address_missing,rights_to_verify). Codes and not sentences: the wording belongs to the client's locale files.
POST /public/directory/sheet/readendpointPOST /public/directory/sheet/updateendpoint- Optional
specialtiesquery parameter to Directory endpoints - Optional
specialtiesfield to Directory response bodies
POST /public/directory/claimsendpoint for submitting claims
- Directory —
GET /public/directory/nearby: resolves a pair of coordinates (lat,lng) to the nearest city hub and its canonical path, so a browser geolocation can be turned into a directory destination. Anonymous like the rest of the public directory surface, rate-limited per IP. Returns200witharea: nullwhen nothing is in range — "no city nearby" is an answer, not an error; a missing or malformed coordinate is a400.
- Directory — the profile and listing payloads (
profile,sites,openingHours,team, facets, autocomplete) now publish their field names instead of an opaqueadditionalProperties: anyOf[…]. Documentation-only: not a single byte of any response changed, no field was added or removed.
- API version updated to 1.45.0.
- API version updated to 1.44.0 with no breaking changes to the public contract.
- Directory —
GET /public/directory/search: polymorphic autocomplete across localités, practitioners and cabinets, returned as one heterogeneous list with each item tagged by type. Requires a query of at least 2 characters. - Directory —
GET /public/directory/facets: total result count for the current area and selection, plus per-term counts for every facet, so a filter panel can be rendered before the filter is applied. - Directory —
GET /public/directory/suggestions: most-populated localités for the search field's empty state (no query string required).
- Internal API version updated; no breaking changes to public endpoints or schemas.
- Internal API version updated; no breaking changes to public endpoints or schemas.
- Optional
maidenNamefield - Optional
medicalAlertfield - Optional
notesfield
- Internal API version updated; no breaking changes to public endpoints or schemas.
- Internal API version updated; no breaking changes to public endpoints or schemas.
administrative_reportenum value to document type fieldspanoramic_reportenum value to document type fields
- Optional
validatedAtfield in response schemas
- (breaking) Collection view navigation properties (
first,last,next,previous) are now nullable in 200 responses - Request property
citynow has a maximum length of 255 characters - Request property
postalCodenow has a maximum length of 10 characters - Request property
streetAddressnow has a maximum length of 255 characters - Webhook --
certificateVerificationDisabledis no longer writable viaPATCH /webhooks/{uuid}(security hardening — disabling TLS certificate verification is now an admin-only operation). The field remains readable in webhook responses; requests that still include it are silently ignored.
- Patient -- Four new optional fields on the patient resource:
recordNumber(practice folder number),streetAddress,postalCode,city. Available on both requests (create/update, including the bulk importPOST /patients/bulk) and responses. All nullable — existing integrations are unaffected.
- Patient --
POST /patients(create-or-update) no longer matches an existing patient byexternalId. A patient is now considered existing only by social security number or by the combination offirstName+lastName+dateOfBirth. TheexternalIdis still stored but never decides create-vs-update, because some source systems reassign external folder numbers and a reusedexternalIdpreviously overwrote an unrelated patient's record. A reusedexternalIdnow creates a new patient.
- Patient -- New optional field
socialSecurityNumber(French NIR, 15 characters, nullable) on patient resources, with strict control-key validation (requests with an invalid checksum are rejected). The NIR is used as a high-priority deduplication key when creating or updating patients (server-side; it is not exposed as a public query filter). - Client -- OAuth client schema (embedded in public resources) now exposes four targeting fields:
systems(array ofmac/windows/web),countries(ISO 3166-1 alpha-2 codes),specialties(medical specialty enums),clientTypes(business_software,productivity). Used by app catalogs like Askara Hub to filter visible apps per platform.
- Document -- New value
intervention_reportin thedocument.typeenum, used for the new "Compte-rendu d'intervention" document type covering the broad spectrum of clinical interventions (extraction, treatment, follow-up, surgical procedures).
- Document -- The user-facing label of the
operative_reportdocument type was renamed from "Compte-rendu opératoire" to "Compte-rendu de pose d'implant" in all locales. The enum value (operative_report) and the API contract are unchanged — this is a label-only change visible to users in the application UI. Any client displaying this label from translations should refresh its translation bundle.
- User -- New fields
professionCode(nullable string) andprofessionLabel(nullable string) on user profile, sourced from PSC (Pro Santé Connect) identity provider. - Patient -- New filter parameters
finessandfiness[]onGET /patientsfor FINESS establishment filtering.
- User -- RPPS validation relaxed from strict 11-digit numeric (
^\d{11}$) to flexible alphanumeric (^[A-Za-z0-9]+$, maxLength: 20) to support international practitioner identifiers. - User -- Fields
genderandphoneare no longer required on the user profile.
No public API changes. Internal-only: added write:sts_tokens OAuth scope for Electron STS token management.
- Audio -- New filter parameter
exists[meeting]onGET /audiosto filter audios by meeting association. - Patient -- New filter parameter
exists[meeting]onGET /patients. - Document -- New filter parameter
exists[meeting]onGET /documents.
- Note -- New read-only resource with two endpoints: retrieve a collection of notes (
GET /notes) and retrieve a single note (GET /notes/{uuid}). Filterable by uuid, type, patient, audio, createdAt, updatedAt. Sortable by uuid, type, createdAt, updatedAt. Scope:read:notes.
- Audio -- Removed filter parameters
summaryandsummary[]fromGET /audios.
- Published the OpenAPI 3.1.0 specification for the Askara public API with OAuth2 authorization code security scheme.
- Audio -- Endpoints to retrieve a collection of audios and retrieve a single audio by UUID (read-only). Supports pagination, ordering, text search, and patient expand filters.
- Contact -- Endpoints to list, create, retrieve, and update contacts. Supports pagination, ordering, text search, and archive filtering.
- Document -- Endpoints to list documents, retrieve a single document, and set a document synchronization status. Supports filtering by synchronization state for integration workflows.
- Organization -- Endpoints to list organizations and retrieve a single organization by UUID (read-only).
- Patient -- Endpoints to list, create or update (upsert), retrieve, and patch patients. Supports pagination, ordering, text search, external ID matching, and archive filtering.
- User -- Endpoints to retrieve the current authenticated user (
/me) and retrieve a user by UUID (read-only). - Webhook -- Endpoints to list, create, retrieve, update, and delete webhooks for event-driven integrations.
- Published the OpenAPI 3.1.0 specification for the Askara SpeechToText API, secured via API key (
X-API-KEYheader). - Transcription -- Asynchronous endpoint to submit an audio file URL for speech-to-text processing with a callback URL for result delivery.