{"items":[{"type":"link","label":"Askara API","link":"/apis/askara-symfony/askara-api","routeSlug":"/apis/askara-symfony/askara-api","content":{"contentType":"overview","meta":{"name":"Askara API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.askara.ai","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Askara API (1.94.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Askara.ai open API"}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Audio","link":"/apis/askara-symfony/askara-api/audio","routeSlug":"/apis/askara-symfony/askara-api/audio","items":[{"label":"Retrieve collection of audios.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/audio/api_audios","routeSlug":"/apis/askara-symfony/askara-api/audio/api_audios","metadata":{"seo":{"title":"Retrieve collection of audios.","description":"Use this endpoint to retrieve the collection of audio information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_audios","name":"Retrieve collection of audios.","isWebhook":false,"pointer":"/paths/~1audios/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve collection of audios.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve the collection of audio information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:audios"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","style":"form","explode":true,"schemaId":"schema_0","description":"The collection page number"},{"name":"itemsPerPage","in":"query","style":"form","explode":true,"schemaId":"schema_1","description":"The number of items per page"},{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_2","description":""},{"name":"audioWorkflowStepV3","in":"query","style":"form","explode":true,"schemaId":"schema_3","description":"Filter audios by workflow-step status. Repeat the parameter to match several statuses (union)."},{"name":"search","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio search"},{"name":"exists[archivedAt]","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audio exists[archivedAt]"},"children":[]}]}]}]},{"name":"uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio uuid"},{"name":"patient","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio patient"},{"name":"documents","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio documents"},{"name":"user","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio user"},{"name":"languageSpoken","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio languageSpoken"},{"name":"createdAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio createdAt"},{"name":"updatedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio updatedAt"},{"name":"archivedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Audio archivedAt"}],"pointer":"/paths/~1audios/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audios","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true},{"name":"itemsPerPage","in":"query","required":false,"schemaId":"schema_1","style":"form","explode":true},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_2","style":"form","explode":true},{"name":"audioWorkflowStepV3","in":"query","required":false,"schemaId":"schema_3","style":"form","explode":true},{"name":"search","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"exists[archivedAt]","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"patient","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"documents","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"user","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"languageSpoken","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"createdAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"updatedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"archivedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:audios"]}],"responseCodes":["200","403"],"pointer":"/audios","href":"audio/api_audios","openApiOperationId":"api_audios","summary":"Retrieve collection of audios."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audio collection","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"},"application/ld+json":{"schemaId":"schema_6"},"multipart/form-data":{"schemaId":"schema_7"}},"schemaId":"schema_5"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1audios/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"},"application/ld+json":{"schemaId":"schema_6"},"multipart/form-data":{"schemaId":"schema_7"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audio/api_audios"}],"panels":[]}]},"httpPath":"/audios"},{"label":"Retrieve an audio.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/audio/api_audio","routeSlug":"/apis/askara-symfony/askara-api/audio/api_audio","metadata":{"seo":{"title":"Retrieve an audio.","description":"Use this endpoint to retrieve an audio information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_audio","name":"Retrieve an audio.","isWebhook":false,"pointer":"/paths/~1audios~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an audio.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve an audio information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:audios"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Audio identifier","required":true}],"pointer":"/paths/~1audios~1{uuid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_2","description":""}],"pointer":"/paths/~1audios~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audios/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_2","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:audios"]}],"responseCodes":["200","403","404"],"pointer":"/audios/{uuid}","href":"audio/api_audio","openApiOperationId":"api_audio","summary":"Retrieve an audio."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audio resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Audio-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"},"application/ld+json":{"schemaId":"components/schemas/Audio.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"},"multipart/form-data":{"schemaId":"components/schemas/Audio.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"}},"schemaId":"components/schemas/Audio-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"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1audios~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Audio-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","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Audio-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"},"application/ld+json":{"schemaId":"components/schemas/Audio.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"},"multipart/form-data":{"schemaId":"components/schemas/Audio.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"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audio/api_audio"}],"panels":[]}]},"httpPath":"/audios/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Audio"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audio","showPageActions":true},{"nodeType":"markdoc","content":"Resource 'Audio' operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/audios","summary":"Retrieve collection of audios.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audio/api_audios","deprecated":false},{"title":"/audios/{uuid}","summary":"Retrieve an audio.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audio/api_audio","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact","link":"/apis/askara-symfony/askara-api/contact","routeSlug":"/apis/askara-symfony/askara-api/contact","items":[{"label":"Retrieve collection of contacts.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/contact/api_contacts","routeSlug":"/apis/askara-symfony/askara-api/contact/api_contacts","metadata":{"seo":{"title":"Retrieve collection of contacts.","description":"Use this endpoint to retrieve the collection of contact information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_contacts","name":"Retrieve collection of contacts.","isWebhook":false,"pointer":"/paths/~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve collection of contacts.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve the collection of contact information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:contacts"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","style":"form","explode":true,"schemaId":"schema_0","description":"The collection page number"},{"name":"itemsPerPage","in":"query","style":"form","explode":true,"schemaId":"schema_1","description":"The number of items per page"},{"name":"search","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact search"},{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_8","description":""},{"name":"uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact uuid"},{"name":"firstName","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact firstName"},{"name":"lastName","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact lastName"},{"name":"legalName","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact legalName"},{"name":"gender","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact gender"},{"name":"languageSpoken","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact languageSpoken"},{"name":"email","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact email"},{"name":"user.email","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact user.email"},{"name":"visibilityOption","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact visibilityOption"},{"name":"phone","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact phone"},{"name":"specialty","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact specialty"},{"name":"streetAddress","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact streetAddress"},{"name":"postalCode","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact postalCode"},{"name":"city","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact city"},{"name":"country","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact country"},{"name":"createdAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact createdAt"},{"name":"updatedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact updatedAt"},{"name":"user.uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Contact user.uuid"}],"pointer":"/paths/~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true},{"name":"itemsPerPage","in":"query","required":false,"schemaId":"schema_1","style":"form","explode":true},{"name":"search","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_8","style":"form","explode":true},{"name":"uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"firstName","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"lastName","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"legalName","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"gender","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"languageSpoken","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"email","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"user.email","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"visibilityOption","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"phone","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"specialty","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"streetAddress","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"postalCode","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"city","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"country","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"createdAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"updatedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"user.uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:contacts"]}],"responseCodes":["200","403"],"pointer":"/contacts","href":"contact/api_contacts","openApiOperationId":"api_contacts","summary":"Retrieve collection of contacts."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact collection","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"},"application/ld+json":{"schemaId":"schema_10"},"multipart/form-data":{"schemaId":"schema_11"}},"schemaId":"schema_9"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"},"application/ld+json":{"schemaId":"schema_10"},"multipart/form-data":{"schemaId":"schema_11"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact/api_contacts"}],"panels":[]}]},"httpPath":"/contacts"},{"label":"Create a contact.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/contact/api_contact_create","routeSlug":"/apis/askara-symfony/askara-api/contact/api_contact_create","metadata":{"seo":{"title":"Create a contact.","description":"Use this endpoint to create a contact entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_contact_create","name":"Create a contact.","isWebhook":false,"pointer":"/paths/~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to create a contact entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["write:contacts"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_8","description":""}],"pointer":"/paths/~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact-contact.create"},"application/ld+json":{"schemaId":"components/schemas/Contact-contact.create"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.create"}},"schemaId":"components/schemas/Contact-contact.create","pointer":"/paths/~1contacts/post/requestBody","description":"The new Contact resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_8","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["write:contacts"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Contact-contact.create"},"application/ld+json":{"schemaId":"components/schemas/Contact-contact.create"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.create"}},"responseCodes":["201","400","403","422"],"pointer":"/contacts","href":"contact/api_contact_create","openApiOperationId":"api_contact_create","summary":"Create a contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"schemaId":"components/schemas/Contact-contact.create","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact-contact.create"},"application/ld+json":{"schemaId":"components/schemas/Contact-contact.create"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.create"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Contact resource created","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact-contact.read"},"application/ld+json":{"schemaId":"components/schemas/Contact.jsonld-contact.read"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.read"}},"schemaId":"components/schemas/Contact-contact.read"},{"code":"400","description":"Invalid input","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"422","description":"An error occurred","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}},"schemaId":"components/schemas/ConstraintViolation.jsonld"}],"pointer":"/paths/~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Contact-contact.read","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact-contact.read"},"application/ld+json":{"schemaId":"components/schemas/Contact.jsonld-contact.read"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.read"}}},{"code":"400","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ConstraintViolation.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact/api_contact_create"}],"panels":[]}]},"httpPath":"/contacts"},{"label":"Retrieve a contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/contact/api_contact","routeSlug":"/apis/askara-symfony/askara-api/contact/api_contact","metadata":{"seo":{"title":"Retrieve a contact.","description":"Use this endpoint to retrieve a contact information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_contact","name":"Retrieve a contact.","isWebhook":false,"pointer":"/paths/~1contacts~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve a contact information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:contacts"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Contact identifier","required":true}],"pointer":"/paths/~1contacts~1{uuid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_8","description":""}],"pointer":"/paths/~1contacts~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_8","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:contacts"]}],"responseCodes":["200","403","404"],"pointer":"/contacts/{uuid}","href":"contact/api_contact","openApiOperationId":"api_contact","summary":"Retrieve a contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact-contact.read"},"application/ld+json":{"schemaId":"components/schemas/Contact.jsonld-contact.read"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.read"}},"schemaId":"components/schemas/Contact-contact.read"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1contacts~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact-contact.read","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact-contact.read"},"application/ld+json":{"schemaId":"components/schemas/Contact.jsonld-contact.read"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.read"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact/api_contact"}],"panels":[]}]},"httpPath":"/contacts/{uuid}"},{"label":"Patch a contact.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/contact/api_contact_patch","routeSlug":"/apis/askara-symfony/askara-api/contact/api_contact_patch","metadata":{"seo":{"title":"Patch a contact.","description":"Use this endpoint to update a contact entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_contact_patch","name":"Patch a contact.","isWebhook":false,"pointer":"/paths/~1contacts~1{uuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to update a contact entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["write:contacts"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Contact identifier","required":true}],"pointer":"/paths/~1contacts~1{uuid}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_8","description":""}],"pointer":"/paths/~1contacts~1{uuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/Contact-contact.create"}},"schemaId":"components/schemas/Contact-contact.create","pointer":"/paths/~1contacts~1{uuid}/patch/requestBody","description":"The updated Contact resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/contacts/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_8","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["write:contacts"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/Contact-contact.create"}},"responseCodes":["200","400","403","404","422"],"pointer":"/contacts/{uuid}","href":"contact/api_contact_patch","openApiOperationId":"api_contact_patch","summary":"Patch a contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"schemaId":"components/schemas/Contact-contact.create","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/Contact-contact.create"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact resource updated","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact-contact.read"},"application/ld+json":{"schemaId":"components/schemas/Contact.jsonld-contact.read"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.read"}},"schemaId":"components/schemas/Contact-contact.read"},{"code":"400","description":"Invalid input","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"422","description":"An error occurred","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}},"schemaId":"components/schemas/ConstraintViolation.jsonld"}],"pointer":"/paths/~1contacts~1{uuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact-contact.read","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact-contact.read"},"application/ld+json":{"schemaId":"components/schemas/Contact.jsonld-contact.read"},"multipart/form-data":{"schemaId":"components/schemas/Contact-contact.read"}}},{"code":"400","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ConstraintViolation.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact/api_contact_patch"}],"panels":[]}]},"httpPath":"/contacts/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Contact"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact","showPageActions":true},{"nodeType":"markdoc","content":"Resource 'Contact' operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contacts","summary":"Retrieve collection of contacts.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact/api_contacts","deprecated":false},{"title":"/contacts","summary":"Create a contact.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact/api_contact_create","deprecated":false},{"title":"/contacts/{uuid}","summary":"Retrieve a contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact/api_contact","deprecated":false},{"title":"/contacts/{uuid}","summary":"Patch a contact.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact/api_contact_patch","deprecated":false}]}]}]}]}},{"type":"group","label":"Document","link":"/apis/askara-symfony/askara-api/document","routeSlug":"/apis/askara-symfony/askara-api/document","items":[{"label":"Retrieve collection of document entities.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/document/api_documents","routeSlug":"/apis/askara-symfony/askara-api/document/api_documents","metadata":{"seo":{"title":"Retrieve collection of document entities.","description":"Use this endpoint to retrieve the collection of document information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_documents","name":"Retrieve collection of document entities.","isWebhook":false,"pointer":"/paths/~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve collection of document entities.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve the collection of document information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:documents"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","style":"form","explode":true,"schemaId":"schema_0","description":"The collection page number"},{"name":"itemsPerPage","in":"query","style":"form","explode":true,"schemaId":"schema_1","description":"The number of items per page"},{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_12","description":""},{"name":"search","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document search"},{"name":"synchronized","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":"Filter documents by synchronization status with the current OAuth client"},{"name":"patientEmailStatus","in":"query","style":"form","explode":true,"schemaId":"schema_14","description":"Filter documents by how far the copy emailed to the patient got. Repeat the parameter to match several statuses (union). Documents never emailed to their patient match no status and are excluded whenever this filter is set."},{"name":"uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document uuid"},{"name":"user.email","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document user.email"},{"name":"patient.email","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document patient.email"},{"name":"patient.id","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document patient.id"},{"name":"type","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document type"},{"name":"pdf","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document pdf"},{"name":"genericContactSpecialty","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document genericContactSpecialty"},{"name":"createdAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document createdAt"},{"name":"updatedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document updatedAt"},{"name":"encounteredAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document encounteredAt"},{"name":"exists[encounteredAt]","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":""},{"name":"exists[meeting]","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":""},{"name":"exists[verifiedAt]","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":""},{"name":"user.uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document user.uuid"},{"name":"patient.uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document patient.uuid"},{"name":"audio.uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document audio.uuid"},{"name":"isAnonymized","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Document isAnonymized"}],"pointer":"/paths/~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true},{"name":"itemsPerPage","in":"query","required":false,"schemaId":"schema_1","style":"form","explode":true},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_12","style":"form","explode":true},{"name":"search","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"synchronized","in":"query","required":false,"schemaId":"schema_13","style":"form","explode":false},{"name":"patientEmailStatus","in":"query","required":false,"schemaId":"schema_14","style":"form","explode":true},{"name":"uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"user.email","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"patient.email","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"patient.id","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"type","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"pdf","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"genericContactSpecialty","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"createdAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"updatedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"encounteredAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"exists[encounteredAt]","in":"query","required":false,"schemaId":"schema_13","style":"form","explode":false},{"name":"exists[meeting]","in":"query","required":false,"schemaId":"schema_13","style":"form","explode":false},{"name":"exists[verifiedAt]","in":"query","required":false,"schemaId":"schema_13","style":"form","explode":false},{"name":"user.uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"patient.uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"audio.uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"isAnonymized","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:documents"]}],"responseCodes":["200","403"],"pointer":"/documents","href":"document/api_documents","openApiOperationId":"api_documents","summary":"Retrieve collection of document entities."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document collection","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"},"application/ld+json":{"schemaId":"schema_16"},"multipart/form-data":{"schemaId":"schema_17"}},"schemaId":"schema_15"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"},"application/ld+json":{"schemaId":"schema_16"},"multipart/form-data":{"schemaId":"schema_17"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/api_documents"}],"panels":[]}]},"httpPath":"/documents"},{"label":"Retrieve a document entity.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/document/api_document","routeSlug":"/apis/askara-symfony/askara-api/document/api_document","metadata":{"seo":{"title":"Retrieve a document entity.","description":"Use this endpoint to retrieve a document information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_document","name":"Retrieve a document entity.","isWebhook":false,"pointer":"/paths/~1documents~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a document entity.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve a document information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:documents"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Document identifier","required":true}],"pointer":"/paths/~1documents~1{uuid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_12","description":""}],"pointer":"/paths/~1documents~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_12","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:documents"]}],"responseCodes":["200","403","404"],"pointer":"/documents/{uuid}","href":"document/api_document","openApiOperationId":"api_document","summary":"Retrieve a document entity."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"application/ld+json":{"schemaId":"components/schemas/Document.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"multipart/form-data":{"schemaId":"components/schemas/Document.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"}},"schemaId":"components/schemas/Document-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1documents~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Document-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"application/ld+json":{"schemaId":"components/schemas/Document.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"multipart/form-data":{"schemaId":"components/schemas/Document.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/api_document"}],"panels":[]}]},"httpPath":"/documents/{uuid}"},{"label":"Set a document synchronization status.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/document/api_document_status","routeSlug":"/apis/askara-symfony/askara-api/document/api_document_status","metadata":{"seo":{"title":"Set a document synchronization status.","description":"Use this endpoint to set a document synchronization status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_document_status","name":"Set a document synchronization status.","isWebhook":false,"pointer":"/paths/~1documents~1{uuid}~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a document synchronization status.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to set a document synchronization status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["write:document_integrations"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Document identifier","required":true}],"pointer":"/paths/~1documents~1{uuid}~1status/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_12","description":""}],"pointer":"/paths/~1documents~1{uuid}~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"},"application/ld+json":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"},"multipart/form-data":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"}},"schemaId":"components/schemas/Document.DocumentStatusDto-document.status","pointer":"/paths/~1documents~1{uuid}~1status/post/requestBody","description":"The new Document resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/{uuid}/status","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_12","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["write:document_integrations"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"},"application/ld+json":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"},"multipart/form-data":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"}},"responseCodes":["200","400","403","422"],"pointer":"/documents/{uuid}/status","href":"document/api_document_status","openApiOperationId":"api_document_status","summary":"Set a document synchronization status."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"schemaId":"components/schemas/Document.DocumentStatusDto-document.status","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"},"application/ld+json":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"},"multipart/form-data":{"schemaId":"components/schemas/Document.DocumentStatusDto-document.status"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document resource created","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"application/ld+json":{"schemaId":"components/schemas/Document.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"multipart/form-data":{"schemaId":"components/schemas/Document.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"}},"schemaId":"components/schemas/Document-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"code":"400","description":"Invalid input","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"422","description":"An error occurred","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}},"schemaId":"components/schemas/ConstraintViolation.jsonld"}],"pointer":"/paths/~1documents~1{uuid}~1status/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Document-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"application/ld+json":{"schemaId":"components/schemas/Document.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"multipart/form-data":{"schemaId":"components/schemas/Document.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"}}},{"code":"400","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ConstraintViolation.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/api_document_status"}],"panels":[]}]},"httpPath":"/documents/{uuid}/status"}],"content":{"contentType":"group","meta":{"name":"Document"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document","showPageActions":true},{"nodeType":"markdoc","content":"Resource 'Document' operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/documents","summary":"Retrieve collection of document entities.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document/api_documents","deprecated":false},{"title":"/documents/{uuid}","summary":"Retrieve a document entity.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document/api_document","deprecated":false},{"title":"/documents/{uuid}/status","summary":"Set a document synchronization status.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/document/api_document_status","deprecated":false}]}]}]}]}},{"type":"group","label":"Note","link":"/apis/askara-symfony/askara-api/note","routeSlug":"/apis/askara-symfony/askara-api/note","items":[{"label":"Retrieve collection of notes.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/note/api_notes","routeSlug":"/apis/askara-symfony/askara-api/note/api_notes","metadata":{"seo":{"title":"Retrieve collection of notes.","description":"Use this endpoint to retrieve a collection of notes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_notes","name":"Retrieve collection of notes.","isWebhook":false,"pointer":"/paths/~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve collection of notes.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve a collection of notes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:notes"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","style":"form","explode":true,"schemaId":"schema_0","description":"The collection page number"},{"name":"itemsPerPage","in":"query","style":"form","explode":true,"schemaId":"schema_1","description":"The number of items per page"},{"name":"groups","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Note groups"},{"name":"uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Note uuid"},{"name":"type","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Note type"},{"name":"patient","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Note patient"},{"name":"audio","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Note audio"},{"name":"createdAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Note createdAt"},{"name":"updatedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Note updatedAt"},{"name":"exists[meeting]","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note exists[meeting]"},"children":[]}]}]}]},{"name":"order[uuid]","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note order[uuid]"},"children":[]}]}]}]},{"name":"order[type]","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note order[type]"},"children":[]}]}]}]},{"name":"order[createdAt]","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note order[createdAt]"},"children":[]}]}]}]},{"name":"order[updatedAt]","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note order[updatedAt]"},"children":[]}]}]}]}],"pointer":"/paths/~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notes","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true},{"name":"itemsPerPage","in":"query","required":false,"schemaId":"schema_1","style":"form","explode":true},{"name":"groups","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"type","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"patient","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"audio","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"createdAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"updatedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"exists[meeting]","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"order[uuid]","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"order[type]","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"order[createdAt]","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"order[updatedAt]","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:notes"]}],"responseCodes":["200","403"],"pointer":"/notes","href":"note/api_notes","openApiOperationId":"api_notes","summary":"Retrieve collection of notes."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Note collection","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"},"application/ld+json":{"schemaId":"schema_19"},"multipart/form-data":{"schemaId":"schema_20"}},"schemaId":"schema_18"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"},"application/ld+json":{"schemaId":"schema_19"},"multipart/form-data":{"schemaId":"schema_20"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/note/api_notes"}],"panels":[]}]},"httpPath":"/notes"},{"label":"Retrieve a note.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/note/api_note","routeSlug":"/apis/askara-symfony/askara-api/note/api_note","metadata":{"seo":{"title":"Retrieve a note.","description":"Use this endpoint to retrieve a note information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_note","name":"Retrieve a note.","isWebhook":false,"pointer":"/paths/~1notes~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a note.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve a note information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:notes"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Note identifier","required":true}],"pointer":"/paths/~1notes~1{uuid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"groups","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Note groups"}],"pointer":"/paths/~1notes~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notes/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"groups","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:notes"]}],"responseCodes":["200","403","404"],"pointer":"/notes/{uuid}","href":"note/api_note","openApiOperationId":"api_note","summary":"Retrieve a note."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Note resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Note-note.read_note.read_audio_note.read_user_patient.list_user.list"},"application/ld+json":{"schemaId":"components/schemas/Note.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list"},"multipart/form-data":{"schemaId":"components/schemas/Note.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list"}},"schemaId":"components/schemas/Note-note.read_note.read_audio_note.read_user_patient.list_user.list"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1notes~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Note-note.read_note.read_audio_note.read_user_patient.list_user.list","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Note-note.read_note.read_audio_note.read_user_patient.list_user.list"},"application/ld+json":{"schemaId":"components/schemas/Note.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list"},"multipart/form-data":{"schemaId":"components/schemas/Note.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/note/api_note"}],"panels":[]}]},"httpPath":"/notes/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Note"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Note","showPageActions":true},{"nodeType":"markdoc","content":"Resource 'Note' operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/notes","summary":"Retrieve collection of notes.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/note/api_notes","deprecated":false},{"title":"/notes/{uuid}","summary":"Retrieve a note.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/note/api_note","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization","link":"/apis/askara-symfony/askara-api/organization","routeSlug":"/apis/askara-symfony/askara-api/organization","items":[{"label":"Retrieve collection of organization entities.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/organization/api_organizations","routeSlug":"/apis/askara-symfony/askara-api/organization/api_organizations","metadata":{"seo":{"title":"Retrieve collection of organization entities.","description":"Use this endpoint to retrieve the collection of organization information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_organizations","name":"Retrieve collection of organization entities.","isWebhook":false,"pointer":"/paths/~1organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve collection of organization entities.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve the collection of organization information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["organization"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","style":"form","explode":true,"schemaId":"schema_0","description":"The collection page number"},{"name":"itemsPerPage","in":"query","style":"form","explode":true,"schemaId":"schema_1","description":"The number of items per page"},{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_21","description":""},{"name":"search","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization search"},{"name":"uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization uuid"},{"name":"name","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization name"},{"name":"vatNumber","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization vatNumber"},{"name":"siret","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization siret"},{"name":"finess","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization finess"},{"name":"streetAddress","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization streetAddress"},{"name":"postalCode","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization postalCode"},{"name":"city","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization city"},{"name":"country","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization country"},{"name":"timezone","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization timezone"},{"name":"phone","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization phone"},{"name":"secretariatEmail","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization secretariatEmail"},{"name":"website","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization website"},{"name":"dentalNomenclatureSystem","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization dentalNomenclatureSystem"},{"name":"preferredCurrency","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization preferredCurrency"},{"name":"language","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization language"},{"name":"subscriptions","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization subscriptions"},{"name":"webhooks","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization webhooks"},{"name":"organizationUsers","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization organizationUsers"},{"name":"images","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization images"},{"name":"latitude","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization latitude"},{"name":"longitude","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization longitude"},{"name":"createdAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization createdAt"},{"name":"updatedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Organization updatedAt"}],"pointer":"/paths/~1organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true},{"name":"itemsPerPage","in":"query","required":false,"schemaId":"schema_1","style":"form","explode":true},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_21","style":"form","explode":true},{"name":"search","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"name","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"vatNumber","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"siret","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"finess","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"streetAddress","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"postalCode","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"city","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"country","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"timezone","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"phone","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"secretariatEmail","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"website","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"dentalNomenclatureSystem","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"preferredCurrency","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"language","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"subscriptions","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"webhooks","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"organizationUsers","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"images","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"latitude","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"longitude","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"createdAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"updatedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["organization"]}],"responseCodes":["200","403"],"pointer":"/organizations","href":"organization/api_organizations","openApiOperationId":"api_organizations","summary":"Retrieve collection of organization entities."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Organization collection","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"},"application/ld+json":{"schemaId":"schema_23"},"multipart/form-data":{"schemaId":"schema_24"}},"schemaId":"schema_22"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1organizations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"},"application/ld+json":{"schemaId":"schema_23"},"multipart/form-data":{"schemaId":"schema_24"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization/api_organizations"}],"panels":[]}]},"httpPath":"/organizations"},{"label":"Retrieve an organization entity.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/organization/api_organization","routeSlug":"/apis/askara-symfony/askara-api/organization/api_organization","metadata":{"seo":{"title":"Retrieve an organization entity.","description":"Use this endpoint to retrieve an organization information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_organization","name":"Retrieve an organization entity.","isWebhook":false,"pointer":"/paths/~1organizations~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an organization entity.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve an organization information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["organization"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Organization identifier","required":true}],"pointer":"/paths/~1organizations~1{uuid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_21","description":""}],"pointer":"/paths/~1organizations~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_21","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["organization"]}],"responseCodes":["200","403","404"],"pointer":"/organizations/{uuid}","href":"organization/api_organization","openApiOperationId":"api_organization","summary":"Retrieve an organization entity."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Organization resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},"application/ld+json":{"schemaId":"components/schemas/Organization.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},"multipart/form-data":{"schemaId":"components/schemas/Organization.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"}},"schemaId":"components/schemas/Organization-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1organizations~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},"application/ld+json":{"schemaId":"components/schemas/Organization.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},"multipart/form-data":{"schemaId":"components/schemas/Organization.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization/api_organization"}],"panels":[]}]},"httpPath":"/organizations/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Organization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization","showPageActions":true},{"nodeType":"markdoc","content":"Resource 'Organization' operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations","summary":"Retrieve collection of organization entities.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization/api_organizations","deprecated":false},{"title":"/organizations/{uuid}","summary":"Retrieve an organization entity.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization/api_organization","deprecated":false}]}]}]}]}},{"type":"group","label":"Patient","link":"/apis/askara-symfony/askara-api/patient","routeSlug":"/apis/askara-symfony/askara-api/patient","items":[{"label":"Retrieve collection of patients.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/patient/api_patients","routeSlug":"/apis/askara-symfony/askara-api/patient/api_patients","metadata":{"seo":{"title":"Retrieve collection of patients.","description":"Use this endpoint to retrieve the collection of patient information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_patients","name":"Retrieve collection of patients.","isWebhook":false,"pointer":"/paths/~1patients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve collection of patients.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve the collection of patient information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:patients"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","style":"form","explode":true,"schemaId":"schema_0","description":"The collection page number"},{"name":"itemsPerPage","in":"query","style":"form","explode":true,"schemaId":"schema_1","description":"The number of items per page"},{"name":"search","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient search"},{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_25","description":""},{"name":"uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient uuid"},{"name":"firstName","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient firstName"},{"name":"lastName","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient lastName"},{"name":"languageSpoken","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient languageSpoken"},{"name":"dateOfBirth","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient dateOfBirth"},{"name":"gender","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient gender"},{"name":"user.email","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient user.email"},{"name":"visibilityOption","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient visibilityOption"},{"name":"email","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient email"},{"name":"phone","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient phone"},{"name":"anonymousCode","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient anonymousCode"},{"name":"createdAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient createdAt"},{"name":"updatedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient updatedAt"},{"name":"synchronizedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient synchronizedAt"},{"name":"user.uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Patient user.uuid"},{"name":"lastConsultationAt[between]","in":"query","style":"form","explode":false,"schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last consultation within the range, bounds included (\""},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"). 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."},"children":[]}]}]}]},{"name":"lastConsultationAt[gt]","in":"query","style":"form","explode":false,"schemaId":"schema_26","description":"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."},{"name":"lastConsultationAt[gte]","in":"query","style":"form","explode":false,"schemaId":"schema_26","description":"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."},{"name":"lastConsultationAt[lt]","in":"query","style":"form","explode":false,"schemaId":"schema_26","description":"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."},{"name":"lastConsultationAt[lte]","in":"query","style":"form","explode":false,"schemaId":"schema_26","description":"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."}],"pointer":"/paths/~1patients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/patients","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true},{"name":"itemsPerPage","in":"query","required":false,"schemaId":"schema_1","style":"form","explode":true},{"name":"search","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"expand[]","in":"query","required":false,"schemaId":"schema_25","style":"form","explode":true},{"name":"uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"firstName","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"lastName","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"languageSpoken","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"dateOfBirth","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"gender","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"user.email","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"visibilityOption","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"email","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"phone","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"anonymousCode","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"createdAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"updatedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"synchronizedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"user.uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"lastConsultationAt[between]","in":"query","required":false,"schemaId":"schema_26","style":"form","explode":false},{"name":"lastConsultationAt[gt]","in":"query","required":false,"schemaId":"schema_26","style":"form","explode":false},{"name":"lastConsultationAt[gte]","in":"query","required":false,"schemaId":"schema_26","style":"form","explode":false},{"name":"lastConsultationAt[lt]","in":"query","required":false,"schemaId":"schema_26","style":"form","explode":false},{"name":"lastConsultationAt[lte]","in":"query","required":false,"schemaId":"schema_26","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:patients"]}],"responseCodes":["200","403"],"pointer":"/patients","href":"patient/api_patients","openApiOperationId":"api_patients","summary":"Retrieve collection of patients."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Patient collection","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"},"application/ld+json":{"schemaId":"schema_28"},"multipart/form-data":{"schemaId":"schema_29"}},"schemaId":"schema_27"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1patients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_27","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"},"application/ld+json":{"schemaId":"schema_28"},"multipart/form-data":{"schemaId":"schema_29"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patient/api_patients"}],"panels":[]}]},"httpPath":"/patients"},{"label":"Create or update a patient.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/patient/api_patient_create","routeSlug":"/apis/askara-symfony/askara-api/patient/api_patient_create","metadata":{"seo":{"title":"Create or update a patient.","description":"Use this endpoint to create a patient entity or update an existing one if it already exists. A patient is considered existing if it matches by social security number, or by the combination of firstName + lastName + dateOfBirth. The externalId is stored but never used to match an existing patient, since external folder numbers may be reassigned by the source software. The status tells the two outcomes apart: 201 when a new patient was created, 200 when an existing patient was matched and updated (the response body is that existing patient)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_patient_create","name":"Create or update a patient.","isWebhook":false,"pointer":"/paths/~1patients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update a patient.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to create a patient entity or update an existing one if it already exists. A patient is considered existing if it matches by social security number, or by the combination of firstName + lastName + dateOfBirth. The externalId is stored but never used to match an existing patient, since external folder numbers may be reassigned by the source software. The status tells the two outcomes apart: 201 when a new patient was created, 200 when an existing patient was matched and updated (the response body is that existing patient)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["write:patients"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_25","description":""}],"pointer":"/paths/~1patients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Patient-patient.create"},"application/ld+json":{"schemaId":"components/schemas/Patient-patient.create"},"multipart/form-data":{"schemaId":"components/schemas/Patient-patient.create"}},"schemaId":"components/schemas/Patient-patient.create","pointer":"/paths/~1patients/post/requestBody","description":"The new Patient resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/patients","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_25","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["write:patients"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Patient-patient.create"},"application/ld+json":{"schemaId":"components/schemas/Patient-patient.create"},"multipart/form-data":{"schemaId":"components/schemas/Patient-patient.create"}},"responseCodes":["200","201","400","403","422"],"pointer":"/patients","href":"patient/api_patient_create","openApiOperationId":"api_patient_create","summary":"Create or update a patient."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"schemaId":"components/schemas/Patient-patient.create","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Patient-patient.create"},"application/ld+json":{"schemaId":"components/schemas/Patient-patient.create"},"multipart/form-data":{"schemaId":"components/schemas/Patient-patient.create"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Existing patient matched and updated","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Patient-patient.read_user.minimal"},"application/ld+json":{"schemaId":"components/schemas/Patient.jsonld-patient.read_user.minimal"},"multipart/form-data":{"schemaId":"components/schemas/Patient.multipart-patient.read_user.minimal"}},"schemaId":"components/schemas/Patient-patient.read_user.minimal"},{"code":"201","description":"Patient resource created","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Patient-patient.read_user.minimal"},"application/ld+json":{"schemaId":"components/schemas/Patient.jsonld-patient.read_user.minimal"},"multipart/form-data":{"schemaId":"components/schemas/Patient.multipart-patient.read_user.minimal"}},"schemaId":"components/schemas/Patient-patient.read_user.minimal"},{"code":"400","description":"Invalid input","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"422","description":"An error occurred","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}},"schemaId":"components/schemas/ConstraintViolation.jsonld"}],"pointer":"/paths/~1patients/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Patient-patient.read_user.minimal","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Patient-patient.read_user.minimal"},"application/ld+json":{"schemaId":"components/schemas/Patient.jsonld-patient.read_user.minimal"},"multipart/form-data":{"schemaId":"components/schemas/Patient.multipart-patient.read_user.minimal"}}},{"code":"201","schemaId":"components/schemas/Patient-patient.read_user.minimal","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Patient-patient.read_user.minimal"},"application/ld+json":{"schemaId":"components/schemas/Patient.jsonld-patient.read_user.minimal"},"multipart/form-data":{"schemaId":"components/schemas/Patient.multipart-patient.read_user.minimal"}}},{"code":"400","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ConstraintViolation.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patient/api_patient_create"}],"panels":[]}]},"httpPath":"/patients"},{"label":"Retrieve a patient.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/patient/api_patient","routeSlug":"/apis/askara-symfony/askara-api/patient/api_patient","metadata":{"seo":{"title":"Retrieve a patient.","description":"Use this endpoint to retrieve a patient information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_patient","name":"Retrieve a patient.","isWebhook":false,"pointer":"/paths/~1patients~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a patient.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve a patient information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:patients"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Patient identifier","required":true}],"pointer":"/paths/~1patients~1{uuid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_25","description":""}],"pointer":"/paths/~1patients~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/patients/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_25","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:patients"]}],"responseCodes":["200","403","404"],"pointer":"/patients/{uuid}","href":"patient/api_patient","openApiOperationId":"api_patient","summary":"Retrieve a patient."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Patient resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Patient-patient.read_patient.read_record_user.minimal"},"application/ld+json":{"schemaId":"components/schemas/Patient.jsonld-patient.read_patient.read_record_user.minimal"},"multipart/form-data":{"schemaId":"components/schemas/Patient.multipart-patient.read_patient.read_record_user.minimal"}},"schemaId":"components/schemas/Patient-patient.read_patient.read_record_user.minimal"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1patients~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Patient-patient.read_patient.read_record_user.minimal","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Patient-patient.read_patient.read_record_user.minimal"},"application/ld+json":{"schemaId":"components/schemas/Patient.jsonld-patient.read_patient.read_record_user.minimal"},"multipart/form-data":{"schemaId":"components/schemas/Patient.multipart-patient.read_patient.read_record_user.minimal"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patient/api_patient"}],"panels":[]}]},"httpPath":"/patients/{uuid}"},{"label":"Patch a patient.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/patient/api_patient_patch","routeSlug":"/apis/askara-symfony/askara-api/patient/api_patient_patch","metadata":{"seo":{"title":"Patch a patient.","description":"Use this endpoint to update a patient entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_patient_patch","name":"Patch a patient.","isWebhook":false,"pointer":"/paths/~1patients~1{uuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a patient.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to update a patient entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["write:patients"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Patient identifier","required":true}],"pointer":"/paths/~1patients~1{uuid}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand[]","in":"query","style":"form","explode":true,"schemaId":"schema_25","description":""}],"pointer":"/paths/~1patients~1{uuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/Patient-patient.update.jsonMergePatch"}},"schemaId":"components/schemas/Patient-patient.update.jsonMergePatch","pointer":"/paths/~1patients~1{uuid}/patch/requestBody","description":"The updated Patient resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/patients/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[{"name":"expand[]","in":"query","required":false,"schemaId":"schema_25","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["write:patients"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/Patient-patient.update.jsonMergePatch"}},"responseCodes":["200","400","403","404","422"],"pointer":"/patients/{uuid}","href":"patient/api_patient_patch","openApiOperationId":"api_patient_patch","summary":"Patch a patient."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"schemaId":"components/schemas/Patient-patient.update.jsonMergePatch","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/Patient-patient.update.jsonMergePatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Patient resource updated","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Patient-patient.read_patient.read_record_user.minimal"},"application/ld+json":{"schemaId":"components/schemas/Patient.jsonld-patient.read_patient.read_record_user.minimal"},"multipart/form-data":{"schemaId":"components/schemas/Patient.multipart-patient.read_patient.read_record_user.minimal"}},"schemaId":"components/schemas/Patient-patient.read_patient.read_record_user.minimal"},{"code":"400","description":"Invalid input","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"422","description":"An error occurred","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}},"schemaId":"components/schemas/ConstraintViolation.jsonld"}],"pointer":"/paths/~1patients~1{uuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Patient-patient.read_patient.read_record_user.minimal","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Patient-patient.read_patient.read_record_user.minimal"},"application/ld+json":{"schemaId":"components/schemas/Patient.jsonld-patient.read_patient.read_record_user.minimal"},"multipart/form-data":{"schemaId":"components/schemas/Patient.multipart-patient.read_patient.read_record_user.minimal"}}},{"code":"400","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ConstraintViolation.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patient/api_patient_patch"}],"panels":[]}]},"httpPath":"/patients/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Patient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patient","showPageActions":true},{"nodeType":"markdoc","content":"Resource 'Patient' operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/patients","summary":"Retrieve collection of patients.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patient/api_patients","deprecated":false},{"title":"/patients","summary":"Create or update a patient.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/patient/api_patient_create","deprecated":false},{"title":"/patients/{uuid}","summary":"Retrieve a patient.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patient/api_patient","deprecated":false},{"title":"/patients/{uuid}","summary":"Patch a patient.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/patient/api_patient_patch","deprecated":false}]}]}]}]}},{"type":"group","label":"User","link":"/apis/askara-symfony/askara-api/user","routeSlug":"/apis/askara-symfony/askara-api/user","items":[{"label":"Retrieve current user.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/user/api_me","routeSlug":"/apis/askara-symfony/askara-api/user/api_me","metadata":{"seo":{"title":"Retrieve current user.","description":"Use this endpoint to retrieve the current user information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_me","name":"Retrieve current user.","isWebhook":false,"pointer":"/paths/~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve current user.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve the current user information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["profile"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/me","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["profile"]}],"responseCodes":["200","403","404"],"pointer":"/me","href":"user/api_me","openApiOperationId":"api_me","summary":"Retrieve current user."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User.CurrentUserResponseDto-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"},"application/ld+json":{"schemaId":"components/schemas/User.CurrentUserResponseDto.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"},"multipart/form-data":{"schemaId":"components/schemas/User.CurrentUserResponseDto.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"}},"schemaId":"components/schemas/User.CurrentUserResponseDto-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1me/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/User.CurrentUserResponseDto-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User.CurrentUserResponseDto-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"},"application/ld+json":{"schemaId":"components/schemas/User.CurrentUserResponseDto.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"},"multipart/form-data":{"schemaId":"components/schemas/User.CurrentUserResponseDto.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/api_me"}],"panels":[]}]},"httpPath":"/me"},{"label":"Retrieve one user.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/user/api_user","routeSlug":"/apis/askara-symfony/askara-api/user/api_user","metadata":{"seo":{"title":"Retrieve one user.","description":"Use this endpoint to retrieve a user information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_user","name":"Retrieve one user.","isWebhook":false,"pointer":"/paths/~1users~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve one user.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve a user information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["profile"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"User identifier","required":true}],"pointer":"/paths/~1users~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["profile"]}],"responseCodes":["200","403","404"],"pointer":"/users/{uuid}","href":"user/api_user","openApiOperationId":"api_user","summary":"Retrieve one user."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User-user.read_user.read_organizations_organization.read"},"application/ld+json":{"schemaId":"components/schemas/User.jsonld-user.read_user.read_organizations_organization.read"},"multipart/form-data":{"schemaId":"components/schemas/User.multipart-user.read_user.read_organizations_organization.read"}},"schemaId":"components/schemas/User-user.read_user.read_organizations_organization.read"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1users~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/User-user.read_user.read_organizations_organization.read","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User-user.read_user.read_organizations_organization.read"},"application/ld+json":{"schemaId":"components/schemas/User.jsonld-user.read_user.read_organizations_organization.read"},"multipart/form-data":{"schemaId":"components/schemas/User.multipart-user.read_user.read_organizations_organization.read"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/api_user"}],"panels":[]}]},"httpPath":"/users/{uuid}"}],"content":{"contentType":"group","meta":{"name":"User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true},{"nodeType":"markdoc","content":"Resource 'User' operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/me","summary":"Retrieve current user.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/api_me","deprecated":false},{"title":"/users/{uuid}","summary":"Retrieve one user.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/api_user","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhook","link":"/apis/askara-symfony/askara-api/webhook","routeSlug":"/apis/askara-symfony/askara-api/webhook","items":[{"label":"Retrieve collection of webhooks.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/webhook/api_webhooks","routeSlug":"/apis/askara-symfony/askara-api/webhook/api_webhooks","metadata":{"seo":{"title":"Retrieve collection of webhooks.","description":"Use this endpoint to retrieve the collection of webhook information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_webhooks","name":"Retrieve collection of webhooks.","isWebhook":false,"pointer":"/paths/~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve collection of webhooks.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve the collection of webhook information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:webhooks"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","style":"form","explode":true,"schemaId":"schema_0","description":"The collection page number"},{"name":"itemsPerPage","in":"query","style":"form","explode":true,"schemaId":"schema_1","description":"The number of items per page"},{"name":"search","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook search"},{"name":"uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook uuid"},{"name":"organization","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook organization"},{"name":"user.email","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook user.email"},{"name":"url","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook url"},{"name":"subscriptions","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook subscriptions"},{"name":"user.uuid","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook user.uuid"},{"name":"certificateVerificationDisabled","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook certificateVerificationDisabled"},{"name":"enabled","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook enabled"},{"name":"createdAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook createdAt"},{"name":"updatedAt","in":"query","style":"form","explode":true,"schemaId":"schema_4","description":"Webhook updatedAt"}],"pointer":"/paths/~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true},{"name":"itemsPerPage","in":"query","required":false,"schemaId":"schema_1","style":"form","explode":true},{"name":"search","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"organization","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"user.email","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"url","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"subscriptions","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"user.uuid","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"certificateVerificationDisabled","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"enabled","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"createdAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true},{"name":"updatedAt","in":"query","required":false,"schemaId":"schema_4","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:webhooks"]}],"responseCodes":["200","403"],"pointer":"/webhooks","href":"webhook/api_webhooks","openApiOperationId":"api_webhooks","summary":"Retrieve collection of webhooks."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook collection","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"},"application/ld+json":{"schemaId":"schema_31"},"multipart/form-data":{"schemaId":"schema_32"}},"schemaId":"schema_30"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_30","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"},"application/ld+json":{"schemaId":"schema_31"},"multipart/form-data":{"schemaId":"schema_32"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/api_webhooks"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Create a webhook.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/webhook/api_webhook_create","routeSlug":"/apis/askara-symfony/askara-api/webhook/api_webhook_create","metadata":{"seo":{"title":"Create a webhook.","description":"Use this endpoint to create a webhook entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_webhook_create","name":"Create a webhook.","isWebhook":false,"pointer":"/paths/~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a webhook.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to create a webhook entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["write:webhooks"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"},"application/ld+json":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"},"multipart/form-data":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"}},"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create","pointer":"/paths/~1webhooks/post/requestBody","description":"The new Webhook resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["write:webhooks"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"},"application/ld+json":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"},"multipart/form-data":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"}},"responseCodes":["201","400","403","422"],"pointer":"/webhooks","href":"webhook/api_webhook_create","openApiOperationId":"api_webhook_create","summary":"Create a webhook."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"},"application/ld+json":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"},"multipart/form-data":{"schemaId":"components/schemas/Webhook.WebhookCreateDto-webhook.create"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Webhook resource created","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook-webhook.read"},"application/ld+json":{"schemaId":"components/schemas/Webhook.jsonld-webhook.read"},"multipart/form-data":{"schemaId":"components/schemas/Webhook-webhook.read"}},"schemaId":"components/schemas/Webhook-webhook.read"},{"code":"400","description":"Invalid input","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"422","description":"An error occurred","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}},"schemaId":"components/schemas/ConstraintViolation.jsonld"}],"pointer":"/paths/~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Webhook-webhook.read","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook-webhook.read"},"application/ld+json":{"schemaId":"components/schemas/Webhook.jsonld-webhook.read"},"multipart/form-data":{"schemaId":"components/schemas/Webhook-webhook.read"}}},{"code":"400","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ConstraintViolation.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/api_webhook_create"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Retrieve a webhook.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/webhook/api_webhook","routeSlug":"/apis/askara-symfony/askara-api/webhook/api_webhook","metadata":{"seo":{"title":"Retrieve a webhook.","description":"Use this endpoint to retrieve a webhook information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_webhook","name":"Retrieve a webhook.","isWebhook":false,"pointer":"/paths/~1webhooks~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a webhook.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to retrieve a webhook information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["read:webhooks"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Webhook identifier","required":true}],"pointer":"/paths/~1webhooks~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["read:webhooks"]}],"responseCodes":["200","403","404"],"pointer":"/webhooks/{uuid}","href":"webhook/api_webhook","openApiOperationId":"api_webhook","summary":"Retrieve a webhook."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook resource","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook-webhook.read"},"application/ld+json":{"schemaId":"components/schemas/Webhook.jsonld-webhook.read"},"multipart/form-data":{"schemaId":"components/schemas/Webhook-webhook.read"}},"schemaId":"components/schemas/Webhook-webhook.read"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1webhooks~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Webhook-webhook.read","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook-webhook.read"},"application/ld+json":{"schemaId":"components/schemas/Webhook.jsonld-webhook.read"},"multipart/form-data":{"schemaId":"components/schemas/Webhook-webhook.read"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/api_webhook"}],"panels":[]}]},"httpPath":"/webhooks/{uuid}"},{"label":"Delete a webhook.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/webhook/api_webhook_delete","routeSlug":"/apis/askara-symfony/askara-api/webhook/api_webhook_delete","metadata":{"seo":{"title":"Delete a webhook.","description":"Use this endpoint to delete a webhook entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_webhook_delete","name":"Delete a webhook.","isWebhook":false,"pointer":"/paths/~1webhooks~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to delete a webhook entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["write:webhooks"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Webhook identifier","required":true}],"pointer":"/paths/~1webhooks~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhooks/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["write:webhooks"]}],"responseCodes":["204","403","404"],"pointer":"/webhooks/{uuid}","href":"webhook/api_webhook_delete","openApiOperationId":"api_webhook_delete","summary":"Delete a webhook."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Webhook resource deleted"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"}],"pointer":"/paths/~1webhooks~1{uuid}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/api_webhook_delete"}],"panels":[]}]},"httpPath":"/webhooks/{uuid}"},{"label":"Patch a webhook.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/askara-symfony/askara-api/webhook/api_webhook_patch","routeSlug":"/apis/askara-symfony/askara-api/webhook/api_webhook_patch","metadata":{"seo":{"title":"Patch a webhook.","description":"Use this endpoint to update a webhook entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_webhook_patch","name":"Patch a webhook.","isWebhook":false,"pointer":"/paths/~1webhooks~1{uuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a webhook.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to update a webhook entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth_auth_code","scopes":["write:webhooks"],"type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","style":"simple","explode":false,"schemaId":"schema_4","description":"Webhook identifier","required":true}],"pointer":"/paths/~1webhooks~1{uuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/Webhook-webhook.update.jsonMergePatch"}},"schemaId":"components/schemas/Webhook-webhook.update.jsonMergePatch","pointer":"/paths/~1webhooks~1{uuid}/patch/requestBody","description":"The updated Webhook resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/webhooks/{uuid}","servers":[{"url":"https://api.askara.ai","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_4","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth_auth_code","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}}],"scopes":["write:webhooks"]}],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/Webhook-webhook.update.jsonMergePatch"}},"responseCodes":["200","400","403","404","422"],"pointer":"/webhooks/{uuid}","href":"webhook/api_webhook_patch","openApiOperationId":"api_webhook_patch","summary":"Patch a webhook."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.askara.ai","description":"Production"}],"schemaId":"components/schemas/Webhook-webhook.update.jsonMergePatch","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/Webhook-webhook.update.jsonMergePatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook resource updated","mediaType":"application/json","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook-webhook.read"},"application/ld+json":{"schemaId":"components/schemas/Webhook.jsonld-webhook.read"},"multipart/form-data":{"schemaId":"components/schemas/Webhook-webhook.read"}},"schemaId":"components/schemas/Webhook-webhook.read"},{"code":"400","description":"Invalid input","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"403","description":"Forbidden","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"404","description":"Not found","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error.jsonld"},{"code":"422","description":"An error occurred","mediaType":"application/ld+json","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}},"schemaId":"components/schemas/ConstraintViolation.jsonld"}],"pointer":"/paths/~1webhooks~1{uuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Webhook-webhook.read","mediaTypes":["application/json","application/ld+json","multipart/form-data"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook-webhook.read"},"application/ld+json":{"schemaId":"components/schemas/Webhook.jsonld-webhook.read"},"multipart/form-data":{"schemaId":"components/schemas/Webhook-webhook.read"}}},{"code":"400","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/Error.jsonld"},"application/problem+json":{"schemaId":"components/schemas/Error"},"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ConstraintViolation.jsonld","mediaTypes":["application/ld+json","application/problem+json","application/json"],"mediaTypeContent":{"application/ld+json":{"schemaId":"components/schemas/ConstraintViolation.jsonld"},"application/problem+json":{"schemaId":"components/schemas/ConstraintViolation"},"application/json":{"schemaId":"components/schemas/ConstraintViolation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/api_webhook_patch"}],"panels":[]}]},"httpPath":"/webhooks/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook","showPageActions":true},{"nodeType":"markdoc","content":"Resource 'Webhook' operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhooks","summary":"Retrieve collection of webhooks.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/api_webhooks","deprecated":false},{"title":"/webhooks","summary":"Create a webhook.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/api_webhook_create","deprecated":false},{"title":"/webhooks/{uuid}","summary":"Retrieve a webhook.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/api_webhook","deprecated":false},{"title":"/webhooks/{uuid}","summary":"Delete a webhook.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook/api_webhook_delete","deprecated":false},{"title":"/webhooks/{uuid}","summary":"Patch a webhook.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhook/api_webhook_patch","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Audio-audio.list_audio.read_user_user.list":{"id":"components/schemas/Audio-audio.list_audio.read_user_user.list","kind":"json-schema","title":"Audio-audio.list_audio.read_user_user.list","data":{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"user":{"description":"Audio user (author).","anyOf":[{"$ref":"#/components/schemas/User-audio.list_audio.read_user_user.list"},{"type":"null"}]},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}},"components/schemas/Audio-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":{"id":"components/schemas/Audio-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","kind":"json-schema","title":"Audio-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","data":{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient-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"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"documents":{"description":"Audio associated documents.","type":"array","items":{"$ref":"#/components/schemas/Document-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"}},"images":{"description":"Audio associated images.","type":"array","items":{"$ref":"#/components/schemas/Image-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"}},"meeting":{"description":"Associated meeting.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"user":{"description":"Audio user (author).","anyOf":[{"$ref":"#/components/schemas/User-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"},{"type":"null"}]},"languageSpoken":{"description":"Audio spoken language.","default":"fr","type":["string","null"]},"mediaRecorderType":{"readOnly":true,"description":"Get the media recorder type of this audio.","type":["string","null"]},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}},"components/schemas/Audio-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Audio-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Audio-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}},"components/schemas/Audio-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Audio-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Audio-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}},"components/schemas/Audio.jsonld-audio.list_audio.read_user_user.list":{"id":"components/schemas/Audio.jsonld-audio.list_audio.read_user_user.list","kind":"json-schema","title":"Audio.jsonld-audio.list_audio.read_user_user.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"user":{"description":"Audio user (author).","anyOf":[{"$ref":"#/components/schemas/User.jsonld-audio.list_audio.read_user_user.list"},{"type":"null"}]},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}]}},"components/schemas/Audio.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":{"id":"components/schemas/Audio.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","kind":"json-schema","title":"Audio.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","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient.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"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"documents":{"description":"Audio associated documents.","type":"array","items":{"$ref":"#/components/schemas/Document.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"}},"images":{"description":"Audio associated images.","type":"array","items":{"$ref":"#/components/schemas/Image.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"}},"meeting":{"description":"Associated meeting.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"user":{"description":"Audio user (author).","anyOf":[{"$ref":"#/components/schemas/User.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"},{"type":"null"}]},"languageSpoken":{"description":"Audio spoken language.","default":"fr","type":["string","null"]},"mediaRecorderType":{"readOnly":true,"description":"Get the media recorder type of this audio.","type":["string","null"]},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}]}},"components/schemas/Audio.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Audio.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Audio.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}]}},"components/schemas/Audio.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Audio.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Audio.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}]}},"components/schemas/Audio.multipart-audio.list_audio.read_user_user.list":{"id":"components/schemas/Audio.multipart-audio.list_audio.read_user_user.list","kind":"json-schema","title":"Audio.multipart-audio.list_audio.read_user_user.list","data":{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"user":{"description":"Audio user (author).","anyOf":[{"$ref":"#/components/schemas/User.multipart-audio.list_audio.read_user_user.list"},{"type":"null"}]},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}},"components/schemas/Audio.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":{"id":"components/schemas/Audio.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","kind":"json-schema","title":"Audio.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","data":{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient.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"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"documents":{"description":"Audio associated documents.","type":"array","items":{"$ref":"#/components/schemas/Document.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"}},"images":{"description":"Audio associated images.","type":"array","items":{"$ref":"#/components/schemas/Image.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"}},"meeting":{"description":"Associated meeting.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"user":{"description":"Audio user (author).","anyOf":[{"$ref":"#/components/schemas/User.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"},{"type":"null"}]},"languageSpoken":{"description":"Audio spoken language.","default":"fr","type":["string","null"]},"mediaRecorderType":{"readOnly":true,"description":"Get the media recorder type of this audio.","type":["string","null"]},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}},"components/schemas/Audio.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Audio.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Audio.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}},"components/schemas/Audio.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Audio.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Audio.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Audio unique identifier.","type":"string","format":"uuid"},"patient":{"description":"Audio patient.","anyOf":[{"$ref":"#/components/schemas/Patient.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"createdAt":{"description":"Audio creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Audio update date.","type":"string","format":"date-time"},"archivedAt":{"description":"Audio archive date.","type":["string","null"],"format":"date-time"},"audioWorkflowStepV3":{"readOnly":true,"description":"Get the current audio workflow step (v3).","type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}}}},"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":{"id":"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","kind":"json-schema","title":"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","data":{"type":"object","properties":{"identifier":{"description":"OAuth client unique identifier.","type":"string"},"name":{"description":"OAuth client name.","type":"string"},"description":{"description":"OAuth client description.","type":["string","null"]},"slug":{"description":"OAuth client slug.","type":["string","null"]},"logoUrl":{"format":"uri","description":"OAuth client logo URL.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"iconUrl":{"format":"uri","description":"OAuth client icon URL (small icon displayed next to patient name).","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"status":{"description":"OAuth client status.","default":"available","type":"string","enum":["available","available_soon","not_available"]},"countries":{"description":"Countries where this client is relevant (ISO 3166-1 alpha-2 codes).","type":["array","null"],"items":{"type":"string"}},"systems":{"description":"Operating systems supported by this client (mac, windows, web). Used by Askara Hub to filter apps per platform.","type":["array","null"],"items":{"type":["string","null"],"enum":["mac","windows","web",null]}},"specialties":{"description":"Medical specialties targeted by this client.","type":["array","null"],"items":{"type":["string","null"],"enum":["allergist","medical_biologist","cardiologist","radiology_center","sleep_center","mri_center","chiropractor","maxillofacial_surgeon","orthopedic_surgeon","oral_surgeon","dental_surgeon","cosmetic_dentist","dermatologist","diabetologist","endodontist","implantologist","infectiologist","physiotherapist","medical_biology_lab","general_practitioner","neurosurgeon","occlusodontist","pediatric_dentist","general_dentist","ent_specialist","orthodontist","periodontist","pedodontist","prosthetist","radiologist","rheumatologist","speech_therapist","anesthesiologist",null]}},"clientTypes":{"description":"Type categories of this client application.","type":["array","null"],"items":{"type":["string","null"],"enum":["business_software","productivity",null]}},"createdAt":{"description":"OAuth client creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"OAuth client update date.","type":["string","null"],"format":"date-time"},"integrationPageMarkdown":{"readOnly":true,"description":"Integration page content in Markdown format (localized).","type":["string","null"]},"tutorialMarkdown":{"readOnly":true,"description":"Tutorial content in Markdown format (localized) - can include images/GIFs.","type":["string","null"]}}}},"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":{"id":"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","kind":"json-schema","title":"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","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"identifier":{"description":"OAuth client unique identifier.","type":"string"},"name":{"description":"OAuth client name.","type":"string"},"description":{"description":"OAuth client description.","type":["string","null"]},"slug":{"description":"OAuth client slug.","type":["string","null"]},"logoUrl":{"format":"uri","description":"OAuth client logo URL.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"iconUrl":{"format":"uri","description":"OAuth client icon URL (small icon displayed next to patient name).","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"status":{"description":"OAuth client status.","default":"available","type":"string","enum":["available","available_soon","not_available"]},"countries":{"description":"Countries where this client is relevant (ISO 3166-1 alpha-2 codes).","type":["array","null"],"items":{"type":"string"}},"systems":{"description":"Operating systems supported by this client (mac, windows, web). Used by Askara Hub to filter apps per platform.","type":["array","null"],"items":{"type":["string","null"],"enum":["mac","windows","web",null]}},"specialties":{"description":"Medical specialties targeted by this client.","type":["array","null"],"items":{"type":["string","null"],"enum":["allergist","medical_biologist","cardiologist","radiology_center","sleep_center","mri_center","chiropractor","maxillofacial_surgeon","orthopedic_surgeon","oral_surgeon","dental_surgeon","cosmetic_dentist","dermatologist","diabetologist","endodontist","implantologist","infectiologist","physiotherapist","medical_biology_lab","general_practitioner","neurosurgeon","occlusodontist","pediatric_dentist","general_dentist","ent_specialist","orthodontist","periodontist","pedodontist","prosthetist","radiologist","rheumatologist","speech_therapist","anesthesiologist",null]}},"clientTypes":{"description":"Type categories of this client application.","type":["array","null"],"items":{"type":["string","null"],"enum":["business_software","productivity",null]}},"createdAt":{"description":"OAuth client creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"OAuth client update date.","type":["string","null"],"format":"date-time"},"integrationPageMarkdown":{"readOnly":true,"description":"Integration page content in Markdown format (localized).","type":["string","null"]},"tutorialMarkdown":{"readOnly":true,"description":"Tutorial content in Markdown format (localized) - can include images/GIFs.","type":["string","null"]}}}]}},"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":{"id":"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","kind":"json-schema","title":"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","data":{"type":"object","properties":{"identifier":{"description":"OAuth client unique identifier.","type":"string"},"name":{"description":"OAuth client name.","type":"string"},"description":{"description":"OAuth client description.","type":["string","null"]},"slug":{"description":"OAuth client slug.","type":["string","null"]},"logoUrl":{"format":"uri","description":"OAuth client logo URL.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"iconUrl":{"format":"uri","description":"OAuth client icon URL (small icon displayed next to patient name).","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"status":{"description":"OAuth client status.","default":"available","type":"string","enum":["available","available_soon","not_available"]},"countries":{"description":"Countries where this client is relevant (ISO 3166-1 alpha-2 codes).","type":["array","null"],"items":{"type":"string"}},"systems":{"description":"Operating systems supported by this client (mac, windows, web). Used by Askara Hub to filter apps per platform.","type":["array","null"],"items":{"type":["string","null"],"enum":["mac","windows","web",null]}},"specialties":{"description":"Medical specialties targeted by this client.","type":["array","null"],"items":{"type":["string","null"],"enum":["allergist","medical_biologist","cardiologist","radiology_center","sleep_center","mri_center","chiropractor","maxillofacial_surgeon","orthopedic_surgeon","oral_surgeon","dental_surgeon","cosmetic_dentist","dermatologist","diabetologist","endodontist","implantologist","infectiologist","physiotherapist","medical_biology_lab","general_practitioner","neurosurgeon","occlusodontist","pediatric_dentist","general_dentist","ent_specialist","orthodontist","periodontist","pedodontist","prosthetist","radiologist","rheumatologist","speech_therapist","anesthesiologist",null]}},"clientTypes":{"description":"Type categories of this client application.","type":["array","null"],"items":{"type":["string","null"],"enum":["business_software","productivity",null]}},"createdAt":{"description":"OAuth client creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"OAuth client update date.","type":["string","null"],"format":"date-time"},"integrationPageMarkdown":{"readOnly":true,"description":"Integration page content in Markdown format (localized).","type":["string","null"]},"tutorialMarkdown":{"readOnly":true,"description":"Tutorial content in Markdown format (localized) - can include images/GIFs.","type":["string","null"]}}}},"components/schemas/ConstraintViolation":{"id":"components/schemas/ConstraintViolation","kind":"json-schema","title":"ConstraintViolation","data":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"},"code":{"type":"string","description":"The code of the violation"},"hint":{"type":"string","description":"An extra hint to understand the violation"},"payload":{"type":"object","additionalProperties":true,"description":"The serialized payload of the violation"}},"required":["propertyPath","message"]}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}},"components/schemas/ConstraintViolation.jsonld":{"id":"components/schemas/ConstraintViolation.jsonld","kind":"json-schema","title":"ConstraintViolation.jsonld","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"},"code":{"type":"string","description":"The code of the violation"},"hint":{"type":"string","description":"An extra hint to understand the violation"},"payload":{"type":"object","additionalProperties":true,"description":"The serialized payload of the violation"}},"required":["propertyPath","message"]}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"}},"components/schemas/Contact-contact.create":{"id":"components/schemas/Contact-contact.create","kind":"json-schema","title":"Contact-contact.create","data":{"type":"object","properties":{"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]},"legalName":{"maxLength":255,"description":"Contact office or laboratory name.","type":["string","null"]},"isDoctor":{"description":"Whether the contact holds a doctor title.","default":false,"type":"boolean"},"gender":{"description":"Contact gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"languageSpoken":{"description":"Contact spoken language.","type":"string"},"email":{"format":"email","description":"Contact email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"phone":{"description":"Contact phone number.","example":"+33757590893","type":["string","null"]},"specialty":{"description":"Contact medical specialty.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Contact street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Contact postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Contact city.","type":["string","null"]},"country":{"description":"Contact country (ISO 3166-1 alpha-2 code).","type":["string","null"]},"customPrompt":{"description":"Custom AI prompt instructions for this contact.","type":["string","null"]}}}},"components/schemas/Contact-contact.list":{"id":"components/schemas/Contact-contact.list","kind":"json-schema","title":"Contact-contact.list","data":{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]},"legalName":{"maxLength":255,"description":"Contact office or laboratory name.","type":["string","null"]},"gender":{"description":"Contact gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"languageSpoken":{"description":"Contact spoken language.","type":"string"},"createdAt":{"description":"Contact creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Contact update date.","type":"string","format":"date-time"},"email":{"format":"email","description":"Contact email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"phone":{"description":"Contact phone number.","example":"+33757590893","type":["string","null"]},"specialty":{"description":"Contact medical specialty.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Contact street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Contact postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Contact city.","type":["string","null"]},"country":{"description":"Contact country (ISO 3166-1 alpha-2 code).","type":["string","null"]}}}},"components/schemas/Contact-contact.read":{"id":"components/schemas/Contact-contact.read","kind":"json-schema","title":"Contact-contact.read","data":{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]},"legalName":{"maxLength":255,"description":"Contact office or laboratory name.","type":["string","null"]},"isDoctor":{"description":"Whether the contact holds a doctor title.","default":false,"type":"boolean"},"gender":{"description":"Contact gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"languageSpoken":{"description":"Contact spoken language.","type":"string"},"createdAt":{"description":"Contact creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Contact update date.","type":"string","format":"date-time"},"email":{"format":"email","description":"Contact email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"phone":{"description":"Contact phone number.","example":"+33757590893","type":["string","null"]},"specialty":{"description":"Contact medical specialty.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Contact street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Contact postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Contact city.","type":["string","null"]},"country":{"description":"Contact country (ISO 3166-1 alpha-2 code).","type":["string","null"]}}}},"components/schemas/Contact-contact.update.jsonMergePatch":{"id":"components/schemas/Contact-contact.update.jsonMergePatch","kind":"json-schema","title":"Contact-contact.update.jsonMergePatch","data":{"type":"object","properties":{"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]},"legalName":{"maxLength":255,"description":"Contact office or laboratory name.","type":["string","null"]},"isDoctor":{"description":"Whether the contact holds a doctor title.","default":false,"type":"boolean"},"gender":{"description":"Contact gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"languageSpoken":{"description":"Contact spoken language.","type":"string"},"email":{"format":"email","description":"Contact email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"phone":{"description":"Contact phone number.","example":"+33757590893","type":["string","null"]},"specialty":{"description":"Contact medical specialty.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Contact street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Contact postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Contact city.","type":["string","null"]},"country":{"description":"Contact country (ISO 3166-1 alpha-2 code).","type":["string","null"]},"customPrompt":{"description":"Custom AI prompt instructions for this contact.","type":["string","null"]}}}},"components/schemas/Contact-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Contact-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Contact-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]}}}},"components/schemas/Contact.jsonld-contact.list":{"id":"components/schemas/Contact.jsonld-contact.list","kind":"json-schema","title":"Contact.jsonld-contact.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]},"legalName":{"maxLength":255,"description":"Contact office or laboratory name.","type":["string","null"]},"gender":{"description":"Contact gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"languageSpoken":{"description":"Contact spoken language.","type":"string"},"createdAt":{"description":"Contact creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Contact update date.","type":"string","format":"date-time"},"email":{"format":"email","description":"Contact email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"phone":{"description":"Contact phone number.","example":"+33757590893","type":["string","null"]},"specialty":{"description":"Contact medical specialty.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Contact street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Contact postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Contact city.","type":["string","null"]},"country":{"description":"Contact country (ISO 3166-1 alpha-2 code).","type":["string","null"]}}}]}},"components/schemas/Contact.jsonld-contact.read":{"id":"components/schemas/Contact.jsonld-contact.read","kind":"json-schema","title":"Contact.jsonld-contact.read","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]},"legalName":{"maxLength":255,"description":"Contact office or laboratory name.","type":["string","null"]},"isDoctor":{"description":"Whether the contact holds a doctor title.","default":false,"type":"boolean"},"gender":{"description":"Contact gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"languageSpoken":{"description":"Contact spoken language.","type":"string"},"createdAt":{"description":"Contact creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Contact update date.","type":"string","format":"date-time"},"email":{"format":"email","description":"Contact email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"phone":{"description":"Contact phone number.","example":"+33757590893","type":["string","null"]},"specialty":{"description":"Contact medical specialty.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Contact street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Contact postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Contact city.","type":["string","null"]},"country":{"description":"Contact country (ISO 3166-1 alpha-2 code).","type":["string","null"]}}}]}},"components/schemas/Contact.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Contact.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Contact.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]}}}]}},"components/schemas/Contact.multipart-contact.list":{"id":"components/schemas/Contact.multipart-contact.list","kind":"json-schema","title":"Contact.multipart-contact.list","data":{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]},"legalName":{"maxLength":255,"description":"Contact office or laboratory name.","type":["string","null"]},"gender":{"description":"Contact gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"languageSpoken":{"description":"Contact spoken language.","type":"string"},"createdAt":{"description":"Contact creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Contact update date.","type":"string","format":"date-time"},"email":{"format":"email","description":"Contact email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"phone":{"description":"Contact phone number.","example":"+33757590893","type":["string","null"]},"specialty":{"description":"Contact medical specialty.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Contact street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Contact postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Contact city.","type":["string","null"]},"country":{"description":"Contact country (ISO 3166-1 alpha-2 code).","type":["string","null"]}}}},"components/schemas/Contact.multipart-contact.read":{"id":"components/schemas/Contact.multipart-contact.read","kind":"json-schema","title":"Contact.multipart-contact.read","data":{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]},"legalName":{"maxLength":255,"description":"Contact office or laboratory name.","type":["string","null"]},"isDoctor":{"description":"Whether the contact holds a doctor title.","default":false,"type":"boolean"},"gender":{"description":"Contact gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"languageSpoken":{"description":"Contact spoken language.","type":"string"},"createdAt":{"description":"Contact creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Contact update date.","type":"string","format":"date-time"},"email":{"format":"email","description":"Contact email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"phone":{"description":"Contact phone number.","example":"+33757590893","type":["string","null"]},"specialty":{"description":"Contact medical specialty.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Contact street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Contact postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Contact city.","type":["string","null"]},"country":{"description":"Contact country (ISO 3166-1 alpha-2 code).","type":["string","null"]}}}},"components/schemas/Contact.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Contact.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Contact.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"type":"object","properties":{"uuid":{"description":"Contact unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Contact first name.","type":["string","null"]},"lastName":{"description":"Contact last name.","type":["string","null"]}}}},"components/schemas/Document-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":{"id":"components/schemas/Document-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","kind":"json-schema","title":"Document-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","data":{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User-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"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient-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"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf-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"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"documentIntegrations":{"description":"Document integrations with third-party software.","type":"array","items":{"$ref":"#/components/schemas/DocumentIntegration-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"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}},"components/schemas/Document-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Document-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Document-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"patient":{"description":"Document patient.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"emails":{"description":"Document emails.","type":"array","items":{"$ref":"#/components/schemas/Email-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}},"documentContacts":{"description":"Document contacts.","type":"array","items":{"$ref":"#/components/schemas/DocumentContact-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]},"patientEmailStatus":{"type":["object","null"],"required":["status","date"],"properties":{"status":{"type":"string","enum":["sent","received","opened"]},"date":{"type":"string","format":"date-time"}}}}}},"components/schemas/Document-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Document-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Document-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"audio":{"anyOf":[{"$ref":"#/components/schemas/Audio-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"documentIntegrations":{"description":"Document integrations with third-party software.","type":"array","items":{"$ref":"#/components/schemas/DocumentIntegration-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}},"components/schemas/Document-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Document-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Document-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"audio":{"anyOf":[{"$ref":"#/components/schemas/Audio-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}},"components/schemas/Document.DocumentStatusDto-document.status":{"id":"components/schemas/Document.DocumentStatusDto-document.status","kind":"json-schema","title":"Document.DocumentStatusDto-document.status","data":{"type":"object","required":["success"],"properties":{"success":{"description":"Whether the synchronization was successful or not.","type":["boolean","null"]},"error":{"maxLength":2000,"description":"Optional but recommended: Error message if synchronization failed (only when success is false).","type":["string","null"]}}}},"components/schemas/Document.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":{"id":"components/schemas/Document.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","kind":"json-schema","title":"Document.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","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User.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"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient.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"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf.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"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"documentIntegrations":{"description":"Document integrations with third-party software.","type":"array","items":{"$ref":"#/components/schemas/DocumentIntegration.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"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}]}},"components/schemas/Document.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Document.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Document.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","type":"string","format":"iri-reference","example":"https://example.com/"},"patient":{"description":"Document patient.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"emails":{"description":"Document emails.","type":"array","items":{"$ref":"#/components/schemas/Email.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}},"documentContacts":{"description":"Document contacts.","type":"array","items":{"$ref":"#/components/schemas/DocumentContact.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]},"patientEmailStatus":{"type":["object","null"],"required":["status","date"],"properties":{"status":{"type":"string","enum":["sent","received","opened"]},"date":{"type":"string","format":"date-time"}}}}}]}},"components/schemas/Document.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Document.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Document.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"audio":{"anyOf":[{"$ref":"#/components/schemas/Audio.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"documentIntegrations":{"description":"Document integrations with third-party software.","type":"array","items":{"$ref":"#/components/schemas/DocumentIntegration.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}]}},"components/schemas/Document.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Document.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Document.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"audio":{"anyOf":[{"$ref":"#/components/schemas/Audio.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}]}},"components/schemas/Document.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":{"id":"components/schemas/Document.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","kind":"json-schema","title":"Document.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","data":{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User.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"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient.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"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf.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"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"documentIntegrations":{"description":"Document integrations with third-party software.","type":"array","items":{"$ref":"#/components/schemas/DocumentIntegration.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"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}},"components/schemas/Document.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Document.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Document.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"patient":{"description":"Document patient.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"emails":{"description":"Document emails.","type":"array","items":{"$ref":"#/components/schemas/Email.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}},"documentContacts":{"description":"Document contacts.","type":"array","items":{"$ref":"#/components/schemas/DocumentContact.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]},"patientEmailStatus":{"type":["object","null"],"required":["status","date"],"properties":{"status":{"type":"string","enum":["sent","received","opened"]},"date":{"type":"string","format":"date-time"}}}}}},"components/schemas/Document.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Document.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Document.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"audio":{"anyOf":[{"$ref":"#/components/schemas/Audio.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"documentIntegrations":{"description":"Document integrations with third-party software.","type":"array","items":{"$ref":"#/components/schemas/DocumentIntegration.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"}},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}},"components/schemas/Document.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Document.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Document.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Document unique identifier.","type":"string","format":"uuid"},"createdAt":{"description":"Document creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Document update date.","type":"string","format":"date-time"},"encounteredAt":{"description":"Document operation/cone beam specific date.","type":["string","null"],"format":"date-time"},"user":{"description":"Document author.","$ref":"#/components/schemas/User.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},"patient":{"description":"Document patient.","anyOf":[{"$ref":"#/components/schemas/Patient.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"audio":{"anyOf":[{"$ref":"#/components/schemas/Audio.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"type":{"description":"Document type.","type":["string","null"],"enum":["operative_report","referral_letter","cone_beam_report","patient_letter","prescription","initial_medical_certificate","attendance_certificate","contraindication_certificate","lab_slip","endo_report","ortho_letter","meeting_report","intervention_report","panoramic_report","administrative_report","free_letter",null]},"pdf":{"description":"Document PDF file.","anyOf":[{"$ref":"#/components/schemas/Pdf.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"isAnonymized":{"description":"Document anonymization status.","default":false,"type":"boolean"},"genericContactSpecialty":{"description":"Generic contact specialty when no specific contact is selected (free text or predefined value).","type":["string","null"]}}}},"components/schemas/DocumentContact-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/DocumentContact-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"DocumentContact-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"type":"object","properties":{"uuid":{"description":"Document contact unique identifier.","type":["string","null"],"format":"uuid"},"contact":{"description":"Document contact related contact.","$ref":"#/components/schemas/Contact-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}}}},"components/schemas/DocumentContact.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/DocumentContact.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"DocumentContact.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Document contact unique identifier.","type":["string","null"],"format":"uuid"},"contact":{"description":"Document contact related contact.","$ref":"#/components/schemas/Contact.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}}}]}},"components/schemas/DocumentContact.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/DocumentContact.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"DocumentContact.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"type":"object","properties":{"uuid":{"description":"Document contact unique identifier.","type":["string","null"],"format":"uuid"},"contact":{"description":"Document contact related contact.","$ref":"#/components/schemas/Contact.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}}}},"components/schemas/DocumentIntegration-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":{"id":"components/schemas/DocumentIntegration-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","kind":"json-schema","title":"DocumentIntegration-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","data":{"type":"object","properties":{"uuid":{"description":"Document integration unique identifier.","type":"string","format":"uuid"},"client":{"description":"Third party integration.","anyOf":[{"$ref":"#/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"},{"type":"null"}]},"path":{"description":"Full file path where the document is stored on the third party system.","type":["string","null"]},"directory":{"description":"Third party software identifier (e.g., \"logosw\", \"julie\", \"desktop\").","type":["string","null"]},"tryCount":{"description":"Synchronization try count.","type":["integer","null"]},"lastTryAt":{"description":"Last synchronization try date.","type":["string","null"],"format":"date-time"},"synchronizedAt":{"description":"Synchronization date.","type":["string","null"],"format":"date-time"},"claimedAt":{"description":"Claim date (when download was reserved by a gateway instance).","type":["string","null"],"format":"date-time"},"appVersion":{"description":"App version of the gateway that performed the sync.","type":["string","null"]},"claimedByClient":{"description":"OAuth client that claimed/downloaded the document (e.g., Electron app).","anyOf":[{"$ref":"#/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"},{"type":"null"}]},"errorMessage":{"description":"Error message if synchronization failed.","type":["string","null"]},"errorCode":{"description":"Categorized reason why synchronization failed. Lets clients branch on a stable identifier instead of parsing errorMessage.","type":["string","null"],"enum":["client_timeout","client_webhook_unacknowledged","client_error","client_error_unclaimed",null]},"createdAt":{"description":"Creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Update date.","type":"string","format":"date-time"}}}},"components/schemas/DocumentIntegration-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/DocumentIntegration-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"DocumentIntegration-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Document integration unique identifier.","type":"string","format":"uuid"},"client":{"description":"Third party integration.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"path":{"description":"Full file path where the document is stored on the third party system.","type":["string","null"]},"directory":{"description":"Third party software identifier (e.g., \"logosw\", \"julie\", \"desktop\").","type":["string","null"]},"tryCount":{"description":"Synchronization try count.","type":["integer","null"]},"lastTryAt":{"description":"Last synchronization try date.","type":["string","null"],"format":"date-time"},"synchronizedAt":{"description":"Synchronization date.","type":["string","null"],"format":"date-time"},"claimedAt":{"description":"Claim date (when download was reserved by a gateway instance).","type":["string","null"],"format":"date-time"},"appVersion":{"description":"App version of the gateway that performed the sync.","type":["string","null"]},"claimedByClient":{"description":"OAuth client that claimed/downloaded the document (e.g., Electron app).","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"errorMessage":{"description":"Error message if synchronization failed.","type":["string","null"]},"errorCode":{"description":"Categorized reason why synchronization failed. Lets clients branch on a stable identifier instead of parsing errorMessage.","type":["string","null"],"enum":["client_timeout","client_webhook_unacknowledged","client_error","client_error_unclaimed",null]},"createdAt":{"description":"Creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Update date.","type":"string","format":"date-time"}}}},"components/schemas/DocumentIntegration.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":{"id":"components/schemas/DocumentIntegration.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","kind":"json-schema","title":"DocumentIntegration.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","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Document integration unique identifier.","type":"string","format":"uuid"},"client":{"description":"Third party integration.","anyOf":[{"$ref":"#/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"},{"type":"null"}]},"path":{"description":"Full file path where the document is stored on the third party system.","type":["string","null"]},"directory":{"description":"Third party software identifier (e.g., \"logosw\", \"julie\", \"desktop\").","type":["string","null"]},"tryCount":{"description":"Synchronization try count.","type":["integer","null"]},"lastTryAt":{"description":"Last synchronization try date.","type":["string","null"],"format":"date-time"},"synchronizedAt":{"description":"Synchronization date.","type":["string","null"],"format":"date-time"},"claimedAt":{"description":"Claim date (when download was reserved by a gateway instance).","type":["string","null"],"format":"date-time"},"appVersion":{"description":"App version of the gateway that performed the sync.","type":["string","null"]},"claimedByClient":{"description":"OAuth client that claimed/downloaded the document (e.g., Electron app).","anyOf":[{"$ref":"#/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"},{"type":"null"}]},"errorMessage":{"description":"Error message if synchronization failed.","type":["string","null"]},"errorCode":{"description":"Categorized reason why synchronization failed. Lets clients branch on a stable identifier instead of parsing errorMessage.","type":["string","null"],"enum":["client_timeout","client_webhook_unacknowledged","client_error","client_error_unclaimed",null]},"createdAt":{"description":"Creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Update date.","type":"string","format":"date-time"}}}]}},"components/schemas/DocumentIntegration.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/DocumentIntegration.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"DocumentIntegration.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Document integration unique identifier.","type":"string","format":"uuid"},"client":{"description":"Third party integration.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"path":{"description":"Full file path where the document is stored on the third party system.","type":["string","null"]},"directory":{"description":"Third party software identifier (e.g., \"logosw\", \"julie\", \"desktop\").","type":["string","null"]},"tryCount":{"description":"Synchronization try count.","type":["integer","null"]},"lastTryAt":{"description":"Last synchronization try date.","type":["string","null"],"format":"date-time"},"synchronizedAt":{"description":"Synchronization date.","type":["string","null"],"format":"date-time"},"claimedAt":{"description":"Claim date (when download was reserved by a gateway instance).","type":["string","null"],"format":"date-time"},"appVersion":{"description":"App version of the gateway that performed the sync.","type":["string","null"]},"claimedByClient":{"description":"OAuth client that claimed/downloaded the document (e.g., Electron app).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"errorMessage":{"description":"Error message if synchronization failed.","type":["string","null"]},"errorCode":{"description":"Categorized reason why synchronization failed. Lets clients branch on a stable identifier instead of parsing errorMessage.","type":["string","null"],"enum":["client_timeout","client_webhook_unacknowledged","client_error","client_error_unclaimed",null]},"createdAt":{"description":"Creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Update date.","type":"string","format":"date-time"}}}]}},"components/schemas/DocumentIntegration.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":{"id":"components/schemas/DocumentIntegration.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","kind":"json-schema","title":"DocumentIntegration.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","data":{"type":"object","properties":{"uuid":{"description":"Document integration unique identifier.","type":"string","format":"uuid"},"client":{"description":"Third party integration.","anyOf":[{"$ref":"#/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"},{"type":"null"}]},"path":{"description":"Full file path where the document is stored on the third party system.","type":["string","null"]},"directory":{"description":"Third party software identifier (e.g., \"logosw\", \"julie\", \"desktop\").","type":["string","null"]},"tryCount":{"description":"Synchronization try count.","type":["integer","null"]},"lastTryAt":{"description":"Last synchronization try date.","type":["string","null"],"format":"date-time"},"synchronizedAt":{"description":"Synchronization date.","type":["string","null"],"format":"date-time"},"claimedAt":{"description":"Claim date (when download was reserved by a gateway instance).","type":["string","null"],"format":"date-time"},"appVersion":{"description":"App version of the gateway that performed the sync.","type":["string","null"]},"claimedByClient":{"description":"OAuth client that claimed/downloaded the document (e.g., Electron app).","anyOf":[{"$ref":"#/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"},{"type":"null"}]},"errorMessage":{"description":"Error message if synchronization failed.","type":["string","null"]},"errorCode":{"description":"Categorized reason why synchronization failed. Lets clients branch on a stable identifier instead of parsing errorMessage.","type":["string","null"],"enum":["client_timeout","client_webhook_unacknowledged","client_error","client_error_unclaimed",null]},"createdAt":{"description":"Creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Update date.","type":"string","format":"date-time"}}}},"components/schemas/DocumentIntegration.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/DocumentIntegration.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"DocumentIntegration.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Document integration unique identifier.","type":"string","format":"uuid"},"client":{"description":"Third party integration.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"path":{"description":"Full file path where the document is stored on the third party system.","type":["string","null"]},"directory":{"description":"Third party software identifier (e.g., \"logosw\", \"julie\", \"desktop\").","type":["string","null"]},"tryCount":{"description":"Synchronization try count.","type":["integer","null"]},"lastTryAt":{"description":"Last synchronization try date.","type":["string","null"],"format":"date-time"},"synchronizedAt":{"description":"Synchronization date.","type":["string","null"],"format":"date-time"},"claimedAt":{"description":"Claim date (when download was reserved by a gateway instance).","type":["string","null"],"format":"date-time"},"appVersion":{"description":"App version of the gateway that performed the sync.","type":["string","null"]},"claimedByClient":{"description":"OAuth client that claimed/downloaded the document (e.g., Electron app).","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"errorMessage":{"description":"Error message if synchronization failed.","type":["string","null"]},"errorCode":{"description":"Categorized reason why synchronization failed. Lets clients branch on a stable identifier instead of parsing errorMessage.","type":["string","null"],"enum":["client_timeout","client_webhook_unacknowledged","client_error","client_error_unclaimed",null]},"createdAt":{"description":"Creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Update date.","type":"string","format":"date-time"}}}},"components/schemas/Email-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Email-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Email-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"type":"object","properties":{"uuid":{"description":"Email unique identifier.","type":"string","format":"uuid"},"sentAt":{"description":"Email sent date.","type":["string","null"],"format":"date-time"},"deliveredAt":{"description":"Email delivery date.","type":["string","null"],"format":"date-time"},"openedAt":{"description":"Email opening date.","type":["string","null"],"format":"date-time"}}}},"components/schemas/Email.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Email.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Email.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Email unique identifier.","type":"string","format":"uuid"},"sentAt":{"description":"Email sent date.","type":["string","null"],"format":"date-time"},"deliveredAt":{"description":"Email delivery date.","type":["string","null"],"format":"date-time"},"openedAt":{"description":"Email opening date.","type":["string","null"],"format":"date-time"}}}]}},"components/schemas/Email.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal":{"id":"components/schemas/Email.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","kind":"json-schema","title":"Email.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal","data":{"type":"object","properties":{"uuid":{"description":"Email unique identifier.","type":"string","format":"uuid"},"sentAt":{"description":"Email sent date.","type":["string","null"],"format":"date-time"},"deliveredAt":{"description":"Email delivery date.","type":["string","null"],"format":"date-time"},"openedAt":{"description":"Email opening date.","type":["string","null"],"format":"date-time"}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":["integer","null"],"examples":[404],"default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}},"components/schemas/Error.jsonld":{"id":"components/schemas/Error.jsonld","kind":"json-schema","title":"Error.jsonld","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":["integer","null"],"examples":[404],"default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."}},"components/schemas/HydraCollectionBaseSchema":{"id":"components/schemas/HydraCollectionBaseSchema","kind":"json-schema","title":"HydraCollectionBaseSchema","data":{"allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","properties":{"view":{"type":"object","properties":{"@id":{"type":"string","format":"uuid"},"@type":{"type":"string"},"first":{"type":["string","null"],"format":"uuid"},"last":{"type":["string","null"],"format":"uuid"},"previous":{"type":["string","null"],"format":"uuid"},"next":{"type":["string","null"],"format":"uuid"}},"example":{"@id":"string","@type":"string","first":"string","last":"string","previous":"string","next":"string"}}}}]}},"components/schemas/HydraCollectionBaseSchemaNoPagination":{"id":"components/schemas/HydraCollectionBaseSchemaNoPagination","kind":"json-schema","title":"HydraCollectionBaseSchemaNoPagination","data":{"type":"object","properties":{"totalItems":{"type":"integer","minimum":0},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}}},"components/schemas/HydraItemBaseSchema":{"id":"components/schemas/HydraItemBaseSchema","kind":"json-schema","title":"HydraItemBaseSchema","data":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]}},"components/schemas/Image-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":{"id":"components/schemas/Image-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","kind":"json-schema","title":"Image-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","data":{"type":"object","properties":{"uuid":{"description":"Image unique identifier.","type":"string","format":"uuid"},"title":{"description":"Image title.","type":["string","null"]},"name":{"description":"Image file name.","type":"string"},"size":{"description":"Image file size.","type":"integer"},"createdAt":{"description":"Image creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Image update date.","type":"string","format":"date-time"},"fileUrl":{"description":"Permanent image file URL (HMAC signed, never expires). Use this URL for embedding in documents.","type":["string","null"]}}}},"components/schemas/Image-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/Image-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"Image-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"type":"object","properties":{"uuid":{"description":"Image unique identifier.","type":"string","format":"uuid"},"title":{"description":"Image title.","type":["string","null"]},"name":{"description":"Image file name.","type":"string"},"size":{"description":"Image file size.","type":"integer"},"createdAt":{"description":"Image creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Image update date.","type":"string","format":"date-time"},"fileUrl":{"description":"Permanent image file URL (HMAC signed, never expires). Use this URL for embedding in documents.","type":["string","null"]}}}},"components/schemas/Image.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":{"id":"components/schemas/Image.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","kind":"json-schema","title":"Image.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","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Image unique identifier.","type":"string","format":"uuid"},"title":{"description":"Image title.","type":["string","null"]},"name":{"description":"Image file name.","type":"string"},"size":{"description":"Image file size.","type":"integer"},"createdAt":{"description":"Image creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Image update date.","type":"string","format":"date-time"},"fileUrl":{"description":"Permanent image file URL (HMAC signed, never expires). Use this URL for embedding in documents.","type":["string","null"]}}}]}},"components/schemas/Image.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/Image.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"Image.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Image unique identifier.","type":"string","format":"uuid"},"title":{"description":"Image title.","type":["string","null"]},"name":{"description":"Image file name.","type":"string"},"size":{"description":"Image file size.","type":"integer"},"createdAt":{"description":"Image creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Image update date.","type":"string","format":"date-time"},"fileUrl":{"description":"Permanent image file URL (HMAC signed, never expires). Use this URL for embedding in documents.","type":["string","null"]}}}]}},"components/schemas/Image.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":{"id":"components/schemas/Image.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","kind":"json-schema","title":"Image.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","data":{"type":"object","properties":{"uuid":{"description":"Image unique identifier.","type":"string","format":"uuid"},"title":{"description":"Image title.","type":["string","null"]},"name":{"description":"Image file name.","type":"string"},"size":{"description":"Image file size.","type":"integer"},"createdAt":{"description":"Image creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Image update date.","type":"string","format":"date-time"},"fileUrl":{"description":"Permanent image file URL (HMAC signed, never expires). Use this URL for embedding in documents.","type":["string","null"]}}}},"components/schemas/Image.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/Image.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"Image.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"type":"object","properties":{"uuid":{"description":"Image unique identifier.","type":"string","format":"uuid"},"title":{"description":"Image title.","type":["string","null"]},"name":{"description":"Image file name.","type":"string"},"size":{"description":"Image file size.","type":"integer"},"createdAt":{"description":"Image creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Image update date.","type":"string","format":"date-time"},"fileUrl":{"description":"Permanent image file URL (HMAC signed, never expires). Use this URL for embedding in documents.","type":["string","null"]}}}},"components/schemas/Note-note.list_patient.list":{"id":"components/schemas/Note-note.list_patient.list","kind":"json-schema","title":"Note-note.list_patient.list","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"content":{"description":"Note content.","type":["string","null"]},"type":{"description":"Note type.","type":"string","enum":["consultation_summary","meeting_summary","ortho_summary"]},"patient":{"description":"Associated patient.","anyOf":[{"$ref":"#/components/schemas/Patient-note.list_patient.list"},{"type":"null"}]},"createdAt":{"description":"Note creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Note last update date.","type":"string","format":"date-time"},"validatedAt":{"readOnly":true,"description":"Date the practitioner explicitly validated the note as-is, without editing its content.","type":["string","null"],"format":"date-time"},"contentModified":{"readOnly":true,"description":"Whether the note content was manually edited after AI generation.","type":"boolean"}}}},"components/schemas/Note-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/Note-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"Note-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"content":{"description":"Note content.","type":["string","null"]},"type":{"description":"Note type.","type":"string","enum":["consultation_summary","meeting_summary","ortho_summary"]},"audio":{"description":"Associated audio.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"patient":{"description":"Associated patient.","anyOf":[{"$ref":"#/components/schemas/Patient-note.read_note.read_audio_note.read_user_patient.list_user.list"},{"type":"null"}]},"user":{"description":"Note owner.","$ref":"#/components/schemas/User-note.read_note.read_audio_note.read_user_patient.list_user.list"},"createdAt":{"description":"Note creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Note last update date.","type":"string","format":"date-time"},"validatedAt":{"readOnly":true,"description":"Date the practitioner explicitly validated the note as-is, without editing its content.","type":["string","null"],"format":"date-time"},"contentModified":{"readOnly":true,"description":"Whether the note content was manually edited after AI generation.","type":"boolean"}}}},"components/schemas/Note.jsonld-note.list_patient.list":{"id":"components/schemas/Note.jsonld-note.list_patient.list","kind":"json-schema","title":"Note.jsonld-note.list_patient.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"content":{"description":"Note content.","type":["string","null"]},"type":{"description":"Note type.","type":"string","enum":["consultation_summary","meeting_summary","ortho_summary"]},"patient":{"description":"Associated patient.","anyOf":[{"$ref":"#/components/schemas/Patient.jsonld-note.list_patient.list"},{"type":"null"}]},"createdAt":{"description":"Note creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Note last update date.","type":"string","format":"date-time"},"validatedAt":{"readOnly":true,"description":"Date the practitioner explicitly validated the note as-is, without editing its content.","type":["string","null"],"format":"date-time"},"contentModified":{"readOnly":true,"description":"Whether the note content was manually edited after AI generation.","type":"boolean"}}}]}},"components/schemas/Note.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/Note.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"Note.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"content":{"description":"Note content.","type":["string","null"]},"type":{"description":"Note type.","type":"string","enum":["consultation_summary","meeting_summary","ortho_summary"]},"audio":{"description":"Associated audio.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"patient":{"description":"Associated patient.","anyOf":[{"$ref":"#/components/schemas/Patient.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list"},{"type":"null"}]},"user":{"description":"Note owner.","$ref":"#/components/schemas/User.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list"},"createdAt":{"description":"Note creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Note last update date.","type":"string","format":"date-time"},"validatedAt":{"readOnly":true,"description":"Date the practitioner explicitly validated the note as-is, without editing its content.","type":["string","null"],"format":"date-time"},"contentModified":{"readOnly":true,"description":"Whether the note content was manually edited after AI generation.","type":"boolean"}}}]}},"components/schemas/Note.multipart-note.list_patient.list":{"id":"components/schemas/Note.multipart-note.list_patient.list","kind":"json-schema","title":"Note.multipart-note.list_patient.list","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"content":{"description":"Note content.","type":["string","null"]},"type":{"description":"Note type.","type":"string","enum":["consultation_summary","meeting_summary","ortho_summary"]},"patient":{"description":"Associated patient.","anyOf":[{"$ref":"#/components/schemas/Patient.multipart-note.list_patient.list"},{"type":"null"}]},"createdAt":{"description":"Note creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Note last update date.","type":"string","format":"date-time"},"validatedAt":{"readOnly":true,"description":"Date the practitioner explicitly validated the note as-is, without editing its content.","type":["string","null"],"format":"date-time"},"contentModified":{"readOnly":true,"description":"Whether the note content was manually edited after AI generation.","type":"boolean"}}}},"components/schemas/Note.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/Note.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"Note.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"content":{"description":"Note content.","type":["string","null"]},"type":{"description":"Note type.","type":"string","enum":["consultation_summary","meeting_summary","ortho_summary"]},"audio":{"description":"Associated audio.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"patient":{"description":"Associated patient.","anyOf":[{"$ref":"#/components/schemas/Patient.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list"},{"type":"null"}]},"user":{"description":"Note owner.","$ref":"#/components/schemas/User.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list"},"createdAt":{"description":"Note creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Note last update date.","type":"string","format":"date-time"},"validatedAt":{"readOnly":true,"description":"Date the practitioner explicitly validated the note as-is, without editing its content.","type":["string","null"],"format":"date-time"},"contentModified":{"readOnly":true,"description":"Whether the note content was manually edited after AI generation.","type":"boolean"}}}},"components/schemas/Organization-organization.list":{"id":"components/schemas/Organization-organization.list","kind":"json-schema","title":"Organization-organization.list","data":{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"}}}},"components/schemas/Organization-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/Organization-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"Organization-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"},"users":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/User-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"}},"logo":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASK-3801 — le logo reste la premiere image SANS usage declare."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Image-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},{"type":"null"}]},"officePhotos":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASK-3801 — photos du cabinet publiees sur la fiche praticien. La PREMIERE"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sert de banniere au hero de la fiche (Figma 17758-33758)."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/Image-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"}}}}},"components/schemas/Organization-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/Organization-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"Organization-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"},"users":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/User-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"}}}}},"components/schemas/Organization-user.read_user.read_organizations_organization.read":{"id":"components/schemas/Organization-user.read_user.read_organizations_organization.read","kind":"json-schema","title":"Organization-user.read_user.read_organizations_organization.read","data":{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"}}}},"components/schemas/Organization.jsonld-organization.list":{"id":"components/schemas/Organization.jsonld-organization.list","kind":"json-schema","title":"Organization.jsonld-organization.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"}}}]}},"components/schemas/Organization.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/Organization.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"Organization.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"},"users":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/User.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"}},"logo":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASK-3801 — le logo reste la premiere image SANS usage declare."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Image.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},{"type":"null"}]},"officePhotos":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASK-3801 — photos du cabinet publiees sur la fiche praticien. La PREMIERE"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sert de banniere au hero de la fiche (Figma 17758-33758)."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/Image.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"}}}}]}},"components/schemas/Organization.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/Organization.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"Organization.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"},"users":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/User.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"}}}}]}},"components/schemas/Organization.jsonld-user.read_user.read_organizations_organization.read":{"id":"components/schemas/Organization.jsonld-user.read_user.read_organizations_organization.read","kind":"json-schema","title":"Organization.jsonld-user.read_user.read_organizations_organization.read","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"}}}]}},"components/schemas/Organization.multipart-organization.list":{"id":"components/schemas/Organization.multipart-organization.list","kind":"json-schema","title":"Organization.multipart-organization.list","data":{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"}}}},"components/schemas/Organization.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/Organization.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"Organization.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"},"users":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/User.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"}},"logo":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASK-3801 — le logo reste la premiere image SANS usage declare."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Image.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},{"type":"null"}]},"officePhotos":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASK-3801 — photos du cabinet publiees sur la fiche praticien. La PREMIERE"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sert de banniere au hero de la fiche (Figma 17758-33758)."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/Image.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"}}}}},"components/schemas/Organization.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/Organization.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"Organization.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"},"users":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/User.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"}}}}},"components/schemas/Organization.multipart-user.read_user.read_organizations_organization.read":{"id":"components/schemas/Organization.multipart-user.read_user.read_organizations_organization.read","kind":"json-schema","title":"Organization.multipart-user.read_user.read_organizations_organization.read","data":{"type":"object","properties":{"uuid":{"description":"Organization unique identifier.","type":["string","null"],"format":"uuid"},"name":{"description":"Organization name.","type":["string","null"]},"primaryColor":{"pattern":"^(.*(^#?[0-9a-fA-F]{3}$|^#?[0-9a-fA-F]{6}$).*)$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kiosk branding color, hex (3 or 6 digits, # optional)."},"children":[]}]}]}],"type":["string","null"]},"vatNumber":{"description":"Organization VAT number.","type":["string","null"]},"siret":{"description":"Organization SIRET number (14 digits).","type":["string","null"]},"finess":{"description":"Organization FINESS number.","type":["string","null"]},"streetAddress":{"description":"Organization street address.","type":"string"},"postalCode":{"description":"Organization postal code.","type":"string"},"city":{"description":"Organization city.","type":"string"},"country":{"description":"Organization country.","default":"FR","type":"string"},"latitude":{"description":"Organization latitude.","type":"number","example":10.6584},"longitude":{"description":"Organization longitude","type":"number","example":45.0124},"timezone":{"description":"Organization timezone","type":["string","null"],"example":"Europe/Paris"},"phone":{"description":"Organization phone number.","example":"+33757590893","type":["string","null"]},"secretariatEmail":{"format":"email","description":"Organization email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"website":{"format":"uri","description":"Organization website url.","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"dentalNomenclatureSystem":{"description":"Organization dental nomenclature system.","type":["string","null"],"enum":["fdi","ada",null]},"preferredCurrency":{"description":"Organization preferred billing currency.","type":["string","null"],"enum":["eur","usd",null]},"language":{"description":"Organization preferred language for invoices and communications.","default":"fr","type":"string"},"createdAt":{"description":"Organization creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Organization update date.","type":"string","format":"date-time"}}}},"components/schemas/Patient-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":{"id":"components/schemas/Patient-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","kind":"json-schema","title":"Patient-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","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User-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"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Patient-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Patient-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Patient-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Patient-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient-note.list_patient.list":{"id":"components/schemas/Patient-note.list_patient.list","kind":"json-schema","title":"Patient-note.list_patient.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/Patient-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"Patient-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User-note.read_note.read_audio_note.read_user_patient.list_user.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient-patient.create":{"id":"components/schemas/Patient-patient.create","kind":"json-schema","title":"Patient-patient.create","data":{"type":"object","required":["firstName","lastName"],"properties":{"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"externalId":{"description":"Patient external app identifier (must be a string).","type":["string","null"]},"externalCreatedAt":{"description":"Patient creation date from external app.","type":["string","null"],"format":"date-time"},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"maidenName":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"Moreau","type":["string","null"]},"notes":{"description":"Free-text practice notes about the patient record.","type":["string","null"]},"medicalAlert":{"description":"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)","type":["string","null"]},"referringPractitioner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal practitioner designated as this patient's referring practitioner (\"praticien référent\"). Must belong to the same organization as the patient."},"children":[]}]}]}],"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"treatingPhysician":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The patient's declared \"médecin traitant\" (GP registered with health insurance), as free text."},"children":[]}]}]}],"example":"Dr Martin Schmidt","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"customPrompt":{"description":"Custom AI prompt instructions for this patient.","type":["string","null"]},"socialSecurityNumber":{"description":"Patient French social security number (NIR, 15 characters).","example":"269054958815799","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Patient street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Patient postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Patient city.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]},"birthGivenNames":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Civil-status given names in order, the first being the birth first name. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which stays the name the patient goes by. Populated from the Vitale card when available."},"children":[]}]}]}],"example":["Marie","Claire"],"type":["array","null"],"items":{"type":"string"}},"birthPlaceCode":{"maxLength":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"75056","type":["string","null"]},"insMatricule":{"maxLength":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National health identity (INS) matricule. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"socialSecurityNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves."},"children":[]}]}]}],"example":"269054958815799","type":["string","null"]},"insOid":{"maxLength":32,"description":"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","type":["string","null"]}}}},"components/schemas/Patient-patient.list":{"id":"components/schemas/Patient-patient.list","kind":"json-schema","title":"Patient-patient.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient-patient.read_patient.read_record_user.minimal":{"id":"components/schemas/Patient-patient.read_patient.read_record_user.minimal","kind":"json-schema","title":"Patient-patient.read_patient.read_record_user.minimal","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User-patient.read_patient.read_record_user.minimal"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"maidenName":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"Moreau","type":["string","null"]},"notes":{"description":"Free-text practice notes about the patient record.","type":["string","null"]},"medicalAlert":{"description":"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)","type":["string","null"]},"referringPractitioner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal practitioner designated as this patient's referring practitioner (\"praticien référent\"). Must belong to the same organization as the patient."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/User-patient.read_patient.read_record_user.minimal"},{"type":"null"}]},"treatingPhysician":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The patient's declared \"médecin traitant\" (GP registered with health insurance), as free text."},"children":[]}]}]}],"example":"Dr Martin Schmidt","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Patient street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Patient postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Patient city.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"height":{"minimum":20,"maximum":280,"description":"Patient height in centimeters.","type":["integer","null"]},"weight":{"minimum":0.5,"maximum":500,"description":"Patient weight in kilograms.","type":["number","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]},"birthGivenNames":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Civil-status given names in order, the first being the birth first name. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which stays the name the patient goes by. Populated from the Vitale card when available."},"children":[]}]}]}],"example":["Marie","Claire"],"type":["array","null"],"items":{"type":"string"}},"birthPlaceCode":{"maxLength":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"75056","type":["string","null"]},"insMatricule":{"maxLength":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National health identity (INS) matricule. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"socialSecurityNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves."},"children":[]}]}]}],"example":"269054958815799","type":["string","null"]},"insOid":{"maxLength":32,"description":"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","type":["string","null"]},"insStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["string","null"],"enum":["provisional","validated","retrieved","qualified",null]},"insSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by construction."},"children":[]}]}]}],"type":["string","null"],"enum":["manual","vitale","insi","import",null]},"insQualifiedAt":{"description":"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.","type":["string","null"],"format":"date-time"},"insValidatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the identity traits were last checked against an identity document. Read-only — set by the validation endpoint."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"insValidationDocumentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which kind of high-trust identity document the traits were checked against. Read-only. The document number is never stored — the CNIL forbids it."},"children":[]}]}]}],"type":["string","null"],"enum":["national_id_card","passport","residence_permit","family_record_book","birth_certificate_extract","electronic_eidas_substantial","electronic_eidas_high",null]},"rightsVerified":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["boolean","null"]},"rightsVerifiedAt":{"description":"When the online rights check certified the coverage (ISO 8601). Null when rights were never verified online.","type":["string","null"]},"todo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":["postal_address_missing"],"type":["array","null"],"items":{"type":"string"}},"insiMissingTraits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":["sex"],"type":["array","null"],"items":{"type":"string"}},"insMatriculeType":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the INS matricule is, read from its OID: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nir"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a definitive identifier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nia"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a provisional one still awaiting a NIR. Null when the record carries no INS, or an OID outside the two documented namespaces."},"children":[]}]}]}],"example":"nir","type":["string","null"],"enum":["nir","nia",null]},"phones":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All phone numbers, primary first. The primary one is also served as the legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsCapable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true only for a number labelled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — reminders never target the others."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"null"}]}}},"emails":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All email addresses, primary first. The primary one is also served as the legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"null"}]}}}},"required":["firstName","lastName"]}},"components/schemas/Patient-patient.read_user.minimal":{"id":"components/schemas/Patient-patient.read_user.minimal","kind":"json-schema","title":"Patient-patient.read_user.minimal","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User-patient.read_user.minimal"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"maidenName":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"Moreau","type":["string","null"]},"notes":{"description":"Free-text practice notes about the patient record.","type":["string","null"]},"medicalAlert":{"description":"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)","type":["string","null"]},"referringPractitioner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal practitioner designated as this patient's referring practitioner (\"praticien référent\"). Must belong to the same organization as the patient."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/User-patient.read_user.minimal"},{"type":"null"}]},"treatingPhysician":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The patient's declared \"médecin traitant\" (GP registered with health insurance), as free text."},"children":[]}]}]}],"example":"Dr Martin Schmidt","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Patient street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Patient postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Patient city.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"height":{"minimum":20,"maximum":280,"description":"Patient height in centimeters.","type":["integer","null"]},"weight":{"minimum":0.5,"maximum":500,"description":"Patient weight in kilograms.","type":["number","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]},"birthGivenNames":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Civil-status given names in order, the first being the birth first name. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which stays the name the patient goes by. Populated from the Vitale card when available."},"children":[]}]}]}],"example":["Marie","Claire"],"type":["array","null"],"items":{"type":"string"}},"birthPlaceCode":{"maxLength":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"75056","type":["string","null"]},"insMatricule":{"maxLength":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National health identity (INS) matricule. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"socialSecurityNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves."},"children":[]}]}]}],"example":"269054958815799","type":["string","null"]},"insOid":{"maxLength":32,"description":"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","type":["string","null"]},"insStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["string","null"],"enum":["provisional","validated","retrieved","qualified",null]},"insSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by construction."},"children":[]}]}]}],"type":["string","null"],"enum":["manual","vitale","insi","import",null]},"insQualifiedAt":{"description":"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.","type":["string","null"],"format":"date-time"},"insValidatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the identity traits were last checked against an identity document. Read-only — set by the validation endpoint."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"insValidationDocumentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which kind of high-trust identity document the traits were checked against. Read-only. The document number is never stored — the CNIL forbids it."},"children":[]}]}]}],"type":["string","null"],"enum":["national_id_card","passport","residence_permit","family_record_book","birth_certificate_extract","electronic_eidas_substantial","electronic_eidas_high",null]},"insMatriculeType":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the INS matricule is, read from its OID: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nir"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a definitive identifier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nia"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a provisional one still awaiting a NIR. Null when the record carries no INS, or an OID outside the two documented namespaces."},"children":[]}]}]}],"example":"nir","type":["string","null"],"enum":["nir","nia",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient-patient.update.jsonMergePatch":{"id":"components/schemas/Patient-patient.update.jsonMergePatch","kind":"json-schema","title":"Patient-patient.update.jsonMergePatch","data":{"type":"object","properties":{"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"externalId":{"description":"Patient external app identifier (must be a string).","type":["string","null"]},"externalCreatedAt":{"description":"Patient creation date from external app.","type":["string","null"],"format":"date-time"},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"maidenName":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"Moreau","type":["string","null"]},"notes":{"description":"Free-text practice notes about the patient record.","type":["string","null"]},"medicalAlert":{"description":"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)","type":["string","null"]},"referringPractitioner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal practitioner designated as this patient's referring practitioner (\"praticien référent\"). Must belong to the same organization as the patient."},"children":[]}]}]}],"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"treatingPhysician":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The patient's declared \"médecin traitant\" (GP registered with health insurance), as free text."},"children":[]}]}]}],"example":"Dr Martin Schmidt","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"customPrompt":{"description":"Custom AI prompt instructions for this patient.","type":["string","null"]},"socialSecurityNumber":{"description":"Patient French social security number (NIR, 15 characters).","example":"269054958815799","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Patient street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Patient postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Patient city.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"height":{"minimum":20,"maximum":280,"description":"Patient height in centimeters.","type":["integer","null"]},"weight":{"minimum":0.5,"maximum":500,"description":"Patient weight in kilograms.","type":["number","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]},"birthGivenNames":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Civil-status given names in order, the first being the birth first name. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which stays the name the patient goes by. Populated from the Vitale card when available."},"children":[]}]}]}],"example":["Marie","Claire"],"type":["array","null"],"items":{"type":"string"}},"birthPlaceCode":{"maxLength":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"75056","type":["string","null"]},"insMatricule":{"maxLength":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National health identity (INS) matricule. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"socialSecurityNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves."},"children":[]}]}]}],"example":"269054958815799","type":["string","null"]},"insOid":{"maxLength":32,"description":"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","type":["string","null"]}}}},"components/schemas/Patient.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":{"id":"components/schemas/Patient.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","kind":"json-schema","title":"Patient.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","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.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"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}]}},"components/schemas/Patient.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Patient.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Patient.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}]}},"components/schemas/Patient.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Patient.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Patient.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}]}},"components/schemas/Patient.jsonld-note.list_patient.list":{"id":"components/schemas/Patient.jsonld-note.list_patient.list","kind":"json-schema","title":"Patient.jsonld-note.list_patient.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}]}},"components/schemas/Patient.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/Patient.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"Patient.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}]}},"components/schemas/Patient.jsonld-patient.list":{"id":"components/schemas/Patient.jsonld-patient.list","kind":"json-schema","title":"Patient.jsonld-patient.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}]}},"components/schemas/Patient.jsonld-patient.read_patient.read_record_user.minimal":{"id":"components/schemas/Patient.jsonld-patient.read_patient.read_record_user.minimal","kind":"json-schema","title":"Patient.jsonld-patient.read_patient.read_record_user.minimal","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.jsonld-patient.read_patient.read_record_user.minimal"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"maidenName":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"Moreau","type":["string","null"]},"notes":{"description":"Free-text practice notes about the patient record.","type":["string","null"]},"medicalAlert":{"description":"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)","type":["string","null"]},"referringPractitioner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal practitioner designated as this patient's referring practitioner (\"praticien référent\"). Must belong to the same organization as the patient."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/User.jsonld-patient.read_patient.read_record_user.minimal"},{"type":"null"}]},"treatingPhysician":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The patient's declared \"médecin traitant\" (GP registered with health insurance), as free text."},"children":[]}]}]}],"example":"Dr Martin Schmidt","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Patient street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Patient postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Patient city.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"height":{"minimum":20,"maximum":280,"description":"Patient height in centimeters.","type":["integer","null"]},"weight":{"minimum":0.5,"maximum":500,"description":"Patient weight in kilograms.","type":["number","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]},"birthGivenNames":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Civil-status given names in order, the first being the birth first name. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which stays the name the patient goes by. Populated from the Vitale card when available."},"children":[]}]}]}],"example":["Marie","Claire"],"type":["array","null"],"items":{"type":"string"}},"birthPlaceCode":{"maxLength":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"75056","type":["string","null"]},"insMatricule":{"maxLength":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National health identity (INS) matricule. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"socialSecurityNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves."},"children":[]}]}]}],"example":"269054958815799","type":["string","null"]},"insOid":{"maxLength":32,"description":"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","type":["string","null"]},"insStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["string","null"],"enum":["provisional","validated","retrieved","qualified",null]},"insSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by construction."},"children":[]}]}]}],"type":["string","null"],"enum":["manual","vitale","insi","import",null]},"insQualifiedAt":{"description":"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.","type":["string","null"],"format":"date-time"},"insValidatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the identity traits were last checked against an identity document. Read-only — set by the validation endpoint."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"insValidationDocumentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which kind of high-trust identity document the traits were checked against. Read-only. The document number is never stored — the CNIL forbids it."},"children":[]}]}]}],"type":["string","null"],"enum":["national_id_card","passport","residence_permit","family_record_book","birth_certificate_extract","electronic_eidas_substantial","electronic_eidas_high",null]},"rightsVerified":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["boolean","null"]},"rightsVerifiedAt":{"description":"When the online rights check certified the coverage (ISO 8601). Null when rights were never verified online.","type":["string","null"]},"todo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":["postal_address_missing"],"type":["array","null"],"items":{"type":"string"}},"insiMissingTraits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":["sex"],"type":["array","null"],"items":{"type":"string"}},"insMatriculeType":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the INS matricule is, read from its OID: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nir"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a definitive identifier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nia"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a provisional one still awaiting a NIR. Null when the record carries no INS, or an OID outside the two documented namespaces."},"children":[]}]}]}],"example":"nir","type":["string","null"],"enum":["nir","nia",null]},"phones":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All phone numbers, primary first. The primary one is also served as the legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsCapable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true only for a number labelled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — reminders never target the others."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"null"}]}}},"emails":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All email addresses, primary first. The primary one is also served as the legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"null"}]}}}},"required":["firstName","lastName"]}]}},"components/schemas/Patient.jsonld-patient.read_user.minimal":{"id":"components/schemas/Patient.jsonld-patient.read_user.minimal","kind":"json-schema","title":"Patient.jsonld-patient.read_user.minimal","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.jsonld-patient.read_user.minimal"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"maidenName":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"Moreau","type":["string","null"]},"notes":{"description":"Free-text practice notes about the patient record.","type":["string","null"]},"medicalAlert":{"description":"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)","type":["string","null"]},"referringPractitioner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal practitioner designated as this patient's referring practitioner (\"praticien référent\"). Must belong to the same organization as the patient."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/User.jsonld-patient.read_user.minimal"},{"type":"null"}]},"treatingPhysician":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The patient's declared \"médecin traitant\" (GP registered with health insurance), as free text."},"children":[]}]}]}],"example":"Dr Martin Schmidt","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Patient street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Patient postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Patient city.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"height":{"minimum":20,"maximum":280,"description":"Patient height in centimeters.","type":["integer","null"]},"weight":{"minimum":0.5,"maximum":500,"description":"Patient weight in kilograms.","type":["number","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]},"birthGivenNames":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Civil-status given names in order, the first being the birth first name. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which stays the name the patient goes by. Populated from the Vitale card when available."},"children":[]}]}]}],"example":["Marie","Claire"],"type":["array","null"],"items":{"type":"string"}},"birthPlaceCode":{"maxLength":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"75056","type":["string","null"]},"insMatricule":{"maxLength":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National health identity (INS) matricule. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"socialSecurityNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves."},"children":[]}]}]}],"example":"269054958815799","type":["string","null"]},"insOid":{"maxLength":32,"description":"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","type":["string","null"]},"insStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["string","null"],"enum":["provisional","validated","retrieved","qualified",null]},"insSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by construction."},"children":[]}]}]}],"type":["string","null"],"enum":["manual","vitale","insi","import",null]},"insQualifiedAt":{"description":"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.","type":["string","null"],"format":"date-time"},"insValidatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the identity traits were last checked against an identity document. Read-only — set by the validation endpoint."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"insValidationDocumentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which kind of high-trust identity document the traits were checked against. Read-only. The document number is never stored — the CNIL forbids it."},"children":[]}]}]}],"type":["string","null"],"enum":["national_id_card","passport","residence_permit","family_record_book","birth_certificate_extract","electronic_eidas_substantial","electronic_eidas_high",null]},"insMatriculeType":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the INS matricule is, read from its OID: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nir"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a definitive identifier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nia"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a provisional one still awaiting a NIR. Null when the record carries no INS, or an OID outside the two documented namespaces."},"children":[]}]}]}],"example":"nir","type":["string","null"],"enum":["nir","nia",null]}},"required":["firstName","lastName"]}]}},"components/schemas/Patient.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":{"id":"components/schemas/Patient.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","kind":"json-schema","title":"Patient.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","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.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"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Patient.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Patient.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Patient.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Patient.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient.multipart-note.list_patient.list":{"id":"components/schemas/Patient.multipart-note.list_patient.list","kind":"json-schema","title":"Patient.multipart-note.list_patient.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/Patient.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"Patient.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient.multipart-patient.list":{"id":"components/schemas/Patient.multipart-patient.list","kind":"json-schema","title":"Patient.multipart-patient.list","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]}},"required":["firstName","lastName"]}},"components/schemas/Patient.multipart-patient.read_patient.read_record_user.minimal":{"id":"components/schemas/Patient.multipart-patient.read_patient.read_record_user.minimal","kind":"json-schema","title":"Patient.multipart-patient.read_patient.read_record_user.minimal","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.multipart-patient.read_patient.read_record_user.minimal"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"maidenName":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"Moreau","type":["string","null"]},"notes":{"description":"Free-text practice notes about the patient record.","type":["string","null"]},"medicalAlert":{"description":"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)","type":["string","null"]},"referringPractitioner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal practitioner designated as this patient's referring practitioner (\"praticien référent\"). Must belong to the same organization as the patient."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/User.multipart-patient.read_patient.read_record_user.minimal"},{"type":"null"}]},"treatingPhysician":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The patient's declared \"médecin traitant\" (GP registered with health insurance), as free text."},"children":[]}]}]}],"example":"Dr Martin Schmidt","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Patient street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Patient postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Patient city.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"height":{"minimum":20,"maximum":280,"description":"Patient height in centimeters.","type":["integer","null"]},"weight":{"minimum":0.5,"maximum":500,"description":"Patient weight in kilograms.","type":["number","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]},"birthGivenNames":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Civil-status given names in order, the first being the birth first name. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which stays the name the patient goes by. Populated from the Vitale card when available."},"children":[]}]}]}],"example":["Marie","Claire"],"type":["array","null"],"items":{"type":"string"}},"birthPlaceCode":{"maxLength":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"75056","type":["string","null"]},"insMatricule":{"maxLength":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National health identity (INS) matricule. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"socialSecurityNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves."},"children":[]}]}]}],"example":"269054958815799","type":["string","null"]},"insOid":{"maxLength":32,"description":"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","type":["string","null"]},"insStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["string","null"],"enum":["provisional","validated","retrieved","qualified",null]},"insSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by construction."},"children":[]}]}]}],"type":["string","null"],"enum":["manual","vitale","insi","import",null]},"insQualifiedAt":{"description":"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.","type":["string","null"],"format":"date-time"},"insValidatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the identity traits were last checked against an identity document. Read-only — set by the validation endpoint."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"insValidationDocumentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which kind of high-trust identity document the traits were checked against. Read-only. The document number is never stored — the CNIL forbids it."},"children":[]}]}]}],"type":["string","null"],"enum":["national_id_card","passport","residence_permit","family_record_book","birth_certificate_extract","electronic_eidas_substantial","electronic_eidas_high",null]},"rightsVerified":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["boolean","null"]},"rightsVerifiedAt":{"description":"When the online rights check certified the coverage (ISO 8601). Null when rights were never verified online.","type":["string","null"]},"todo":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":["postal_address_missing"],"type":["array","null"],"items":{"type":"string"}},"insiMissingTraits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":["sex"],"type":["array","null"],"items":{"type":"string"}},"insMatriculeType":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the INS matricule is, read from its OID: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nir"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a definitive identifier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nia"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a provisional one still awaiting a NIR. Null when the record carries no INS, or an OID outside the two documented namespaces."},"children":[]}]}]}],"example":"nir","type":["string","null"],"enum":["nir","nia",null]},"phones":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All phone numbers, primary first. The primary one is also served as the legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsCapable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true only for a number labelled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — reminders never target the others."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"null"}]}}},"emails":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All email addresses, primary first. The primary one is also served as the legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"null"}]}}}},"required":["firstName","lastName"]}},"components/schemas/Patient.multipart-patient.read_user.minimal":{"id":"components/schemas/Patient.multipart-patient.read_user.minimal","kind":"json-schema","title":"Patient.multipart-patient.read_user.minimal","data":{"type":"object","properties":{"uuid":{"description":"Patient unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"Patient first name.","type":["string","null"]},"lastName":{"description":"Patient last name.","type":["string","null"]},"languageSpoken":{"description":"Patient language.","type":"string"},"createdAt":{"description":"Patient creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Patient update date.","type":"string","format":"date-time"},"synchronizedAt":{"description":"Patient synchronization date.","type":["string","null"],"format":"date-time"},"dateOfBirth":{"description":"Patient date of birth. Must be strictly before today.","type":["string","null"],"format":"date-time"},"gender":{"description":"Patient gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"user":{"description":"Patient author.","anyOf":[{"$ref":"#/components/schemas/User.multipart-patient.read_user.minimal"},{"type":"null"}]},"visibilityOption":{"default":"shared","type":["string","null"],"enum":["shared","private",null]},"email":{"format":"email","description":"Patient email address.","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"phone":{"description":"Patient phone number.","example":"+33757590893","type":["string","null"]},"maidenName":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"Moreau","type":["string","null"]},"notes":{"description":"Free-text practice notes about the patient record.","type":["string","null"]},"medicalAlert":{"description":"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)","type":["string","null"]},"referringPractitioner":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal practitioner designated as this patient's referring practitioner (\"praticien référent\"). Must belong to the same organization as the patient."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/User.multipart-patient.read_user.minimal"},{"type":"null"}]},"treatingPhysician":{"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The patient's declared \"médecin traitant\" (GP registered with health insurance), as free text."},"children":[]}]}]}],"example":"Dr Martin Schmidt","type":["string","null"]},"anonymousCode":{"maxLength":15,"description":"Patient anonymous code.","type":["string","null"]},"streetAddress":{"maxLength":255,"description":"Patient street address.","type":["string","null"]},"postalCode":{"maxLength":10,"description":"Patient postal code.","type":["string","null"]},"city":{"maxLength":255,"description":"Patient city.","type":["string","null"]},"recordNumber":{"maxLength":255,"description":"Patient record/folder number from the source software (e.g. Logosw).","type":["string","null"]},"height":{"minimum":20,"maximum":280,"description":"Patient height in centimeters.","type":["integer","null"]},"weight":{"minimum":0.5,"maximum":500,"description":"Patient weight in kilograms.","type":["number","null"]},"civility":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a patient who is a doctor is addressed \"Dr\" whatever their gender."},"children":[]}]}]}],"type":["string","null"],"enum":["mr","mrs","dr","pr","none",null]},"birthGivenNames":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Civil-status given names in order, the first being the birth first name. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which stays the name the patient goes by. Populated from the Vitale card when available."},"children":[]}]}]}],"example":["Marie","Claire"],"type":["array","null"],"items":{"type":"string"}},"birthPlaceCode":{"maxLength":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":"75056","type":["string","null"]},"insMatricule":{"maxLength":15,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National health identity (INS) matricule. Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"socialSecurityNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the NIR is the number the patient is covered under and may belong to a parent, the INS identifies the patient themselves."},"children":[]}]}]}],"example":"269054958815799","type":["string","null"]},"insOid":{"maxLength":32,"description":"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","type":["string","null"]},"insStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"type":["string","null"],"enum":["provisional","validated","retrieved","qualified",null]},"insSource":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by construction."},"children":[]}]}]}],"type":["string","null"],"enum":["manual","vitale","insi","import",null]},"insQualifiedAt":{"description":"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.","type":["string","null"],"format":"date-time"},"insValidatedAt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the identity traits were last checked against an identity document. Read-only — set by the validation endpoint."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"insValidationDocumentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which kind of high-trust identity document the traits were checked against. Read-only. The document number is never stored — the CNIL forbids it."},"children":[]}]}]}],"type":["string","null"],"enum":["national_id_card","passport","residence_permit","family_record_book","birth_certificate_extract","electronic_eidas_substantial","electronic_eidas_high",null]},"insMatriculeType":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the INS matricule is, read from its OID: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nir"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a definitive identifier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nia"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a provisional one still awaiting a NIR. Null when the record carries no INS, or an OID outside the two documented namespaces."},"children":[]}]}]}],"example":"nir","type":["string","null"],"enum":["nir","nia",null]}},"required":["firstName","lastName"]}},"components/schemas/Pdf-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":{"id":"components/schemas/Pdf-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","kind":"json-schema","title":"Pdf-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","data":{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}},"components/schemas/Pdf-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Pdf-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Pdf-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}},"components/schemas/Pdf-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Pdf-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Pdf-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}},"components/schemas/Pdf.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":{"id":"components/schemas/Pdf.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","kind":"json-schema","title":"Pdf.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","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}]}},"components/schemas/Pdf.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Pdf.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Pdf.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}]}},"components/schemas/Pdf.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Pdf.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Pdf.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}]}},"components/schemas/Pdf.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":{"id":"components/schemas/Pdf.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","kind":"json-schema","title":"Pdf.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","data":{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}},"components/schemas/Pdf.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Pdf.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Pdf.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}},"components/schemas/Pdf.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/Pdf.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"Pdf.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"PDF unique identifier.","type":"string","format":"uuid"},"name":{"description":"PDF name.","type":["string","null"]},"size":{"description":"PDF size.","type":["integer","null"]},"createdAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"PDF creation date.","type":"string","format":"date-time"},"url":{"description":"PDF file URL.","type":["string","null"]},"fileName":{"description":"PDF file name.","type":["string","null"]}}}},"components/schemas/User-audio.list_audio.read_user_user.list":{"id":"components/schemas/User-audio.list_audio.read_user_user.list","kind":"json-schema","title":"User-audio.list_audio.read_user_user.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User-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":{"id":"components/schemas/User-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","kind":"json-schema","title":"User-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","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/User-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"User-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/User-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"User-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/User-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"User-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/User-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"User-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"organizationRole":{"description":"User role in the organization.","type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"avatar":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Practitioner avatar (ASK-3481, §4.4) — intrinsic to the person, reused"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"everywhere (agenda day view, appointment cards, public booking pages):"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no double upload for a multi-practice practitioner. Editorial public"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"content lives in PractitionerProfile instead."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Image-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},{"type":"null"}]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User-patient.read_patient.read_record_user.minimal":{"id":"components/schemas/User-patient.read_patient.read_record_user.minimal","kind":"json-schema","title":"User-patient.read_patient.read_record_user.minimal","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["firstName","lastName"]}},"components/schemas/User-patient.read_user.minimal":{"id":"components/schemas/User-patient.read_user.minimal","kind":"json-schema","title":"User-patient.read_user.minimal","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["firstName","lastName"]}},"components/schemas/User-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/User-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"User-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"organizationRole":{"description":"User role in the organization.","type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"professionCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Healthcare profession code from PSC (e.g. 40 = chirurgien-dentiste)."},"children":[]}]}]}],"type":["string","null"]},"professionLabel":{"description":"Healthcare profession label (e.g. Chirurgien-dentiste).","type":["string","null"]},"language":{"description":"User interface language.","default":"fr","type":"string"},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User-user.read_user.read_organizations_organization.read":{"id":"components/schemas/User-user.read_user.read_organizations_organization.read","kind":"json-schema","title":"User-user.read_user.read_organizations_organization.read","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"professionCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Healthcare profession code from PSC (e.g. 40 = chirurgien-dentiste)."},"children":[]}]}]}],"type":["string","null"]},"professionLabel":{"description":"Healthcare profession label (e.g. Chirurgien-dentiste).","type":["string","null"]},"language":{"description":"User interface language.","default":"fr","type":"string"},"organizations":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Organization-user.read_user.read_organizations_organization.read"}},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User.CurrentUserResponseDto-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/User.CurrentUserResponseDto-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"User.CurrentUserResponseDto-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"type":"object","properties":{"uuid":{"type":["string","null"],"format":"uuid"},"email":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"gender":{"type":["string","null"],"enum":["female","male","unknown",null]},"isVerified":{"type":["boolean","null"]},"phone":{"type":["string","null"]},"rpps":{"type":["string","null"]},"am":{"type":["string","null"]},"language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"languageSpokenAutoDetect":{"type":["boolean","null"]},"languageSpoken":{"type":["string","null"]},"languageDocument":{"type":["string","null"]},"organization":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The practice the user is currently acting in: the practice that receives the data created or updated by requests. It follows the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Organization-Uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header when the client sends it."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Organization-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"},{"type":"null"}]},"organizationRole":{"type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"isOrganizationAdmin":{"default":false,"type":"boolean"}}}},"components/schemas/User.CurrentUserResponseDto.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/User.CurrentUserResponseDto.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"User.CurrentUserResponseDto.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"type":["string","null"],"format":"uuid"},"email":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"gender":{"type":["string","null"],"enum":["female","male","unknown",null]},"isVerified":{"type":["boolean","null"]},"phone":{"type":["string","null"]},"rpps":{"type":["string","null"]},"am":{"type":["string","null"]},"language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"languageSpokenAutoDetect":{"type":["boolean","null"]},"languageSpoken":{"type":["string","null"]},"languageDocument":{"type":["string","null"]},"organization":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The practice the user is currently acting in: the practice that receives the data created or updated by requests. It follows the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Organization-Uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header when the client sends it."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Organization.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"},{"type":"null"}]},"organizationRole":{"type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"isOrganizationAdmin":{"default":false,"type":"boolean"}}}]}},"components/schemas/User.CurrentUserResponseDto.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/User.CurrentUserResponseDto.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"User.CurrentUserResponseDto.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"type":"object","properties":{"uuid":{"type":["string","null"],"format":"uuid"},"email":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"gender":{"type":["string","null"],"enum":["female","male","unknown",null]},"isVerified":{"type":["boolean","null"]},"phone":{"type":["string","null"]},"rpps":{"type":["string","null"]},"am":{"type":["string","null"]},"language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"languageSpokenAutoDetect":{"type":["boolean","null"]},"languageSpoken":{"type":["string","null"]},"languageDocument":{"type":["string","null"]},"organization":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The practice the user is currently acting in: the practice that receives the data created or updated by requests. It follows the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Organization-Uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header when the client sends it."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Organization.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role"},{"type":"null"}]},"organizationRole":{"type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"isOrganizationAdmin":{"default":false,"type":"boolean"}}}},"components/schemas/User.jsonld-audio.list_audio.read_user_user.list":{"id":"components/schemas/User.jsonld-audio.list_audio.read_user_user.list","kind":"json-schema","title":"User.jsonld-audio.list_audio.read_user_user.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}]}},"components/schemas/User.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":{"id":"components/schemas/User.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","kind":"json-schema","title":"User.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","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}]}},"components/schemas/User.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/User.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"User.jsonld-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}]}},"components/schemas/User.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/User.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"User.jsonld-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}]}},"components/schemas/User.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/User.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"User.jsonld-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}]}},"components/schemas/User.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/User.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"User.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"organizationRole":{"description":"User role in the organization.","type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"avatar":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Practitioner avatar (ASK-3481, §4.4) — intrinsic to the person, reused"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"everywhere (agenda day view, appointment cards, public booking pages):"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no double upload for a multi-practice practitioner. Editorial public"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"content lives in PractitionerProfile instead."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Image.jsonld-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},{"type":"null"}]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}]}},"components/schemas/User.jsonld-patient.read_patient.read_record_user.minimal":{"id":"components/schemas/User.jsonld-patient.read_patient.read_record_user.minimal","kind":"json-schema","title":"User.jsonld-patient.read_patient.read_record_user.minimal","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["firstName","lastName"]}]}},"components/schemas/User.jsonld-patient.read_user.minimal":{"id":"components/schemas/User.jsonld-patient.read_user.minimal","kind":"json-schema","title":"User.jsonld-patient.read_user.minimal","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["firstName","lastName"]}]}},"components/schemas/User.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/User.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"User.jsonld-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"organizationRole":{"description":"User role in the organization.","type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"professionCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Healthcare profession code from PSC (e.g. 40 = chirurgien-dentiste)."},"children":[]}]}]}],"type":["string","null"]},"professionLabel":{"description":"Healthcare profession label (e.g. Chirurgien-dentiste).","type":["string","null"]},"language":{"description":"User interface language.","default":"fr","type":"string"},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}]}},"components/schemas/User.jsonld-user.read_user.read_organizations_organization.read":{"id":"components/schemas/User.jsonld-user.read_user.read_organizations_organization.read","kind":"json-schema","title":"User.jsonld-user.read_user.read_organizations_organization.read","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"professionCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Healthcare profession code from PSC (e.g. 40 = chirurgien-dentiste)."},"children":[]}]}]}],"type":["string","null"]},"professionLabel":{"description":"Healthcare profession label (e.g. Chirurgien-dentiste).","type":["string","null"]},"language":{"description":"User interface language.","default":"fr","type":"string"},"organizations":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Organization.jsonld-user.read_user.read_organizations_organization.read"}},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}]}},"components/schemas/User.multipart-audio.list_audio.read_user_user.list":{"id":"components/schemas/User.multipart-audio.list_audio.read_user_user.list","kind":"json-schema","title":"User.multipart-audio.list_audio.read_user_user.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User.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":{"id":"components/schemas/User.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","kind":"json-schema","title":"User.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","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/User.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"User.multipart-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list":{"id":"components/schemas/User.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","kind":"json-schema","title":"User.multipart-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list":{"id":"components/schemas/User.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list","kind":"json-schema","title":"User.multipart-note.read_note.read_audio_note.read_user_patient.list_user.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list":{"id":"components/schemas/User.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","kind":"json-schema","title":"User.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"organizationRole":{"description":"User role in the organization.","type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"avatar":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Practitioner avatar (ASK-3481, §4.4) — intrinsic to the person, reused"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"everywhere (agenda day view, appointment cards, public booking pages):"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no double upload for a multi-practice practitioner. Editorial public"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"content lives in PractitionerProfile instead."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/Image.multipart-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_user.read_avatar_image.list"},{"type":"null"}]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User.multipart-patient.read_patient.read_record_user.minimal":{"id":"components/schemas/User.multipart-patient.read_patient.read_record_user.minimal","kind":"json-schema","title":"User.multipart-patient.read_patient.read_record_user.minimal","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["firstName","lastName"]}},"components/schemas/User.multipart-patient.read_user.minimal":{"id":"components/schemas/User.multipart-patient.read_user.minimal","kind":"json-schema","title":"User.multipart-patient.read_user.minimal","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["firstName","lastName"]}},"components/schemas/User.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role":{"id":"components/schemas/User.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","kind":"json-schema","title":"User.multipart-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"organizationRole":{"description":"User role in the organization.","type":["string","null"],"enum":["ROLE_ORGANIZATION_ADMIN","ROLE_ORGANIZATION_MEMBER",null]},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"professionCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Healthcare profession code from PSC (e.g. 40 = chirurgien-dentiste)."},"children":[]}]}]}],"type":["string","null"]},"professionLabel":{"description":"Healthcare profession label (e.g. Chirurgien-dentiste).","type":["string","null"]},"language":{"description":"User interface language.","default":"fr","type":"string"},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/User.multipart-user.read_user.read_organizations_organization.read":{"id":"components/schemas/User.multipart-user.read_user.read_organizations_organization.read","kind":"json-schema","title":"User.multipart-user.read_user.read_organizations_organization.read","data":{"type":"object","properties":{"uuid":{"description":"User unique identifier.","type":"string","format":"uuid"},"email":{"format":"email","description":"User email address.","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"createdAt":{"description":"User creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"User update date.","type":"string","format":"date-time"},"firstName":{"description":"User first name.","type":["string","null"]},"lastName":{"description":"User last name.","type":["string","null"]},"gender":{"description":"User gender.","default":"unknown","type":["string","null"],"enum":["female","male","unknown",null]},"phone":{"description":"User phone number.","example":"+33757590893","type":["string","null"]},"rpps":{"maxLength":20,"pattern":"^([A-Za-z0-9]+)$","description":"User RPPS number (France).","example":"10101748050","type":["string","null"]},"am":{"minLength":9,"maxLength":9,"pattern":"^(\\d+)$","description":"User AM number (France).","example":"394003552","type":["string","null"]},"professionCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Healthcare profession code from PSC (e.g. 40 = chirurgien-dentiste)."},"children":[]}]}]}],"type":["string","null"]},"professionLabel":{"description":"Healthcare profession label (e.g. Chirurgien-dentiste).","type":["string","null"]},"language":{"description":"User interface language.","default":"fr","type":"string"},"organizations":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Organization.multipart-user.read_user.read_organizations_organization.read"}},"isConventionne":{"readOnly":true,"description":"Whether the practitioner is \"conventionne\" (national administrative fact, sourced from the Ameli extract). Read-only.","type":"boolean"}},"required":["email","firstName","lastName"]}},"components/schemas/Webhook":{"id":"components/schemas/Webhook","kind":"json-schema","title":"Webhook","data":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"user":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"url":{"maxLength":500,"format":"uri","externalDocs":{"url":"https://schema.org/url"},"type":"string"},"secret":{"type":["string","null"]},"certificateVerificationDisabled":{"type":["boolean","null"]},"enabled":{"default":true,"type":"boolean"},"subscriptions":{"description":"Webhook subscriptions.","type":"array","items":{"type":"string","enum":["new_document","new_patient","new_contact","new_note","document_synchronize"],"example":"new_document"}},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"},"messages":{"description":"Webhook messages.","type":"array","items":{"$ref":"#/components/schemas/WebhookMessage"}},"subscriptionsAsStrings":{"type":["array","null"],"items":{"type":["string","null"]}}},"required":["url"]}},"components/schemas/Webhook-webhook.list":{"id":"components/schemas/Webhook-webhook.list","kind":"json-schema","title":"Webhook-webhook.list","data":{"type":"object","properties":{"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"user":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"enabled":{"default":true,"type":"boolean"},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"}}}},"components/schemas/Webhook-webhook.read":{"id":"components/schemas/Webhook-webhook.read","kind":"json-schema","title":"Webhook-webhook.read","data":{"type":"object","properties":{"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"user":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"url":{"maxLength":500,"format":"uri","externalDocs":{"url":"https://schema.org/url"},"type":"string"},"secret":{"type":["string","null"]},"certificateVerificationDisabled":{"type":["boolean","null"]},"enabled":{"default":true,"type":"boolean"},"subscriptions":{"description":"Webhook subscriptions.","type":"array","items":{"type":"string","enum":["new_document","new_patient","new_contact","new_note","document_synchronize"],"example":"new_document"}},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"}},"required":["url"]}},"components/schemas/Webhook-webhook.update.jsonMergePatch":{"id":"components/schemas/Webhook-webhook.update.jsonMergePatch","kind":"json-schema","title":"Webhook-webhook.update.jsonMergePatch","data":{"type":"object","properties":{"url":{"maxLength":500,"format":"uri","externalDocs":{"url":"https://schema.org/url"},"type":"string"},"enabled":{"default":true,"type":"boolean"},"subscriptions":{"description":"Webhook subscriptions.","type":"array","items":{"type":"string","enum":["new_document","new_patient","new_contact","new_note","document_synchronize"],"example":"new_document"}}}}},"components/schemas/Webhook.WebhookCreateDto-webhook.create":{"id":"components/schemas/Webhook.WebhookCreateDto-webhook.create","kind":"json-schema","title":"Webhook.WebhookCreateDto-webhook.create","data":{"type":"object","required":["url","subscriptions"],"properties":{"url":{"format":"uri","externalDocs":{"url":"https://schema.org/url"},"type":["string","null"]},"subscriptions":{"type":["string","null"]}}}},"components/schemas/Webhook.jsonld":{"id":"components/schemas/Webhook.jsonld","kind":"json-schema","title":"Webhook.jsonld","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"user":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"url":{"maxLength":500,"format":"uri","externalDocs":{"url":"https://schema.org/url"},"type":"string"},"secret":{"type":["string","null"]},"certificateVerificationDisabled":{"type":["boolean","null"]},"enabled":{"default":true,"type":"boolean"},"subscriptions":{"description":"Webhook subscriptions.","type":"array","items":{"type":"string","enum":["new_document","new_patient","new_contact","new_note","document_synchronize"],"example":"new_document"}},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"},"messages":{"description":"Webhook messages.","type":"array","items":{"$ref":"#/components/schemas/WebhookMessage.jsonld"}},"subscriptionsAsStrings":{"type":["array","null"],"items":{"type":["string","null"]}}},"required":["url"]}]}},"components/schemas/Webhook.jsonld-webhook.list":{"id":"components/schemas/Webhook.jsonld-webhook.list","kind":"json-schema","title":"Webhook.jsonld-webhook.list","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"user":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"enabled":{"default":true,"type":"boolean"},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"}}}]}},"components/schemas/Webhook.jsonld-webhook.read":{"id":"components/schemas/Webhook.jsonld-webhook.read","kind":"json-schema","title":"Webhook.jsonld-webhook.read","data":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"user":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"url":{"maxLength":500,"format":"uri","externalDocs":{"url":"https://schema.org/url"},"type":"string"},"secret":{"type":["string","null"]},"certificateVerificationDisabled":{"type":["boolean","null"]},"enabled":{"default":true,"type":"boolean"},"subscriptions":{"description":"Webhook subscriptions.","type":"array","items":{"type":"string","enum":["new_document","new_patient","new_contact","new_note","document_synchronize"],"example":"new_document"}},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"}},"required":["url"]}]}},"components/schemas/Webhook.multipart":{"id":"components/schemas/Webhook.multipart","kind":"json-schema","title":"Webhook.multipart","data":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"user":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"url":{"maxLength":500,"format":"uri","externalDocs":{"url":"https://schema.org/url"},"type":"string"},"secret":{"type":["string","null"]},"certificateVerificationDisabled":{"type":["boolean","null"]},"enabled":{"default":true,"type":"boolean"},"subscriptions":{"description":"Webhook subscriptions.","type":"array","items":{"type":"string","enum":["new_document","new_patient","new_contact","new_note","document_synchronize"],"example":"new_document"}},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"},"messages":{"description":"Webhook messages.","type":"array","items":{"$ref":"#/components/schemas/WebhookMessage.multipart"}},"subscriptionsAsStrings":{"type":["array","null"],"items":{"type":["string","null"]}}},"required":["url"]}},"components/schemas/Webhook.multipart-webhook.list":{"id":"components/schemas/Webhook.multipart-webhook.list","kind":"json-schema","title":"Webhook.multipart-webhook.list","data":{"type":"object","properties":{"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"user":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"enabled":{"default":true,"type":"boolean"},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"}}}},"components/schemas/Webhook.multipart-webhook.read":{"id":"components/schemas/Webhook.multipart-webhook.read","kind":"json-schema","title":"Webhook.multipart-webhook.read","data":{"type":"object","properties":{"uuid":{"description":"Webhook unique identifier.","type":["string","null"],"format":"uuid"},"organization":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"user":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"url":{"maxLength":500,"format":"uri","externalDocs":{"url":"https://schema.org/url"},"type":"string"},"secret":{"type":["string","null"]},"certificateVerificationDisabled":{"type":["boolean","null"]},"enabled":{"default":true,"type":"boolean"},"subscriptions":{"description":"Webhook subscriptions.","type":"array","items":{"type":"string","enum":["new_document","new_patient","new_contact","new_note","document_synchronize"],"example":"new_document"}},"createdAt":{"description":"Webhook creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook update date.","type":"string","format":"date-time"}},"required":["url"]}},"components/schemas/WebhookMessage":{"id":"components/schemas/WebhookMessage","kind":"json-schema","title":"WebhookMessage","data":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"uuid":{"description":"Webhook message unique identifier.","type":["string","null"],"format":"uuid"},"webhook":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"url":{"type":["string","null"]},"requestHeaders":{"type":["array","null"],"items":{"type":["string","null"]}},"requestBody":{"type":["string","null"]},"responseHeaders":{"type":["array","null"],"items":{"type":["string","null"]}},"responseBody":{"type":["string","null"]},"responseCode":{"type":["integer","null"]},"responseDuration":{"type":["number","null"]},"success":{"type":["boolean","null"]},"error":{"type":["string","null"]},"createdAt":{"description":"Webhook message creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook message update date.","type":"string","format":"date-time"}}}},"components/schemas/WebhookMessage.jsonld":{"id":"components/schemas/WebhookMessage.jsonld","kind":"json-schema","title":"WebhookMessage.jsonld","data":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"uuid":{"description":"Webhook message unique identifier.","type":["string","null"],"format":"uuid"},"webhook":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"url":{"type":["string","null"]},"requestHeaders":{"type":["array","null"],"items":{"type":["string","null"]}},"requestBody":{"type":["string","null"]},"responseHeaders":{"type":["array","null"],"items":{"type":["string","null"]}},"responseBody":{"type":["string","null"]},"responseCode":{"type":["integer","null"]},"responseDuration":{"type":["number","null"]},"success":{"type":["boolean","null"]},"error":{"type":["string","null"]},"createdAt":{"description":"Webhook message creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook message update date.","type":"string","format":"date-time"}}}},"components/schemas/WebhookMessage.multipart":{"id":"components/schemas/WebhookMessage.multipart","kind":"json-schema","title":"WebhookMessage.multipart","data":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"uuid":{"description":"Webhook message unique identifier.","type":["string","null"],"format":"uuid"},"webhook":{"type":["string","null"],"format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"url":{"type":["string","null"]},"requestHeaders":{"type":["array","null"],"items":{"type":["string","null"]}},"requestBody":{"type":["string","null"]},"responseHeaders":{"type":["array","null"],"items":{"type":["string","null"]}},"responseBody":{"type":["string","null"]},"responseCode":{"type":["integer","null"]},"responseDuration":{"type":["number","null"]},"success":{"type":["boolean","null"]},"error":{"type":["string","null"]},"createdAt":{"description":"Webhook message creation date.","type":"string","format":"date-time"},"updatedAt":{"description":"Webhook message update date.","type":"string","format":"date-time"}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer","default":20,"minimum":0,"maximum":100},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["patient.read","patient.list"]}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["audio_recording","transcription","transcribed","edition","validated","failed"]}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Audio-audio.list_audio.read_user_user.list"}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audio.jsonld-audio.list_audio.read_user_user.list collection."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Audio.jsonld-audio.list_audio.read_user_user.list"}}}}]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Audio.multipart-audio.list_audio.read_user_user.list"}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["contact.list_derived"]}},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Contact-contact.list"}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","description":"Contact.jsonld-contact.list collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Contact.jsonld-contact.list"}}}}]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Contact.multipart-contact.list"}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["user.read","user.list","document.read_patient","patient.read","patient.list","pdf.list","pdf.read"]}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["sent","received","opened"]}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal collection."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Document.jsonld-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}}}}]},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document.multipart-document.list_document.read_pdf_document.read_patient_document.read_emails_status_email.status_document.read_document_contacts_document_contact.minimal_contact.minimal"}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Note-note.list_patient.list"}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note.jsonld-note.list_patient.list collection."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Note.jsonld-note.list_patient.list"}}}}]},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Note.multipart-note.list_patient.list"}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["user.list","user.read","organization.read_webhooks","webhook.read","webhook.list"]}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Organization-organization.list"}},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","description":"Organization.jsonld-organization.list collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Organization.jsonld-organization.list"}}}}]},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Organization.multipart-organization.list"}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["patient.list_derived"]}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Patient-patient.list"}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"object","description":"Patient.jsonld-patient.list collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Patient.jsonld-patient.list"}}}}]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Patient.multipart-patient.list"}},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Webhook-webhook.list"}},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"object","description":"Webhook.jsonld-webhook.list collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Webhook.jsonld-webhook.list"}}}}]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Webhook.multipart-webhook.list"}},"id":"schema_32"}},"exampleStore":{},"securitySchemeStore":{"oauth_auth_code":{"id":"oauth_auth_code","type":"oauth2","description":"OAuth 2.0 Authorization Code Grant","flows":{"authorizationCode":{"authorizationUrl":"https://app.askara.ai/authorize","tokenUrl":"https://api.askara.ai/oauth2/token","refreshUrl":"https://api.askara.ai/oauth2/token","scopes":{"profile":"Access to user account information","organization":"Access to dental practice information","read:patients":"Access to patient information","write:patients":"Create/update/delete patients","read:contacts":"Access to contact information","write:contacts":"Create/update/delete contacts","read:documents":"Access to document information","write:documents":"Create/update/delete documents","read:notes":"Access to note information","write:notes":"Create/update/delete notes","read:document_integrations":"View document synchronization status","write:document_integrations":"Synchronize documents on third-party integrations","read:webhooks":"Access to webhook information","write:webhooks":"Create/edit/delete webhooks","read:users":"Access to user information","write:users":"Create/edit/delete users","read:organizations":"Access to organization information","write:organizations":"Create/edit/delete organizations","read:invitations":"Access to invitation information","write:invitations":"Create/edit/delete invitations","read:subscriptions":"Access subscription information","write:subscriptions":"Manage subscriptions","read:emails":"Access email information","write:emails":"Send and manage emails","read:personalizations":"Access personalizations","write:personalizations":"Manage personalizations","read:oauth_client_users":"Access integration users","write:oauth_client_users":"Manage integration users","read:oauth_clients":"Access to third-party integration information","write:oauth_clients":"Manage third-party integrations","read:oauth_short_access_tokens":"Access short-lived access tokens","write:oauth_short_access_tokens":"Manage short-lived access tokens","read:images":"Access images","write:images":"Manage images","capture:images":"Capture images","read:meetings":"scopes.read_meetings","write:meetings":"scopes.write_meetings","read:audios":"Access audio recordings","write:audios":"Manage audio recordings","capture:audios":"Capture audio recordings","read:readers":"Access readers","write:readers":"Manage readers","read:user_registrations":"Access to user pre-registration information","write:user_registrations":"Create/edit/delete user pre-registration information","read:transcription_dictionary":"Access to personal transcription dictionary","write:transcription_dictionary":"Manage personal transcription dictionary"}}}},"bearerAuth":{"id":"bearerAuth","type":"apiKey","description":"API Key provided in the Authorization header","in":"header","paramName":"Authorization"}},"specVersion":"3.2.0","servers":[{"url":"https://api.askara.ai","description":"Production"}],"specType":"openapi"},"options":{"hideDownloadButtons":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/askara-symfony/askara-api.json?download"},{"url":"/_bundle/apis/askara-symfony/askara-api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Askara API","description":"Askara.ai open API"}},"baseSlug":"/apis/askara-symfony/askara-api","routesMapping":{}}