Dental 4 Windows
API
Модуль интеграции с внешними системами
Версия 1.0
Технологическая документация
Москва
2023
Dental 4 Windows API
Технологическая документация
Содержание
ВВЕДЕНИЕ ............................................................................................................................................ 4
1.
ОБЩИЕ СВЕДЕНИЯ ................................................................................................................ 4
2.
АВТОРИЗАЦИЯ И ЖУРНАЛИРОВАНИЕ ............................................................................ 7
2.1.
Открытие или проверка сессии - Authorize ............................................................................ 7
2.2.
Закрытие сессии - Disconnect .................................................................................................... 8
3.
МЕТОДЫ ПОЛУЧЕНИЯ СПРАВОЧНИКОВ ....................................................................... 9
3.1.
Практики - GetPractices ............................................................................................................. 9
3.2.
Отделения - GetDepartments ................................................................................................... 10
3.3.
Виды платежей - GetPayMethods ............................................................................................ 11
3.4.
Виды резервирования - GetAppointTypes.............................................................................. 12
3.5.
Классы записи - GetAppointClasses ........................................................................................ 13
3.6.
Статусы записи - GetAppointStatuses ..................................................................................... 13
3.7.
Причины отказа от записи - GetCancelReasons .................................................................... 14
3.8.
Уровни расценок - GetPrices ................................................................................................... 15
4.
МЕТОД ПОЛУЧЕНИЯ СВЕДЕНИЙ О СОТРУДНИКАХ КЛИНИКИ ............................ 17
4.1.
Персонал - GetStaff ................................................................................................................... 17
5.
МЕТОДЫ ПОЛУЧЕНИЯ ИНФОРМАЦИИ ПО ПАЦИЕНТАМ ....................................... 19
5.1.
Пациенты - GetPatients ............................................................................................................ 19
5.2.
Планы лечения - GetPlans ....................................................................................................... 20
5.3.
Выполненное лечение - GetTreatments .................................................................................. 23
5.4.
Счета - GetAccounts .................................................................................................................. 24
5.5.
Платежи - GetPayments ............................................................................................................ 28
5.6.
Возвраты - GetRefunds ............................................................................................................. 29
6.
МЕТОДЫ ПОЛУЧЕНИЯ РАСПИСАНИЯ........................................................................... 32
6.1.
Книги записи - GetAppBooks .................................................................................................. 32
6.2.
Расписание - GetAppointments ................................................................................................ 32
6.3.
Отмененные визиты - GetCancellations ................................................................................. 34
7.
МЕТОДЫ ПОЛУЧЕНИЯ ИНФОРМАЦИИ ОБ УДАЛЕННЫХ ЗАПИСЯХ ................... 37
7.1.
Удаленные записи на прием - DeletedAppointments............................................................. 37
7.2.
Удаленные счета - DeletedAccounts ........................................................................................ 38
7.3.
Удаленные платежи - DeletedPayments .................................................................................. 39
7.4.
Удаленные пациенты - DeletedPatients .................................................................................. 41
7.5.
Удаленные записи плана и курса лечения - DeletedTreatments ......................................... 43
3
Dental 4 Windows API
Технологическая документация
ВВЕДЕНИЕ
Dental 4 Windows API предназначен для
информационные системы, используемые Клиникой.
предоставления
данных
в
смежные
При помощи методов API можно получить в ограниченном объеме следующую
информацию:
 сведения о пациентах;
 сведения о сотрудниках;
 сведения о планах лечения;
 сведения о выполненном лечении;
 сведения о выставленных счетах;
 сведения об оплатах;
 расписание приема;
 удаленные записи;
 необходимые справочники.
