Отримання токену доступу
Інструкція з отримання токену - https://medakadem.freshdesk.com/uk/support/solutions/articles/77000530947-отримання-token
Використання токену - https://medakadem.freshdesk.com/uk/support/solutions/articles/77000530917-token
Для використання API потрібні скоупи: "gambit:public:patient:write".
Якщо немає потрібних scope, то повертатиметься помилка - Code 403 Forbidden
За допомогою даного методу, можна створити нового пацієнта:
HTTP methods: POST
/api/public/v1/patients
Request body:
Example Value:
{ "Patient": { "LFM": "string", "First": "string", "Last": "string", "Middle": "string", "Born": "2025-01-30T12:09:08.719Z", "Gender": "string", "Phone": "string", "TelMob1": "string", "TelMob2": "string", "TelHome": "string", "TelWork": "string", "Email": "string", "StreetName": "string", "StreetNumber": "string", "Room": "string", "Note": "string", "Barcode": "string", "Passport": "string", "InternalCardNumber": "string", "BloodType": "string", "RhFactor": "string", "Weight": 0, "Height": 0, "BirthCity": "string", "ENG_Last": "string", "ENG_Middle": "string", "ENG_First": "string", "CardNumber": "string", "Works": "string", "Code": "string", "Photo": "string", "NativeLanguage": 0, "Sex": true, "MarketingTypeId": 0, "ReferringDoctorId": 0, "CityId": 0, "ClinicId": 0, "ContactPatientId": 0, "ExternalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ExternalClinicId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Options": { "CreateStrategy": 0, "SearchMode": 0, "MatchMode": 0 } }
Параметр | Тип | Опис |
Patient | ||
LFM | string nullable: true | ПІБ пацієнта (можна не заповнювати якщо First, Last, Middle заповнен, інакше - обов'язкове поле) |
First | string nullable: true | ім'я (Можна не заповнювати якщо LFM заповнено, інакше - обов'язкове поле ) |
Last | string nullable: true | прізвище (Можна не заповнювати якщо LFM заповнено, інакше - обов'язкове поле ) |
Middle | string nullable: true | по батькові (Можна не заповнювати якщо LFM заповнено) |
Born | string($date-time) | дата народження (обов'язкове поле) |
Gender | string nullable: true | стать "male", "female" |
Phone | string nullable: true | номер телефону (TelMob1) |
TelMob1 | string nullable: true | Основний телефону |
TelMob2 | string nullable: true | Додатковий телефону |
TelHome | string nullable: true | Домашній телефону |
TelWork | string nullable: true | Робочій телефону |
string nullable: true | електронна адреса | |
StreetName | string nullable: true | назва вулиці |
StreetNumber | string nullable: true | номер будинку |
Room | string nullable: true | квартира |
Note | string nullable: true | замітка |
Barcode | string nullable: true | --- |
Passport | string nullable: true | паспортні дані |
InternalCardNumber | string nullable: true | внутрішній номер картки |
BloodType | string nullable: true | група крові |
RhFactor | string nullable: true | резус-фактор |
Weight | number($double) | вага |
Height | number($double) | зріст |
BirthCity | string nullable: true | місце народження |
ENG_Last | string nullable: true | прізвище англійською |
ENG_Middle | string nullable: true | по батькові англійсько |
ENG_First | string nullable: true | ім'я англійською |
CardNumber | string nullable: true | номер картки |
Works | string nullable: true | міісце роботи |
Code | string nullable: true | РНОКПП |
Photo | string nullable: true | посилання на фото |
NativeLanguage | integer($int32) | рідна мова |
Sex | boolean | стать |
MarketingTypeId | integer($int32) nullable: true | джерело звернення пацієнта |
ReferringDoctorId | integer($int32) nullable: true | ідентифікатор направившого лікаря |
CityId | integer($int64) nullable: true | ідентифікатор міста |
ClinicId | integer($int32) nullable: true | ідентифікатор філіалу |
ContactPatientId | integer($int32) nullable: true | ідентифікатор контактної особи |
ExternalId | string($uuid) nullable: true | унікальний ідентифікатор пацієнта в зовнішній системі |
ExternalClinicId | string($uuid) nullable: true | --- |
Options | додаткові параметри створення | |
CreateStrategy | integer($int32) |
|
SearchMode | integer($int32) | caming soon... |
MatchMode | integer($int32) | caming soon... |
Options - є не обов'язкові. Якщо не передавати ці параметри, то створення пацієнта буде відбуватися в
стандартному режимі, кожен запит POST створить нового пацієнта.
Якщо передавати $.Options.CreateStrategy = 0 (Default), буде відбуватись стандартне створення (аналогічно тому випадку, якщо не передати Options взагалі), у відповідь повернеться id пацієнта.
Якщо передавати $.Options.CreateStrategy = 1 (GetOrCreate) - відбудеться пошук за LFM, Born та TelMo1 або Phone.
ПІБ можна заповнювати як через поле LFM, так і через Last First Middle (Middle - не обов'язкове).
- у випадку, якщо було знайдено збіг, то у відповідь повернеться id пацієнта, якого було знайдено;
- у разі якщо не сходиться одна з частин ПІБ, телефон чи дата народження, це не вважаєтсья збігом, в результаті чого буде створено нового пацієнта (якщо такий пацієнт є, але телефон не вказаний, це не буде вважатися збігом), у відповідь повернеться id пацієнта;
Якщо передавати $.Options.CreateStrategy = 2 (CreateOrUpdate) - відбудеться пошук (за правилами такими як і для GetOrCreate) та оновлення пацієнта.
Responses:
При успішному виконані запиту повернеться - Code 200 Success
Example Value:
{ "Name": "Name", "Id": 42 }
Name | ПІБ пацієнта |
Id | ідентифікатор створеного пацієнта |
Якщо якісь вхідні дані будуть не вірного формату, то повернеться - Code 400 Bad Request