Настоящий документ предназначен для IT специалистов, выполняющих работы по
интеграции, и содержит описание методов, их параметров и возвращаемых результатах.
Важно!
Несанкционированное подключение к АПИ может привести к утечке / краже данных из
базы! При подключении смежных информационных систем с использованием внешних каналов
связи (Интернет) Вам необходимо заблаговременно выполнить мероприятия по защите данных.
4
Dental 4 Windows API
Технологическая документация
1. ОБЩИЕ СВЕДЕНИЯ
1.
Первоначальная настройка выполняется сотрудниками службы технической поддержки
ООО «Сентор Софтвер»
2.
Для выполнения запроса к API необходимо выполнить запрос HTTP GET по URI нужного
метода, аргументы передаются в GET-параметрах запроса. URI для вызова метода
формируется следующим образом:
http(s)://<адрес сервера API>:<порт сервера API>/ruapi/v1/<имя метода>?<аргументы>
Адрес сервера API это адрес сервера баз данных, порт сервера API используется указанный
в настройка сервиса сервера базы данных.
3.
Результаты запроса возвращаются в формате XML в кодировке сервера БД Dental 4
Windows, по умолчанию – Windows-1251.
4.
Формат ответа:
Элемент
Тип
Response
SessionID
Составной
Строка
RequestID
Целое
Result
Resource
Params
Строка
Строка
Составной
ErrorCode
ErrorText
<Запрашиваемые
данные>
Целое
Строка
Составной
Описание
Ответ сервера API
Идентификатор сессии (может отсутствовать при ошибке
обработки)
Идентификатор запроса (может отсутствовать при ошибке
обработки)
=OK в случае успешной обработки запроса
Запрошенный метод API
Параметры запроса (может отсутствовать для метода
Authorize)
Код ошибки (в случае ошибки обработки запроса)
Текст ошибки (в случае ошибки обработки запроса)
Запрашиваемые данные (в случае успешной обработки
запроса), наименование элемента и состав сведений
зависят от метода API
5.
При передаче параметров и при возврате результатов запроса используются форматы даты
и времени YYYY-MM-DD HH:MM:SS.MS
6.
Пример запроса:
Получить информацию по пациентам с датой первичного визита 11 марта 2021 года:
http://127.0.0.1:5001/ruapi/v1/GetPatients?SessionID=sva1234&RegFrom=2021-03-11&RegTo=2021-03-11
5
Dental 4 Windows API
Коды ошибок
40000 : 'Портал недоступен'
40010 : 'Невалидный ключ клиента'
40020 : 'Нет доступа к API'
40100 : 'Сессия не найдена'
40110 : 'Сессия закрыта'
40120 : 'Ошибка подключения к сессии'
40130 : 'Подключено к другой сессии'
40140 : 'Соединение уже подключено к сессии'
40150 : 'Не указана сессия'
40160 : 'Плохой идентификатор сессии'
40200 : 'Метод не поддерживается'
40210 : 'Плохое целое в параметрах'
40220 : 'Плохая дата в параметрах'
6
Технологическая документация
Dental 4 Windows API
Технологическая документация
2. АВТОРИЗАЦИЯ И ЖУРНАЛИРОВАНИЕ
1.
Все запросы к API должны включать заголовок (HTTP HEADER) D4W_CLIENT_SECRET,
содержащий значение уникального ключа API. Для получения действующего ключа
необходимо выполнить запрос от пользователя БД dba:
Select secadm.RUAPI_CLIENT_SECRET(); получение секретного кода
Ключ привязан к CIN и при изменении последнего также будет изменен.
2.
Запросы должны включать базовую аутентификацию (HTTP basic authentication), т.е.
включать заголовок (HTTP HEADER):
Authorization: Basic base64_encode(login:password)
, где в качестве логина и пароля указывается ruapi:d4wapirus.
3.
Для всех методов кроме Authorize необходимо в параметрах передавать идентификатор
открытой сессии SessionID. После завершения сеанса получения данных рекомендуется
закрывать сессию (метод Disconnect), если не планируется ее использование в ближайшее
время. Время жизни неактивной HTTP сессии настраивается в параметрах СУБД
(http_session_timeout). В зависимости от планируемого режима использования API, может
потребоваться настройка других параметров соединений и производительности СУБД
(request_timeout, max_temp_space, max_query_tasks и т.п.).
4.
Информация о сессиях и выполненных в рамках сессий запросах сохраняется в базе
данных.
5.
При подключении смежных информационных систем с использованием внешних каналов
связи (Интернет) необходимо выполнить мероприятия по защите данных. Использовать
защищенные каналы связи, дополнительно можно использовать HTTPS. В противном
случае идентификационные данные и ключи могут быть похищены злоумышленниками и
использованы для получения сведений о пациентах клиники. Информация по настройке в
документации СУБД (раздел Network protocol options). Так же настоятельно рекомендуется
при настройке маршрутизации локальной вычислительной сети клиники разрешать доступ
к серверу API только с фиксированных IP адресов серверов, на которых установлены
смежные информационные системы.
2.1. Открытие или проверка сессии - Authorize
2.1.1.
Назначение
Открытие новой сессии, проверка состояния ранее открытой сессии
2.1.2.
Параметры
Параметр
SessionID
2.1.3.
Тип
Строка
Описание
Идентификатор сессии для проверки состояния, если не
указан - создается новая сессия
Примеры вызова
Открыть новую сессию:
http://127.0.0.1:5001/ruapi/v1/Authorize
Проверить состояние сессии sva145:
7
Dental 4 Windows API
Технологическая документация
http://127.0.0.1:5001/ruapi/v1/Authorize?SessionID=sva145
2.1.4.
Формат ответа
Элемент
SessionID
2.1.5.
Тип
Строка
Описание
Идентификатор сессии
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva145</SessionID>
<RequestID>43</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/Authorize</Resource>
<Params>
<SessionID>sva145</SessionID>
</Params>
</Response>
2.2. Закрытие сессии - Disconnect
2.2.1.
Назначение
Закрытие сессии
2.2.2.
Параметры
Параметр
SessionID
2.2.3.
Тип
Строка
Описание
Идентификатор сессии
Примеры вызова
Закрыть сессию:
http://127.0.0.1:5001/ruapi/v1/Disconnect?SessionID=sva141
2.2.4.
Формат ответа
Элемент
SessionID
2.2.5.
Тип
Строка
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva141</SessionID>
<RequestID>44</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/Disconnect</Resource>
<Params>
<SessionID>sva141</SessionID>
</Params>
</Response>
8
Описание
Идентификатор сессии
Dental 4 Windows API
Технологическая документация
3. МЕТОДЫ ПОЛУЧЕНИЯ СПРАВОЧНИКОВ
3.1. Практики - GetPractices
3.1.1.
Назначение
Получение информации по практикам.
3.1.2.
Параметры
Параметр
SessionID
Services
3.1.3.
Тип
Строка
Целое
Описание
Идентификатор сессии
Выгрузить виды выполняемых работ / оказываемых услуг
(1=да, 0=нет)
Примеры вызова
Получить информацию по всем практикам:
http://127.0.0.1:5001/ruapi/v1/GetPractices?SessionID=sva345
3.1.4.
Формат ответа
Элемент
Practices
Practice
Id
Name
Services
Service
Id
Name
3.1.5.
Тип
Массив
Составной
Целое
Строка
Массив
Составной
Целое
Строка
Описание
Массив записей с информацией по практике
Информация по практике
Идентификатор практики
Наименование практики
Массив записей с информацией по видам работ
Информация по виду работ
Идентификатор вида работ
Наименование вида работ
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva345</SessionID>
<RequestID>47</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetPractices</Resource>
<Params>
<SessionID>sva345</SessionID>
</Params>
<Practices>
<Practice>
<Id>1</Id>
<Name>Стоматологическая Поликлиника №1</Name>
</Practice>
<Practice>
<Id>2</Id>
<Name>Стоматологическая Поликлиника №2</Name>
</Practice>
</Practices>
</Response>
9
Dental 4 Windows API
Технологическая документация
3.2. Отделения - GetDepartments
3.2.1.
Назначение
Получение перечня отделений.
3.2.2.
Параметры
Параметр
SessionID
PracticeId
Services
3.2.3.
Тип
Строка
Целое
Целое
Описание
Идентификатор сессии
Идентификатор практики
Выгрузить виды выполняемых работ / оказываемых услуг
(1=да, 0=нет)
Примеры вызова
Получить отделения с видами выполняемых работ практики с идентификатором 1:
http://127.0.0.1:5001/ruapi/v1/GetDepartments?SessionID=sva20&PracticeId=1&Services=1
3.2.4.
Формат ответа
Элемент
Тип
Departments
Department
Id
Name
PracticeId
Services
Service
Id
Name
Массив
Составной
Целое
Строка
Целое
Массив
Составной
Целое
Строка
3.2.5.
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva20</SessionID>
<RequestID>58</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetDepartments</Resource>
<Params>
<SessionID>sva20</SessionID>
<PracticeID>1</PracticeID>
</Params>
<Departments>
<Department>
<Id>1</Id>
<Name>1 лечебное</Name>
<PracticeId>1</PracticeId>
</Department>
<Department>
<Id>2</Id>
<Name>2 лечебное</Name>
<PracticeId>1</PracticeId>
<Services>
<Service>
<Id>1</Id>
10
Описание
Массив записей с информацией по отделению
Информация по отделению
Идентификатор отделения
Наименование практики
Идентификатор практики
Массив записей с информацией по видам работ
Информация по виду работ
Идентификатор вида работ
Наименование вида работ
Dental 4 Windows API
Технологическая документация
<Name>лечение</Name>
</Service>
<Service>
<Id>6</Id>
<Name>физиотерапия</Name>
</Service>
</Services>
</Department>
</Departments>
</Response>
3.3. Виды платежей - GetPayMethods
3.3.1.
Назначение
Получение справочника видов платежей.
3.3.2.
Параметры
Параметр
SessionID
3.3.3.
Тип
Строка
Описание
Идентификатор сессии
Примеры вызова
Получить все виды платежей:
http://127.0.0.1:5001/ruapi/v1/GetPayMethods?SessionID=sva320
3.3.4.
Формат ответа
Элемент
Methods
Method
Id
Name
3.3.5.
Тип
Описание
Массив
Составной
Целое
Строка
Массив записей справочника
Запись справочника
Идентификатор записи справочника
Наименование вида платежа
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva320</SessionID>
<RequestID>59</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetPayMethods</Resource>
<Methods>
<Method>
<Id>1</Id>
<Name>Наличные</Name>
</Method>
<Method>
<Id>13</Id>
<Name>Другое</Name>
</Method>
</Methods>
<Params>
<SessionID>sva320</SessionID>
</Params>
</Response>
11
Dental 4 Windows API
Технологическая документация
3.4. Виды резервирования - GetAppointTypes
3.4.1.
Назначение
Получение справочника видов резервирования в книге записи.
3.4.2.
Параметры
Параметр
SessionID
3.4.3.
Тип
Строка
Описание
Идентификатор сессии
Примеры вызова
Получить все виды резервирования:
http://127.0.0.1:5001/ruapi/v1/GetAppointTypes?SessionID=sva21
3.4.4.
Формат ответа
Элемент
Тип
Описание
AppointTypes
AppointType
Id
Code
Name
IsWork
IsOnline
Массив
Составной
Целое
Строка
Строка
Целое
Целое
Массив записей справочника
Запись справочника
Идентификатор записи справочника
Код вида резервирования
Наименование вида резервирования
Рабочее время (1=да, 0=нет)
Онлайн запись (1=да, 0=нет)
3.4.5.
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva21</SessionID>
<RequestID>63</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetAppointTypes</Resource>
<Params>
<SessionID>sva21</SessionID>
</Params>
<AppointTypes>
<AppointType>
<Id>1</Id>
<Code>EMPTY_SLOT</Code>
<Name>Свободное время</Name>
<IsWork>1</IsWork>
<IsOnline>0</IsOnline>
</AppointType>
<AppointType>
<Id>2</Id>
<Name>Острая боль</Name>
<Code>PRESET_2</Code>
<IsWork>0</IsWork>
<IsOnline>0</IsOnline>
</AppointType>
</AppointTypes>
</Response>
12
Dental 4 Windows API
Технологическая документация
3.5. Классы записи - GetAppointClasses
3.5.1.
Назначение
Получение справочника классов записи на прием.
3.5.2.
Параметры
Параметр
SessionID
3.5.3.
Тип
Строка
Описание
Идентификатор сессии
Примеры вызова
Получить все классы записи:
http://127.0.0.1:5001/ruapi/v1/GetAppointClasses?SessionID=sva21
3.5.4.
Формат ответа
Элемент
Тип
Описание
AppointClasses
AppointClass
Id
Name
Массив
Составной
Целое
Строка
Массив записей справочника
Запись справочника
Идентификатор записи справочника
Наименование класса записи
3.5.5.
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva21</SessionID>
<RequestID>64</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetAppointClasses</Resource>
<Params>
<SessionID>sva21</SessionID>
</Params>
<AppointClasses>
<AppointClass>
<Id>1</Id>
<Name>&lt;нет&gt;</Name>
</AppointClass>
<AppointClass>
<Id>2</Id>
<Name>Резерв</Name>
</AppointClass>
<AppointClass>
<Id>3</Id>
<Name>Потенциальный пациент</Name>
</AppointClass>
</AppointClasses>
</Response>
3.6. Статусы записи - GetAppointStatuses
3.6.1.
Назначение
Получение справочника статусов записи на прием.
13
Dental 4 Windows API
3.6.2.
Технологическая документация
Параметры
Параметр
SessionID
3.6.3.
Тип
Строка
Описание
Идентификатор сессии
Примеры вызова
Получить все статусы:
http://127.0.0.1:5001/ruapi/v1/GetAppointStatuses?SessionID=sva221
3.6.4.
Формат ответа
Элемент
AppointStatuses
AppointStatus
Id
Code
Name
3.6.5.
Тип
Описание
Массив
Составной
Целое
Строка
Строка
Массив записей справочника
Запись справочника
Идентификатор записи справочника
Код статуса
Наименование статуса
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva221</SessionID>
<RequestID>66</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetAppointStatuses</Resource>
<Params>
<SessionID>sva221</SessionID>
</Params>
<AppointStatuses>
<AppointStatus>
<Id>5</Id>
<Code>A</Code>
<Name>Первичный Прием</Name>
</AppointStatus>
<AppointStatus>
<Id>18</Id>
<Code>B</Code>
<Name>Повторный Прием</Name>
</AppointStatus>
</AppointStatuses>
</Response>
3.7. Причины отказа от записи - GetCancelReasons
3.7.1.
Назначение
Получение справочника причин отказа от записи на прием.
3.7.2.
Параметры
Параметр
SessionID
14
Тип
Строка
Описание
Идентификатор сессии
Dental 4 Windows API
3.7.3.
Технологическая документация
Примеры вызова
Получить все причины отказа:
http://127.0.0.1:5001/ruapi/v1/GetCancelReasons?SessionId=sva23
3.7.4.
Формат ответа
Элемент
Тип
Описание
CancelReasons
CancelReason
Id
Name
Массив
Составной
Целое
Строка
Массив записей справочника
Запись справочника
Идентификатор записи справочника
Причина отказа
3.7.5.
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva23</SessionID>
<RequestID>69</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetCancelReasons</Resource>
<Params>
<SessionID>sva23</SessionID>
</Params>
<CancelReasons>
<CancelReason>
<Id>1</Id>
<Name>Неявка</Name>
</CancelReason>
<CancelReason>
<Id>2</Id>
<Name>Отказ от визита</Name>
</CancelReason>
</CancelReasons>
</Response>
3.8. Уровни расценок - GetPrices
3.8.1.
Назначение
Получение действующих уровней расценок на дату.
3.8.2.
Параметры
Параметр
SessionID
PracticeId
Date
3.8.3.
Тип
Строка
Целое
Дата
Описание
Идентификатор сессии
Идентификатор практики
Действующие расценки на дату
Примеры вызова
Получить прайс-листы на дату:
http://127.0.0.1:5001/ruapi/v1/GetPrices?SessionID=sva25&Date=2021-04-01
15
Dental 4 Windows API
3.8.4.
Технологическая документация
Формат ответа
Элемент
Тип
PriceLists
PriceList
LevelId
LevelName
IsMain
ValidFrom
ValidTo
PriceItems
PriceItem
ItemId
ItemCode
ItemName
Price
PriceSection
PriceSubsection
Массив
Составной
Целое
Строка
Целое
Дата
Дата
Массив
Составной
Целое
Строка
Строка
Дробное
Строка
Строка
3.8.5.
Описание
Массив записей с информацией по уровням расценок
Информация по прайс-листу
Идентификатор уровня расценок
Наименование уровня
Основной (1=да, 0=нет)
Дата начала действия
Дата окончания действия
Массив позиций прайс-листа
Позиция прайс-листа
Идентификатор процедуры
Код процедуры
Наименование процедуры
Стоимость процедуры
Наименование раздела (Режим процедуры)
Наименование подраздела (Режим процедуры)
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva25</SessionID>
<RequestID>75</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetPrices</Resource>
<Params>
<SessionID>sva25</SessionID>
<PracticeID>1</PracticeID>
<Date>1</Date>
</Params>
<PriceLists>
<PriceList>
<LevelId>1</LevelId>
<LevelName>Наличный расчет с 15.02.20001</LevelName>
<IsMain>0</IsMain>
<ValidFrom>1900-01-01</ValidFrom>
<ValidTo>2022-02-14</ValidTo>
<PracticeId>1</PracticeId>
<PriceItems>
<PriceItem>
<ItemId>1</ItemId>
<ItemCode>9110</ItemCode>
<ItemName>ЕСТЕСТВЕННОЕ ОТБЕЛ. ЗУБОВ (2 ЧЕЛ.)</ItemName>
<Price>300.00</Price>
</PriceItem>
<PriceItem>
<ItemId>2</ItemId>
<ItemCode>9330</ItemCode>
<ItemName>УДАЛЕНИЕ ЗУБА ФРОНТАЛЬНОГО (НАРКОЗ)</ItemName>
<Price>97.00</Price>
</PriceItem>
</PriceItems>
</PriceList>
</PriceLists>
16
Dental 4 Windows API
Технологическая документация
4. МЕТОД ПОЛУЧЕНИЯ СВЕДЕНИЙ О СОТРУДНИКАХ КЛИНИКИ
4.1. Персонал - GetStaff
4.1.1.
Назначение
Получение информации по сотрудникам.
4.1.2.
Параметры
Параметр
SessionID
PracticeId
DepartmentId
IsProvider
IsAssistant
IsCurator
IsTechnician
4.1.3.
Тип
Строка
Целое
Целое
Целое
Целое
Целое
Целое
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор отделения
Является врачом (1=да, 0=нет)
Является ассистентом (1=да, 0=нет)
Является куратором (1=да, 0=нет)
Является техником (1=да, 0=нет)
Примеры вызова
Получить сотрудников по идентификаторам практики и отделения:
http://127.0.0.1:5001/ruapi/v1/GetStaff?SessionID=sva2&PracticeId=1&DepartmentId=4
4.1.4.
Формат ответа
Элемент
Staff
Member
Id
Code
Surname
Firsname
Middlename
PracticeId
DepartmentId
IsProvider
IsAssistant
IsCurator
IsTechnician
ProfName
AppBookId
HomePhone
MobilePhone
WorkPhone
4.1.5.
Тип
Массив
Составной
Целое
Строка
Строка
Строка
Строка
Целое
Целое
Целое
Целое
Целое
Целое
Строка
Целое
Строка
Строка
Строка
Описание
Массив записей с информацией по сотрудникам
Информация по сотруднику
Идентификатор сотрудника
Код врача
Фамилия
Имя
Отчество
Идентификатор практики
Идентификатор отделения
Является врачом (1=да, 0=нет)
Является ассистентом (1=да, 0=нет)
Является куратором (1=да, 0=нет)
Является техником (1=да, 0=нет)
Должность
Идентификатор книги записи
Домашний телефон
Мобильный телефон
Рабочий телефон
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
17
Dental 4 Windows API
<SessionID>sva2</SessionID>
<RequestID>21</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetStaff</Resource>
<Params>
<SessionID>sva2</SessionID>
<PracticeID>1</PracticeID>
<IsProvider>1</IsProvider>
</Params>
<Staff>
<Member>
<Id>1</Id>
<Code>99</Code>
<Surname>Соколов</Surname>
<Firsname>Петр</Firsname>
<Middlename>Львович</Middlename>
<PracticeId>1</PracticeId>
<DepartmentId>4</DepartmentId>
<IsProvider>1</IsProvider>
<IsAssistant>0</IsAssistant>
<IsCurator>0</IsCurator>
<IsTechnician>0</IsTechnician>
<ProfName></ProfName>
</Member>
<Member>
<Id>2</Id>
<Code>1</Code>
<Surname>Иванова</Surname>
<Firsname>Алла</Firsname>
<Middlename>Евгеньевна</Middlename>
<PracticeId>1</PracticeId>
<DepartmentId>4</DepartmentId>
<IsProvider>0</IsProvider>
<IsAssistant>1</IsAssistant>
<IsCurator>0</IsCurator>
<IsTechnician>0</IsTechnician>
<ProfName>Стоматолог детский</ProfName>
</Member>
<Staff>
18
Технологическая документация
Dental 4 Windows API
Технологическая документация
5. МЕТОДЫ ПОЛУЧЕНИЯ ИНФОРМАЦИИ ПО ПАЦИЕНТАМ
5.1. Пациенты - GetPatients
5.1.1.
Назначение
Получение информации по пациентам.
5.1.2.
Параметры
Параметр
SessionID
PracticeId
ProviderId
CuratorId
PatientId
FamilyHeadId
DateFrom
DateTo
CardNum
RegFrom
RegTo
5.1.3.
Тип
Описание
Строка
Целое
Целое
Целое
Целое
Целое
Дата
Дата
Строка
Дата
Дата
Идентификатор сессии
Идентификатор практики
Идентификатор ведущего врача
Идентификатор куратора
Идентификатор пациента
Идентификатор главы семьи
Дата изменения не менее
Дата изменения не более
Номер амбулаторной карты
Дата первичного визита не менее
Дата первичного визита не более
Примеры вызова
Получить пациента по идентификатору:
http://127.0.0.1:5001/ruapi/v1/GetPatients?SessionID=sva3&PatientId=4931
Получить информацию по членам семьи:
http://127.0.0.1:5001/ruapi/v1/GetPatients?SessionID=sva3&FamilyHeadId=3211
Получить информацию по пациентам с датой изменения 19 марта 2021 года:
http://127.0.0.1:5001/ruapi/v1/GetPatients?SessionID=sva3&DateFrom=2021-03-19&DateTo=2021-03-19
5.1.4.
Формат ответа
Элемент
Patients
Patient
PatientId
FamilyHeadId
CardNum
Surname
Firsname
Middlename
PreferredName
BirthDate
Sex
Address
HomePhone
Тип
Массив
Составной
Целое
Целое
Строка
Строка
Строка
Строка
Строка
Дата
Целое
Строка
Строка
Описание
Массив записей с информацией по пациентам
Информация по пациенту
Идентификатор пациента
Идентификатор пациента – главы семьи
Номер амбулаторной карты
Фамилия
Имя
Отчество
Обращение
Дата рождения
1=женский, 0=мужской
Адрес
Домашний телефон
19
Dental 4 Windows API
Технологическая документация
MobilePhone
WorkPhone
Email
FirstVisitDate
DiscountDef
PracticeId
ProviderId
CuratorId
DateModified
AdditionalInfo
TreatmentCompleted
5.1.5.
Строка
Строка
Строка
Дата
Дробное
Целое
Целое
Целое
Дата и время
Строка
Целое
Мобильный телефон
Рабочий телефон
Адрес электронной почты
Дата первого визита
Скидка в % по умолчанию
Идентификатор практики
Идентификатор ведущего врача
Идентификатор куратора
Дата изменения
Поле Дополнительные условия
1=Чекбокс
«Лечение
завершено»
0=Чекбокс снят
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva3</SessionID>
<RequestID>25</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetPatients</Resource>
<Params>
<SessionID>sva3</SessionID>
<PatientId>4931</PatientId>
</Params>
<Patients>
<Patient>
< PatientId>4931</Id>
<FamilyHeadId>4931</FamilyHeadId>
<CardNum>4931</CardNum>
<Surname>Трофимов</Surname>
<Firstname>Александр</Firstname>
<Middlename></Middlename>
<PreferredName></PreferredName>
<BirthDate>1964-01-22</BirthDate>
<Sex>0</Sex>
<Address>ул. 50 лет ВЛКСМ д.15</Address>
<HomePhone>5120781</HomePhone>
<FirstVisitDate>2001-06-19</FirstVisitDate>
<DiscountDef>0.0</DiscountDef>
<PracticeId>1</PracticeId>
<ProviderId>30</ProviderId>
<DateModified>2010-10-21</DateModified>
</Patient>
</Patients>
</Response>
5.2. Планы лечения - GetPlans
5.2.1.
Назначение
Получение информации по планам лечения.
5.2.2.
Параметры
Параметр
SessionID
PracticeId
ProviderId
20
Тип
Строка
Целое
Целое
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор ведущего врача
установлен,
Dental 4 Windows API
CuratorId
PatientId
AccountId
DateFrom
DateTo
PlanId
TreatId
5.2.3.
Технологическая документация
Целое
Целое
Целое
Дата
Дата
Целое
Целое
Идентификатор куратора
Идентификатор пациента
Идентификатор счета
Дата плана не менее
Дата плана не более
Идентификатор плана лечения
Идентификатор процедуры
Примеры вызова
Получить все планы лечения пациента за год:
http://127.0.0.1:5001/ruapi/v1/GetPlans?SessionID=sva4&PatientId=4931&DateFrom=2001-0101&DateTo=2001-12-31
5.2.4.
Формат ответа
Элемент
Тип
Plans
TreatPlan
PlanId
PatientId
PlanDateTime
IsActive
ProviderId
CuratorId
Notes
PlanItems
PlanItem
TreatId
PlanDate
PracticeId
DepartmentId
ProviderId
CuratorId
ItemId
ItemCode
ItemName
Tooth
Surface
PlanTimes
PlanFee
PlanRebate
Stage
Visit
Estimate
AccountId
PlanAppointId
PlanNotes
Массив
Составной
Целое
Целое
Дата и время
Целое
Целое
Целое
Строка
Массив
Составной
Целое
Дата
Целое
Целое
Целое
Целое
Строка
Строка
Строка
Строка
Строка
Целое
Дробное
Дробное
Целое
Целое
Целое
Целое
Целое
Строка
Описание
Массив записей с информацией по планам лечения
Информация по плану лечения
Идентификатор плана лечения
Идентификатор пациента
Дата и время плана
Действующий план (1=да, 0=нет)
Идентификатор врача
Идентификатор куратора
Примечание к плану
Массив записей с информацией по процедурам в плане
Информация по процедуре в плане лечения
Идентификатор процедуры в плане лечения
Плановая дата процедуры
Идентификатор практики
Идентификатор отделения
Идентификатор врача
Идентификатор куратора
Идентификатор процедуры
Код процедуры
Наименование процедуры
Зуб
Поверхность
Плановое количество процедур
Плановая стоимость процедуры
Плановая компенсация по страховке
Этап
Визит
Длительность
Идентификатор счета
Идентификатор записи на приём
Примечания к запланированной процедуре
21
Dental 4 Windows API
5.2.5.
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva4</SessionID>
<RequestID>29</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetPlans</Resource>
<Params>
<SessionID>sva4</SessionID>
<PatientId>4931</PatientId>
<DateFrom>2001-01-01</DateFrom>
<DateTo>2001-12-31</DateTo>
</Params>
<Plans>
<TreatPlan>
<PlanId>730</PlanId>
<PatientId>4931</PatientId>
<PlanDateTime>2001-07-18 12:10:28.000</PlanDateTime>
<IsActive>1</IsActive>
<ProviderId>30</ProviderId>
<PlanItems>
<PlanItem>
<TreatId>62003</TreatId>
<PlanDate>2001-07-18</PlanDate>
<PracticeId>1</PracticeId>
<DepartmentId>0</DepartmentId>
<ProviderId>30</ProviderId>
<ItemId>1194</ItemId>
<ItemCode>1629</ItemCode>
<ItemName>ПЛОМБ.3 КАНАЛОВ ГУТТАПЕР.ШТИФТАМИ</ItemName>
<Tooth></Tooth>
<Surface></Surface>
<PlanTimes>1</PlanTimes>
<PlanFee>250.00</PlanFee>
<PlanRebate>0.00</PlanRebate>
<Stage>1</Stage>
</PlanItem>
<PlanItem>
<TreatId>62005</TreatId>
<PlanDate>2001-07-18</PlanDate>
<PracticeId>1</PracticeId>
<DepartmentId>0</DepartmentId>
<ProviderId>30</ProviderId>
<ItemId>1173</ItemId>
<ItemCode>1730</ItemCode>
<ItemName>МЕСТНОЕ ОБЕЗБОЛИВАНИЕ(ИМПОРТ.АНЕСТ)</ItemName>
<Tooth></Tooth>
<Surface></Surface>
<PlanTimes>1</PlanTimes>
<PlanFee>80.00</PlanFee>
<PlanRebate>0.00</PlanRebate>
<Stage>1</Stage>
</PlanItem>
<PlanItem>
<TreatId>62006</TreatId>
<PlanDate>2001-07-18</PlanDate>
<PracticeId>1</PracticeId>
<DepartmentId>0</DepartmentId>
<ProviderId>30</ProviderId>
<ItemId>1940</ItemId>
<ItemCode>1775</ItemCode>
<ItemName>R-СНИМОК НА ВИЗИОГРАФЕ (БЕЗ ПЕЧАТИ)</ItemName>
<Tooth></Tooth>
<Surface></Surface>
<PlanTimes>1</PlanTimes>
<PlanFee>40.00</PlanFee>
<PlanRebate>0.00</PlanRebate>
22
Технологическая документация
Dental 4 Windows API
Технологическая документация
<Stage>1</Stage>
</PlanItem>
</PlanItems>
</TreatPlan>
</Plans>
</Response>
5.3. Выполненное лечение - GetTreatments
5.3.1.
Назначение
Получение информации по выполненному лечению.
5.3.2.
Параметры
Параметр
SessionID
PracticeId
ProviderId
CuratorId
PatientId
AccountId
DateFrom
DateTo
PlanId
TreatId
5.3.3.
Тип
Строка
Целое
Целое
Целое
Целое
Целое
Дата
Дата
Целое
Целое
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор ведущего врача
Идентификатор куратора
Идентификатор пациента
Идентификатор счета
Дата лечения не менее
Дата лечения не более
Идентификатор плана лечения
Идентификатор процедуры
Примеры вызова
Получить записи курса лечения пациента после даты:
http://127.0.0.1:5001/ruapi/v1/GetTreatments?SessionID=sva4&PatientId=5933&DateFrom=2021-04-01
Получить детализацию лечения по счету:
http://127.0.0.1:5001/ruapi/v1/GetTreatments?SessionID=sva4&AccountId=3477
5.3.4.
Формат ответа
Элемент
Treatments
Treatment
TreatId
TreatDate
PracticeId
DepartmentId
PatientId
ProviderId
AssistantId
CuratorId
ItemCode
ItemName
Tooth
Surface
Тип
Массив
Составной
Целое
Дата
Целое
Целое
Целое
Целое
Целое
Целое
Строка
Строка
Строка
Строка
Описание
Массив записей с информацией по процедурам
Информация по записи курса лечения
Идентификатор процедуры
Дата процедуры
Идентификатор практики
Идентификатор отделения
Идентификатор пациента
Идентификатор врача
Идентификатор ассистента
Идентификатор куратора
Код процедуры
Наименование процедуры
Зуб
Поверхность
23
Dental 4 Windows API
Times
Fee
Rebate
AccountId
TreatAppointId
ServiceId
TreatNotes
PlanId
PlanDate
PlanTimes
PlanFee
PlanRebate
Stage
Visit
Estimate
PlanAppointId
PlanNotes
5.3.5.
Технологическая документация
Целое
Дробное
Дробное
Целое
Целое
Целое
Строка
Целое
Дата
Целое
Дробное
Дробное
Целое
Целое
Целое
Целое
Строка
Количество процедур
Стоимость процедуры
Компенсация по страховке
Идентификатор счета
Идентификатор записи на приём
Идентификатор вида работ
Примечания к процедуре
Идентификатор плана лечения
Плановая дата процедуры
Плановое количество процедур
Плановая стоимость процедуры
Плановая компенсация по страховке
Этап
Визит
Длительность
Идентификатор записи на приём
Примечания к запланированной процедуре
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva4</SessionID>
<RequestID>35</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetTreatments</Resource>
<Params>
<SessionID>sva4</SessionID>
<AccountId>3477</AccountId>
</Params>
<Treatments>
<Treatment>
<TreatId>23187</TreatId>
<TreatDate>2001-12-17</TreatDate>
<PracticeId>1</PracticeId>
<DepartmentId>4</DepartmentId>
<PatientId>5933</PatientId>
<ProviderId>31</ProviderId>
<AssistantId>77</AssistantId>
<ItemId>8929</ItemId>
<ItemCode>1001</ItemCode>
<ItemName>ПОСЕЩЕНИЕ</ItemName>
<Tooth>22</Tooth>
<Surface></Surface>
<Times>1</Times>
<Fee>25.00</Fee>
<Rebate>0.00</Rebate>
<Expenses>0.00</Expenses>
<AccountId>3477</AccountId>
</Treatment>
</Treatments>
</Response>
5.4. Счета - GetAccounts
5.4.1.
Назначение
Получение информации по выставленным счетам.
24
Dental 4 Windows API
5.4.2.
Технологическая документация
Параметры
Параметр
SessionID
AccountId
PracticeId
ProviderId
CuratorId
PayPatientId
DateFrom
DateTo
Treatments
Payments
5.4.3.
Тип
Строка
Целое
Целое
Целое
Целое
Целое
Дата
Дата
Символ
Символ
Описание
Идентификатор сессии
Идентификатор счета
Идентификатор практики
Идентификатор врача
Идентификатор куратора
Идентификатор пациента-плательщика
Дата счета не менее
Дата счета не более
1 для выгрузки процедур по счету, по умолчанию 0
1 для выгрузки платежей по счету, по умолчанию 0
Примеры вызова
Получить информацию по счету по идентификатору:
http://127.0.0.1:5001/ruapi/v1/GetAccounts?SessionID=sva5&AccountId=5047&Treatments=1&Payments=1
Получить все счета по идентификатору куратора:
http://127.0.0.1:5001/ruapi/v1/GetAccounts?SessionID=sva5&CuratorId=101
5.4.4.
Формат ответа
Элемент
Accounts
Account
AccountId
PayPatientId
AccountDate
Total
PracticeId
Discount
Bonus
Paid
Providers
Provider
ProviderId
Treatments
Treatment
TreatId
TreatDate
DepartmentId
PatientId
ProviderId
AssistantId
CuratorId
ItemCode
ItemName
Tooth
Тип
Массив
Составной
Целое
Целое
Дата
Дробное
Целое
Дробное
Дробное
Дробное
Массив
Составной
Целое
Массив
Составной
Целое
Дата
Целое
Целое
Целое
Целое
Целое
Строка
Строка
Строка
Описание
Массив записей с информацией по счетам
Информация по счету
Идентификатор счета
Идентификатор пациента-плательщика
Дата счета
Сумма счета
Идентификатор практики
Скидка по счету
Скидка бонусами
Сумма оплат
Массив записей с врачами по счету
Информация о враче по счету
Идентификатор врача
Массив записей с процедурами по счету
Информация по процедуре в счете
Идентификатор процедуры
Дата процедуры
Идентификатор отделения
Идентификатор пациента
Идентификатор врача
Идентификатор ассистента
Идентификатор куратора
Код процедуры
Наименование процедуры
Зуб
25
Dental 4 Windows API
Surface
Times
Fee
Rebate
TreatAppointId
ServiceId
TreatNotes
PlanId
PlanDate
PlanTimes
PlanFee
PlanRebate
Stage
Visit
Estimate
PlanAppointId
PlanNotes
Payments
Payment
PayId
TypeId
Amount
CheckName
BankName
BankBranch
5.4.5.
Технологическая документация
Строка
Целое
Дробное
Дробное
Целое
Целое
Строка
Целое
Дата
Целое
Дробное
Дробное
Целое
Целое
Целое
Целое
Строка
Массив
Составной
Целое
Целое
Дробное
Строка
Строка
Строка
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva5</SessionID>
<RequestID>44</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetAccounts</Resource>
<Params>
<SessionID>sva5</SessionID>
<AccountId>5047</AccountId>
<Treatments>1</Treatments>
<Payments>1</Payments>
</Params>
<Accounts>
<Account>
<AccountId>5047</AccountId>
<PayPatientId>5020</PayPatientId>
<AccountDate>2002-01-31</AccountDate>
<Total>707.00</Total>
<PracticeId>1</PracticeId>
<Discount>0.00</Discount>
<Bonus>0.00</Bonus>
<Paid>707.00</Paid>
<Providers>
<Provider>
<ProviderId>40</ProviderId>
</Provider>
</Providers>
<Treatments>
<Treatment>
<TreatId>32941</TreatId>
26
Поверхность
Количество процедур
Стоимость процедуры
Компенсация по страховке
Идентификатор записи на приём
Идентификатор вида работ
Примечания к процедуре
Идентификатор плана лечения
Плановая дата процедуры
Плановое количество процедур
Плановая стоимость процедуры
Плановая компенсация по страховке
Этап
Визит
Длительность
Идентификатор записи на приём
Примечания к запланированной процедуре
Массив записей с информацией по платежам по счету
Информация по платежу по счету
Идентификатор платежа
Вид оплаты
Сумма оплаты
Номер чека
Банк
Отделение банка
Dental 4 Windows API
Технологическая документация
<TreatDate>2002-01-31</TreatDate>
<DepartmentId>4</DepartmentId>
<PatientId>5020</PatientId>
<ProviderId>40</ProviderId>
<AssistantId>87</AssistantId>
<ItemId>8929</ItemId>
<ItemCode>1001</ItemCode>
<ItemName>ПОСЕЩЕНИЕ</ItemName>
<Tooth>15</Tooth>
<Surface></Surface>
<Times>1</Times>
<Fee>31.00</Fee>
<Rebate>0.00</Rebate>
<Expenses>0.00</Expenses>
<PlanId>792</PlanId>
<PlanTimes>1</PlanTimes>
<PlanFee>31.00</PlanFee>
<PlanRebate>0.00</PlanRebate>
</Treatment>
<Treatment>
<TreatId>32942</TreatId>
<TreatDate>2002-01-31</TreatDate>
<DepartmentId>4</DepartmentId>
<PatientId>5020</PatientId>
<ProviderId>40</ProviderId>
<AssistantId>87</AssistantId>
<ItemId>8904</ItemId>
<ItemCode>1010</ItemCode>
<ItemName>ПОЛИРОВКА, ШЛИФОВКА ПЛОМБЫ</ItemName>
<Tooth>15</Tooth>
<Surface></Surface>
<Times>1</Times>
<Fee>18.00</Fee>
<Rebate>0.00</Rebate>
<Expenses>0.00</Expenses>
<PlanId>792</PlanId>
<PlanTimes>1</PlanTimes>
<PlanFee>18.00</PlanFee>
<PlanRebate>0.00</PlanRebate>
</Treatment>
<Treatment>
<TreatId>32943</TreatId>
<TreatDate>2002-01-31</TreatDate>
<DepartmentId>4</DepartmentId>
<PatientId>5020</PatientId>
<ProviderId>40</ProviderId>
<AssistantId>87</AssistantId>
<ItemId>1906</ItemId>
<ItemCode>1633</ItemCode>
<ItemName>РЕСТАВРАЦИЯ КУЛЬТИ ЗУБА ПОД КОРОНКУ</ItemName>
<Tooth>15</Tooth>
<Surface>MO</Surface>
<Times>1</Times>
<Fee>658.00</Fee>
<Rebate>0.00</Rebate>
<Expenses>0.00</Expenses>
<ServiceId>1</ServiceId>
<PlanId>792</PlanId>
<PlanTimes>1</PlanTimes>
<PlanFee>658.00</PlanFee>
<PlanRebate>0.00</PlanRebate>
</Treatment>
</Treatments>
<Payments>
<Payment>
<PayId>7868</PayId>
<TypeId>1</TypeId>
<Amount>707.00</Amount>
</Payment>
27
Dental 4 Windows API
Технологическая документация
</Payments>
</Account>
</Accounts>
</Response>
5.5. Платежи - GetPayments
5.5.1.
Назначение
Получение информации по платежам.
5.5.2.
Параметры
Параметр
SessionID
PracticeId
ProviderId
PayPatientId
DateFrom
DateTo
AccountId
ReceiptId
PayId
5.5.3.
Тип
Строка
Целое
Целое
Целое
Дата
Дата
Целое
Целое
Целое
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор ведущего врача
Идентификатор пациента-плательщика
Дата квитанции не менее
Дата квитанции не более
Идентификатор счета
Идентификатор квитанции
Идентификатор платежа
Примеры вызова
Получить все платежи пациента:
http://127.0.0.1:5001/ruapi/v1/GetPayments?SessionID=sva5&PayPatientId=1
Получить все платежи по счёту:
http://127.0.0.1:5001/ruapi/v1/GetPayments?SessionID=sva7&AccountId=5047
5.5.4.
Формат ответа
Элемент
Receipts
Receipt
ReceiptId
ReceiptDate
ReceiptTime
Total
PayPatientId
PracticeId
ProviderId
Payments
Payment
PayId
TypeId
Amount
CheckName
BankName
BankBranch
28
Тип
Массив
Составной
Целое
Дата
Время
Дробное
Целое
Целое
Целое
Массив
Составной
Целое
Целое
Дробное
Строка
Строка
Строка
Описание
Массив записей с информацией по квитанциям
Информация по квитанции
Идентификатор квитанции
Дата квитанции
Время квитанции
Сумма по квитанции
Идентификатор пациента-плательщика
Идентификатор практики
Идентификатор ответственного врача
Массив записей с информацией по платежам
Информация по платежу
Идентификатор платежа
Вид оплаты
Сумма оплаты
Номер чека
Банк
Отделение банка
Dental 4 Windows API
Allocations
Allocation
AccountId
Allocated
5.5.5.
Технологическая документация
Массив
Составной
Целое
Дробное
Массив записей с информацией по оплаченным счетам
Информация по оплаченному счету
Идентификатор счета
Сумма оплаты по счету
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva7</SessionID>
<RequestID>52</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetPayments</Resource>
<Params>
<SessionID>sva7</SessionID>
<AccountId>5047</AccountId>
</Params>
<Receipts>
<Receipt>
<ReceiptId>7807</ReceiptId>
<ReceiptDate>2002-03-01</ReceiptDate>
<ReceiptTime>00:00:00.000</ReceiptTime>
<Total>707.00</Total>
<PayPatientId>5020</PayPatientId>
<PracticeId>1</PracticeId>
<ProviderId>12</ProviderId>
<Payments>
<Payment>
<PayId>7868</PayId>
<TypeId>1</TypeId>
<Amount>707.00</Amount>
<Allocations>
<Allocation>
<AccountId>5047</AccountId>
<Allocated>707.00</Allocated>
</Allocation>
</Allocations>
</Payment>
</Payments>
</Receipt>
</Receipts>
</Response>
5.6. Возвраты - GetRefunds
5.6.1.
Назначение
Получение информации по возвратам платежей.
5.6.2.
Параметры
Параметр
SessionID
RefundId
PracticeId
ProviderId
CuratorId
PayPatientId
DateFrom
DateTo
Тип
Строка
Целое
Целое
Целое
Целое
Целое
Дата
Дата
Описание
Идентификатор сессии
Идентификатор счета на возврат
Идентификатор практики
Идентификатор врача
Идентификатор куратора
Идентификатор пациента-плательщика
Дата счета на возврат не менее
Дата счета на возврат не более
29
Dental 4 Windows API
AccountId
5.6.3.
Технологическая документация
Целое
Идентификатор счета на оплату
Примеры вызова
Получить информацию по счету на возврат по идентификатору:
http://127.0.0.1:5001/ruapi/v1/GetRefunds?SessionID=sva8&RefundId=9729
5.6.4.
Формат ответа
Элемент
Тип
Массив
Refunds
Составной
Refund
Целое
RefundId
Целое
PayPatientId
Дата
RefundDate
Дробное
Total
Целое
PracticeId
Целое
ProviderId
Целое
CuratorId
Массив
Treatments
Составной
Treatment
Целое
TreatId
Дата
TreatDate
Целое
DepartmentId
Целое
ProviderId
Целое
AssistantId
Целое
CuratorId
Строка
ItemCode
Строка
ItemName
Строка
Tooth
Строка
Surface
Целое
Times
Дробное
Fee
Дробное
Rebate
Целое
AccountId
TreatAppointId Целое
Целое
ServiceId
Строка
TreatNotes
Целое
PlanId
Дата
PlanDate
Целое
PlanTimes
Дробное
PlanFee
Дробное
PlanRebate
Целое
Stage
Целое
Visit
Целое
Estimate
Целое
PlanAppointId
Строка
PlanNotes
Дробное
Refunded
30
Описание
Массив записей с информацией по счетам на возврат
Информация по счету на возврат
Идентификатор счета на возврат
Идентификатор пациента-плательщика
Дата счета на возврат
Сумма счета на возврат
Идентификатор практики
Идентификатор врача
Идентификатор куратора
Массив записей с процедурами по счету
Информация по процедуре в счете
Идентификатор процедуры
Дата процедуры
Идентификатор отделения
Идентификатор врача
Идентификатор ассистента
Идентификатор куратора
Код процедуры
Наименование процедуры
Зуб
Поверхность
Количество процедур
Стоимость процедуры
Компенсация по страховке
Идентификатор счета
Идентификатор записи на приём
Идентификатор вида работ
Примечания к процедуре
Идентификатор плана лечения
Плановая дата процедуры
Плановое количество процедур
Плановая стоимость процедуры
Плановая компенсация по страховке
Этап
Визит
Длительность
Идентификатор записи на приём
Примечания к запланированной процедуре
Сумма возврата по процедуре
Dental 4 Windows API
5.6.5.
Технологическая документация
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva8</SessionID>
<RequestID>61</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetRefunds</Resource>
<Params>
<SessionID>sva8</SessionID>
<RefundId>9729</RefundId>
</Params>
<Refunds>
<Refund>
<RefundId>9729</RefundId>
<PayPatientId>5933</PayPatientId>
<RefundDate>2022-12-29</RefundDate>
<Total>-340.00</Total>
<PracticeId>1</PracticeId>
<ProviderId>31</ProviderId>
<CuratorId>1</CuratorId>
<Treatments>
<Treatment>
<TreatId>123988</TreatId>
<TreatDate>2022-12-22</TreatDate>
<PracticeId>1</PracticeId>
<DepartmentId>4</DepartmentId>
<PatientId>5933</PatientId>
<ProviderId>31</ProviderId>
<AssistantId>77</AssistantId>
<ItemId>1154</ItemId>
<ItemCode>1540</ItemCode>
<ItemName>ПУЛЬПИТ ФРОНТ.ЗУБОВ (Пл. Компомеры, Стеклоиномеры)Гр3</ItemName>
<Tooth></Tooth>
<Surface></Surface>
<Times>1</Times>
<Fee>340.00</Fee>
<Rebate>0.00</Rebate>
<Expenses>0.00</Expenses>
<AccountId>9728</AccountId>
<ServiceId>1</ServiceId>
<PlanId>1387</PlanId>
<PlanTimes>0</PlanTimes>
<PlanFee>340.00</PlanFee>
<PlanRebate>0.00</PlanRebate>
<Refunded>340.00</Refunded>
</Treatment>
</Treatments>
</Refund>
</Refunds>
</Response>
31
Dental 4 Windows API
Технологическая документация
6. МЕТОДЫ ПОЛУЧЕНИЯ РАСПИСАНИЯ
6.1. Книги записи - GetAppBooks
6.1.1.
Назначение
Получение информации по книгам записи на прием.
6.1.2.
Параметры
Параметр
SessionID
PracticeId
6.1.3.
Тип
Строка
Целое
Описание
Идентификатор сессии
Идентификатор практики
Примеры вызова
Получить все книги записи для практики:
http://127.0.0.1:5001/ruapi/v1/GetAppBooks?SessionID=sva9&PracticeId=1
6.1.4.
Формат ответа
Элемент
AppBooks
AppBook
Id
Name
6.1.5.
Тип
Массив
Составной
Целое
Строка
Описание
Массив записей с информацией по книгам
Информация по книге
Идентификатор книги записи
Наименование книги записи
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva9</SessionID>
<RequestID>63</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetAppBooks</Resource>
<Params>
<SessionID>sva9</SessionID>
<PracticeId>1</PracticeId>
</Params>
<AppBooks>
<AppBook>
<Id>1</Id>
<Name>Гамов</Name>
<PracticeId>1</PracticeId>
</AppBook>
</AppBooks>
6.2. Расписание - GetAppointments
6.2.1.
Назначение
Получение информации по записи на прием и зарезервированному времени.
32
Dental 4 Windows API
6.2.2.
Технологическая документация
Параметры
Параметр
SessionID
PracticeId
AppBookId
ProviderId
PatientId
DateFrom
DateTo
AppointId
ModifiedFrom
ModifiedTo
6.2.3.
Тип
Строка
Целое
Целое
Целое
Целое
Дата
Дата
Целое
Дата
Дата
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор книги записи
Идентификатор врача
Идентификатор пациента
Дата начала не менее
Дата начала не более
Идентификатор записи расписания
Дата изменения не менее
Дата изменения не более
Примеры вызова
Получить все записи на прием пациента:
http://127.0.0.1:5001/ruapi/v1/GetAppointments?SessionID=sva9&PatientId=1
Получить расписание из книги на дату:
http://127.0.0.1:5001/ruapi/v1/GetAppointments?SessionID=sva9&AppBookId=9&DateFrom=2001-1206&DateTo=2001-12-06
6.2.4.
Формат ответа
Элемент
Appointments
Appointment
AppointId
AppBookId
StartDate
StartTime
Duration
TypeId
ClassId
Statuses
Status
StatusId
Description
Notes
ProviderId
PatientId
CheckdIn
CheckdOut
AppointedBy
AppointCreated
AppointModified
6.2.5.
Тип
Массив
Составной
Целое
Целое
Дата
Время
Целое
Целое
Целое
Массив
Составной
Целое
Строка
Строка
Целое
Целое
Дата
Дата
Целое
Дата Время
Дата Время
Описание
Массив записей с информацией по расписанию
Информация по записи расписания
Идентификатор записи расписания
Идентификатор книги записи
Дата начала
Время начала
Длительность в минутах
Вид резервирования
Класс записи на прием
Массив записей со статусами записи
Информация по статусу записи
Идентификатор статуса записи
Описание резервирования
Примечания
Идентификатор врача
Идентификатор пациента
Дата и время начала визита
Дата и время окончания визита
Идентификатор автора записи на прием
Дата и время создания визита
Дата и время изменения визита
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
33
Dental 4 Windows API
Технологическая документация
<Response>
<SessionID>sva9</SessionID>
<RequestID>74</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetAppointments</Resource>
<Params>
<SessionID>sva9</SessionID>
<AppBookId>9</AppBookId>
<DateFrom>2001-12-06</DateFrom>
<DateTo>2001-12-06</DateTo>
</Params>
<Appointments>
<Appointment>
<AppointId>15120</AppointId>
<AppBookId>9</AppBookId>
<StartDate>2001-12-06</StartDate>
<StartTime>12:00:00.000</StartTime>
<Duration>60</Duration>
<TypeId>12</TypeId>
<Description>Собрание</Description>
</Appointment>
<Appointment>
<AppointId>6853</AppointId>
<AppBookId>9</AppBookId>
<StartDate>2001-12-06</StartDate>
<StartTime>13:00:00.000</StartTime>
<Duration>60</Duration>
<TypeId>6</TypeId>
<ClassId>2</ClassId>
<Statuses>
<Status>
<StatusId>25</StatusId>
</Status>
<Status>
<StatusId>26</StatusId>
</Status>
</Statuses>
<Description>№ 4917 Игнатова Галина 11, 1500; 1730; 1740; 1010 60 мин.</Description>
<ProviderId>31</ProviderId>
<PatientId>4917</PatientId>
</Appointment>
</Appointments>
</Response>
6.3. Отмененные визиты - GetCancellations
6.3.1.
Назначение
Получение информации по отмененным визитам.
6.3.2.
Параметры
Параметр
SessionID
PracticeId
AppBookId
ProviderId
PatientId
DateFrom
DateTo
RegFrom
RegTo
34
Тип
Строка
Целое
Целое
Целое
Целое
Дата
Дата
Дата
Дата
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор книги записи
Идентификатор врача
Идентификатор пациента
Дата записи не менее
Дата записи не более
Дата отмены не менее
Дата отмены не более
Dental 4 Windows API
Целое
CancelId
6.3.3.
Технологическая документация
Идентификатор записи отмены
Примеры вызова
Получить все отмены визитов пациента:
http://127.0.0.1:5001/ruapi/v1/GetCancellations?SessionID=sva10&PatientId=7472
6.3.4.
Формат ответа
Элемент
Тип
Cancellations
Cancellation
CancelId
AppBookId
StartDate
StartTime
Duration
ReasonId
ReasonNote
ClassId
RegDate
RegTime
Statuses
Status
StatusId
Notes
ProviderId
PatientId
Массив
Составной
Целое
Целое
Дата
Время
Целое
Целое
Строка
Целое
Дата
Время
Массив
Составной
Целое
Строка
Целое
Целое
6.3.5.
Описание
Массив записей с информацией об отменах
Информация по записи отмены
Идентификатор записи отмены
Идентификатор книги записи
Дата начала
Время начала
Длительность в минутах
Идентификатор причины отмены
Дополнительная информация по отмене
Класс записи на прием
Дата отмены
Время отмены
Массив записей со статусами записи
Информация по статусу записи
Идентификатор статуса записи
Примечания
Идентификатор врача
Идентификатор пациента
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva10</SessionID>
<RequestID>76</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/GetCancellations</Resource>
<Params>
<SessionID>sva10</SessionID>
<PatientId>7472</PatientId>
</Params>
<Cancellations>
<Cancellation>
<CancelId>2</CancelId>
<AppBookId>9</AppBookId>
<StartDate>2001-12-06</StartDate>
<StartTime>10:00:00.000</StartTime>
<Duration>60</Duration>
<ReasonId>2</ReasonId>
<ReasonNote>Заболел</ReasonNote>
<RegDate>2022-12-30</RegDate>
<RegTime>04:09:51.064</RegTime>
<ClassId>1</ClassId>
<Statuses>
<Status>
<StatusId>33</StatusId>
</Status>
35
Dental 4 Windows API
</Statuses>
<ProviderId>31</ProviderId>
<PatientId>7472</PatientId>
</Cancellation>
</Cancellations>
</Response>
36
Технологическая документация
Dental 4 Windows API
Технологическая документация
7. МЕТОДЫ ПОЛУЧЕНИЯ ИНФОРМАЦИИ ОБ УДАЛЕННЫХ ЗАПИСЯХ
7.1. Удаленные записи на прием - DeletedAppointments
7.1.1.
Назначение
Получение информации по удаленным записям на прием.
7.1.2.
Параметры
Параметр
SessionID
PracticeId
AppBookId
ProviderId
PatientId
DateFrom
DateTo
AppointId
DeletedFrom
DeletedTo
7.1.3.
Тип
Строка
Целое
Целое
Целое
Целое
Дата
Дата
Целое
Дата
Дата
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор книги записи
Идентификатор врача
Идентификатор пациента
Дата начала не менее
Дата начала не более
Идентификатор записи расписания
Дата удаления не менее
Дата удаления не более
Примеры вызова
Получить удаленные записи расписания для практики:
http://127.0.0.1:5001/ruapi/v1/DeletedAppointments?SessionID=sva12&DeletedFrom=2002-0604&DeletedTo=2002-06-04
7.1.4.
Формат ответа
Элемент
Тип
AppointsDeletions
AppointDeleted
AppointId
AppBookId
StartDate
StartTime
Duration
TypeId
Statuses
Status
StatusId
Description
Notes
ProviderId
PatientId
WhenDeleted
Массив
Составной
Целое
Целое
Дата
Время
Целое
Целое
Массив
Составной
Целое
Строка
Строка
Целое
Целое
Дата и время
Описание
Массив удаленных записей
Информация удаленной записи
Идентификатор записи расписания
Идентификатор книги записи
Дата начала
Время начала
Длительность в минутах
Вид резервирования
Массив записей со статусами записи
Информация по статусу записи
Идентификатор статуса записи
Описание резервирования
Примечания
Идентификатор врача
Идентификатор пациента
Дата и время удаления записи
37
Dental 4 Windows API
7.1.5.
Технологическая документация
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva12</SessionID>
<RequestID>108</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/DeletedAppointments</Resource>
<Params>
<SessionID>sva12</SessionID>
<DeletedFrom>2002-06-04</DeletedFrom>
<DeletedTo>2002-06-04</DeletedTo>
</Params>
<AppointsDeletions>
<AppointDeleted>
<AppointId>14922</AppointId>
<AppBookId>6</AppBookId>
<StartDate>2002-06-04</StartDate>
<StartTime>09:00:00.000</StartTime>
<Duration>60</Duration>
<TypeId>6</TypeId>
<Statuses>
<Status>
<StatusId>18</StatusId>
</Status>
</Statuses>
<Description>№ 8850 Фильков Руслан 20, 60 мин.</Description>
<ProviderId>40</ProviderId>
<PatientId>8850</PatientId>
<WhenDeleted>2002-06-04 09:26:51.060</WhenDeleted>
</AppointDeleted>
</AppointsDeletions>
</Response>
7.2. Удаленные счета - DeletedAccounts
7.2.1.
Назначение
Получение информации по удаленным счетам.
7.2.2.
Параметры
Параметр
SessionID
AccountId
PracticeId
PayPatientId
DateFrom
DateTo
DeletedFrom
DeletedTo
7.2.3.
Тип
Строка
Целое
Целое
Целое
Дата
Дата
Дата
Дата
Описание
Идентификатор сессии
Идентификатор счета
Идентификатор практики
Идентификатор пациента-плательщика
Дата счета не менее
Дата счета не более
Дата удаления не менее
Дата удаления не более
Примеры вызова
Получить все удаленные счета для практики:
http://127.0.0.1:5001/ruapi/v1/DeletedAccounts?SessionID=13&PracticeId=1
38
Dental 4 Windows API
7.2.4.
Технологическая документация
Формат ответа
Элемент
Тип
AccountsDeletions
AccountDeleted
AccountId
PayPatientId
AccountDate
Total
PracticeId
Discount
Bonus
Paid
Providers
Provider
ProviderId
WhenDeleted
WhoDeleted
WhereDeleted
Массив
Составной
Целое
Целое
Дата
Дробное
Целое
Дробное
Дробное
Дробное
Массив
Составной
Целое
Дата и время
Целое
Строка
7.2.5.
Описание
Массив удаленных записей
Информация удаленной записи
Идентификатор счета
Идентификатор пациента-плательщика
Дата счета
Сумма счета
Идентификатор практики
Скидка по счету
Скидка бонусами
Сумма оплат
Массив записей с врачами по счету
Информация о враче по счету
Идентификатор врача
Дата и время удаления записи
Идентификатор сотрудника, удалившего запись
Компьютер, с которого произведено удаление
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva13</SessionID>
<RequestID>165</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/DeletedAccounts</Resource>
<Params>
<SessionID>sva13</SessionID>
<PracticeId>1</PracticeId>
</Params>
<AccountsDeletions>
<AccountDeleted>
<AccountId>1</AccountId>
<PayPatientId>4</PayPatientId>
<AccountDate>1999-12-06</AccountDate>
<Total>11.00</Total>
<PracticeId>1</PracticeId>
<Discount>0.00</Discount>
<Bonus>0.00</Bonus>
<Paid>11.00</Paid>
<Providers>
<Provider>
<ProviderId>1</ProviderId>
</Provider>
</Providers>
<WhenDeleted>2002-03-21 07:58:19.254</WhenDeleted>
<WhoDeleted>92</WhoDeleted>
<WhereDeleted>BD-SERVER</WhereDeleted>
</AccountDeleted>
</AccountsDeletions>
</Response>
7.3. Удаленные платежи - DeletedPayments
7.3.1.
Назначение
Получение информации по удаленным квитанциям.
39
Dental 4 Windows API
7.3.2.
Технологическая документация
Параметры
Параметр
SessionID
PracticeId
ProviderId
PayPatientId
DateFrom
DateTo
AccountId
ReceiptId
PayId
DeletedFrom
DeletedTo
7.3.3.
Тип
Строка
Целое
Целое
Целое
Дата
Дата
Целое
Целое
Целое
Дата
Дата
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор ведущего врача
Идентификатор пациента-плательщика
Дата квитанции не менее
Дата квитанции не более
Идентификатор счета
Идентификатор квитанции
Идентификатор платежа
Дата удаления не менее
Дата удаления не более
Примеры вызова
Получить все удаленные квитанции для практики:
http://127.0.0.1:5001/ruapi/v1/DeletedPayments?SessionID=sva15&PracticeId=1
7.3.4.
Формат ответа
Элемент
Тип
ReceiptsDeletions
ReceiptDeleted
ReceiptId
ReceiptDate
ReceiptTime
Total
PayPatientId
PracticeId
ProviderId
Payments
Payment
PayId
TypeId
Amount
CheckName
BankName
BankBranch
Allocations
Allocation
AccountId
Allocated
WhenDeleted
WhoDeleted
WhereDeleted
Массив
Составной
Целое
Дата
Время
Дробное
Целое
Целое
Целое
Массив
Составной
Целое
Целое
Дробное
Строка
Строка
Строка
Массив
Составной
Целое
Дробное
Дата и время
Целое
Строка
40
Описание
Массив удаленных записей
Информация удаленной записи
Идентификатор квитанции
Дата квитанции
Время квитанции
Сумма по квитанции
Идентификатор пациента-плательщика
Идентификатор практики
Идентификатор ответственного врача
Массив записей с информацией по платежам
Информация по платежу
Идентификатор платежа
Вид оплаты
Сумма оплаты
Номер чека
Банк
Отделение банка
Массив записей с информацией по оплаченным счетам
Информация по оплаченному счету
Идентификатор счета
Сумма оплаты по счету
Дата и время удаления записи
Идентификатор сотрудника, удалившего запись
Компьютер, с которого произведено удаление
Dental 4 Windows API
7.3.5.
Технологическая документация
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva15</SessionID>
<RequestID>201</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/DeletedPayments</Resource>
<Params>
<SessionID>sva15</SessionID>
<PracticeId>1</PracticeId>
</Params>
<ReceiptsDeletions>
<ReceiptDeleted>
<ReceiptId>12150</ReceiptId>
<ReceiptDate>2022-12-30</ReceiptDate>
<ReceiptTime>11:05:32.000</ReceiptTime>
<Total>30.00</Total>
<PayPatientId>5933</PayPatientId>
<PracticeId>1</PracticeId>
<Payments>
<Payment>
<PayId>12974</PayId>
<TypeId>10</TypeId>
<Amount>10.00</Amount>
<CheckName>Нина 10.00, квитанция: 12148</CheckName>
<Allocations>
<Allocation>
<AccountId>9730</AccountId>
<Allocated>10.00</Allocated>
</Allocation>
</Allocations>
</Payment>
</Payments>
<WhenDeleted>2022-12-30 11:33:59.402</WhenDeleted>
<WhereDeleted>COMP3047</WhereDeleted>
</ReceiptDeleted>
</ReceiptsDeletions>
</Response>
7.4. Удаленные пациенты - DeletedPatients
7.4.1.
Назначение
Получение информации по удаленным пациентам.
7.4.2.
Параметры
Параметр
SessionID
PracticeId
ProviderId
CuratorId
PatientId
FamilyHeadId
CardNum
RegFrom
RegTo
DeletedFrom
DeletedTo
Тип
Строка
Целое
Целое
Целое
Целое
Целое
Строка
Дата
Дата
Дата
Дата
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор ведущего врача
Идентификатор куратора
Идентификатор пациента
Идентификатор главы семьи
Номер амбулаторной карты
Дата первичного визита не менее
Дата первичного визита не более
Дата удаления не менее
Дата удаления не более
41
Dental 4 Windows API
7.4.3.
Технологическая документация
Примеры вызова
Получить всех удаленных пациентов для практики:
http://127.0.0.1:5001/ruapi/v1/DeletedPatients?SessionID=sva15&PracticeId=1
7.4.4.
Формат ответа
Элемент
Тип
PatientsDeletions
PatientDeleted
PatientId
FamilyHeadId
CardNum
Surname
Firsname
Middlename
PreferredName
BirthDate
Sex
Address
HomePhone
MobilePhone
WorkPhone
Email
FirstVisitDate
DiscountDef
PracticeId
ProviderId
CuratorId
WhenDeleted
WhoDeleted
WhereDeleted
Массив
Составной
Целое
Целое
Строка
Строка
Строка
Строка
Строка
Дата
Целое
Строка
Строка
Строка
Строка
Строка
Дата
Дробное
Целое
Целое
Целое
Дата и время
Целое
Строка
7.4.5.
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva15</SessionID>
<RequestID>206</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/DeletedPatients</Resource>
<Params>
<SessionID>sva15</SessionID>
<PracticeId>1</PracticeId>
</Params>
<PatientsDeletions>
<PatientDeleted>
<PatientId>918</PatientId>
<FamilyHeadId>918</FamilyHeadId>
<CardNum>918</CardNum>
<Surname>Баландина</Surname>
<Firstname>О.</Firstname>
<Middlename>И.</Middlename>
<PreferredName></PreferredName>
<Sex>0</Sex>
<Address></Address>
42
Описание
Массив удаленных записей
Информация удаленной записи
Идентификатор пациента
Идентификатор пациента – главы семьи
Номер амбулаторной карты
Фамилия
Имя
Отчество
Обращение
Дата рождения
1=женский, 0=мужской
Адрес
Домашний телефон
Мобильный телефон
Рабочий телефон
Адрес электронной почты
Дата первого визита
Скидка в % по умолчанию
Идентификатор практики
Идентификатор ведущего врача
Идентификатор куратора
Дата и время удаления записи
Идентификатор сотрудника, удалившего запись
Компьютер, с которого произведено удаление
Dental 4 Windows API
Технологическая документация
<FirstVisitDate>2000-08-05</FirstVisitDate>
<DiscountDef>0.0</DiscountDef>
<PracticeId>1</PracticeId>
<ProviderId>1</ProviderId>
<WhenDeleted>2002-04-02 11:28:04.165</WhenDeleted>
<WhoDeleted>73</WhoDeleted>
<WhereDeleted>USER315</WhereDeleted>
</PatientDeleted>
</PatientsDeletions>
</Response>
7.5. Удаленные записи плана и курса лечения - DeletedTreatments
7.5.1.
Назначение
Получение информации по удаленным записям плана и курса лечения.
7.5.2.
Параметры
Параметр
SessionID
PracticeId
ProviderId
PatientId
AccountId
DateFrom
DateTo
PlanId
TreatId
DeletedFrom
DeletedTo
7.5.3.
Тип
Строка
Целое
Целое
Целое
Целое
Дата
Дата
Целое
Целое
Дата
Дата
Описание
Идентификатор сессии
Идентификатор практики
Идентификатор ведущего врача
Идентификатор пациента
Идентификатор счета
Дата лечения не менее
Дата лечения не более
Идентификатор плана лечения
Идентификатор процедуры
Дата удаления не менее
Дата удаления не более
Примеры вызова
Получить все удаленные записи плана и курса лечения для практики:
http://127.0.0.1:5001/ruapi/v1/DeletedTreatments?SessionID=sva15&PracticeId=1
7.5.4.
Формат ответа
Элемент
TreatsDeletions
TreatDeleted
TreatId
TreatDate
PracticeId
DepartmentId
PatientId
ProviderId
AssistantId
ItemCode
ItemName
Tooth
Surface
Тип
Массив
Составной
Целое
Дата
Целое
Целое
Целое
Целое
Целое
Строка
Строка
Строка
Строка
Описание
Массив удаленных записей
Информация удаленной записи
Идентификатор процедуры
Дата процедуры
Идентификатор практики
Идентификатор отделения
Идентификатор пациента
Идентификатор врача
Идентификатор ассистента
Код процедуры
Наименование процедуры
Зуб
Поверхность
43
Dental 4 Windows API
Times
Fee
Rebate
AccountId
ServiceId
TreatNotes
PlanId
PlanDate
PlanTimes
PlanFee
PlanRebate
Stage
Visit
Estimate
PlanAppointId
PlanNotes
WhenDeleted
WhoDeleted
WhereDeleted
7.5.5.
Технологическая документация
Целое
Дробное
Дробное
Целое
Целое
Строка
Целое
Дата
Целое
Дробное
Дробное
Целое
Целое
Целое
Целое
Строка
Дата и время
Целое
Строка
Количество процедур
Стоимость процедуры
Компенсация по страховке
Идентификатор счета
Идентификатор вида работ
Примечания к процедуре
Идентификатор плана лечения
Плановая дата процедуры
Плановое количество процедур
Плановая стоимость процедуры
Плановая компенсация по страховке
Этап
Визит
Длительность
Идентификатор записи на приём
Примечания к запланированной процедуре
Дата и время удаления записи
Идентификатор сотрудника, удалившего запись
Компьютер, с которого произведено удаление
Пример ответа
<?xml version="1.0" encoding="Windows-1251"?>
<Response>
<SessionID>sva15</SessionID>
<RequestID>217</RequestID>
<Result>OK</Result>
<Resource>ruapi/v1/DeletedTreatments</Resource>
<Params>
<SessionID>sva15</SessionID>
<PracticeId>1</PracticeId>
</Params>
<TreatsDeletions>
<TreatDeleted>
<TreatId>123985</TreatId>
<PracticeId>1</PracticeId>
<DepartmentId>4</DepartmentId>
<PatientId>5933</PatientId>
<ProviderId>31</ProviderId>
<AssistantId>77</AssistantId>
<ItemId>8902</ItemId>
<ItemCode>1000</ItemCode>
<ItemName>ПЕРВИЧНЫЙ ОСМОТР, КОНСУЛЬТАЦИЯ</ItemName>
<Times>1</Times>
<Fee>11.00</Fee>
<Rebate>0.00</Rebate>
<Expenses>0.00</Expenses>
<ServiceId>1</ServiceId>
<PlanId>1387</PlanId>
<PlanDate>2022-12-22</PlanDate>
<PlanTimes>1</PlanTimes>
<PlanFee>11.00</PlanFee>
<PlanRebate>0.00</PlanRebate>
<Stage>1</Stage>
<WhenDeleted>2022-12-30 12:51:36.867</WhenDeleted>
<WhereDeleted>COMP3047</WhereDeleted>
</TreatDeleted>
</TreatsDeletions>
</Response>
44