ОБЩАЯ ИНФОРМАЦИЯ
Общее описание
Схема взаимодействия
Определения, обозначения и сокращения
Описание методов
1. Получение МО и филиалов
2. Получение действующих сотрудников МО
3. Получение списка пациентов
3.1. Получение списка пациента по одному параметру
3.2. Получение списка пациента по комбинации параметров lastName, firstName, middleName, birthdate.
4. Получение данных пациента по идентификатору
Приложение 1. Справочник «Типы должностей»
Приложение 2. Справочник «Типы документов»
Приложение 3. Примеры обращения к сервису
ОБЩАЯ ИНФОРМАЦИЯ
Общее описание
Сервис предназначен для получения структуры организаций, перечня сотрудников в разрезе структурных подразделений, поиска пациентов, а также получения расширенной информации о пациентах.
Веб-API построен по архитектуре REST, использует JSON в качества формата для обмена.
Схема взаимодействия
- Клиент из сторонней МИС формирует HTTP-запрос, содержащий параметры.
- Веб-сервис содержит отдельные методы для получения различных структур данных.
- При обращении API формирует запросы к БД в соответствии с методом и параметрами и собирает данные в виде структур в формате JSON.
- Веб-сервис возвращает синхронный ответ с кодом состояния HTTP 200, содержащий ответ в формате, описанном ниже. Ошибки так же возвращаются с кодом HTTP 200 и содержат текст сообщения об ошибках.
Определения, обозначения и сокращения
№ п/п | Сокращение | Определение |
1 | 2 | 3 |
1. | МО | Медицинская организация |
2. | МИС | Медицинская информационная система |
3. | ТИС | Телемедицинская информационная система |
4. | БД | База данных |
5. | API | Интерфейс программирования приложений (application programming interface) |
6. | ИС | Информационная система |
7. | JSON | JavaScript Object Notation — текстовый формат обмена данными |
Описание методов
№ | Описание метода | Метод | Передаваемые параметры | Комментарий |
1. | Получение МО и филиалов | GET /departments | Возвращает список МО и филиалов. | |
2. | Получение действующих сотрудников МО | GET | departmentId | Возвращает данные о действующих сотрудниках МО. |
3. | Получение списка пациентов | GET /find_patients | findstr, | Возвращает данные о пациентах. |
4. | Получение данных пациента по идентификатору | GET | patid | Возвращает расширенные данные о пациенте. |
Получение МО и филиалов
Метод HTTP: GET /forTis/departments
Параметры ответа приведены в таблице 1.1.
Выходные данные | Тип | Описание |
id | guid | Идентификатор МО |
parentId | guid | Идентификатор вышестоящего подразделения |
code | string | Региональный код или код ТФОМС |
fullname | string | Полное наименование |
shortname | string | Краткое наименование |
type | string | Тип подразделения:
|
inn | string | ИНН |
kpp | string | КПП |
ogrn | string | ОГРН |
address | dictionary | |
type | string |
|
display | string | Адрес строкой |
latitude | string | Широта, при наличии |
longitude | string | Долгота, при наличии |
contacts | dictionary | |
type | string | Тип контакта: - для МО: «Телефон»
|
display | string | Контакт строкой |
Получение действующих сотрудников МО
Данный метод возвращает перечень полей о сотрудниках МО в разрезе филиалов. В запросе может быть указан идентификатор (id) филиала или МО, полученный в методе departments, тогда будет получен перечень сотрудников всех ее филиалов, либо идентификатор филиала, для получения данных в рамках подразделения.
Метод HTTP: GET /forTis/workers
Параметры запроса приведены в таблице 2.1.
Параметры | Тип | Описание |
departmentid | guid | Идентификатор МО / Идентификатор филиала |
Параметры ответа приведены в таблице 2.2.
Выходные данные | Тип | Описание |
id | guid | Идентификатор сотрудника |
SNILS | string | Снилс сотрудника |
lastName | string | Фамилия сотрудника |
firstName | string | Имя сотрудника |
middleName | string | Отчество сотрудника |
birthDate | date | Дата рождения сотрудника |
dateBegin | date | Дата начала работы |
dateEnd | date | Дата окончания работы |
positions | dictionary | |
id | guid | Идентификатор сотрудника в связке с должностью |
dateBegin | date | Дата начала работы |
departmentId | guid | Идентификатор МО / филиала |
departmentName | string | Наименование МО / филиала |
positionName | string | Тип должности. Наименование (справочник в приложении 1) |
positionRate | Число, количество ставок | |
positionFedCode | string | Тип должности. Код (справочник в приложении 1) |
positionRegName | string | ФРМР. Должности медицинского персонала |
positionSpecialityCode | string | Код специальности по справочнику V021. Классификатор медицинских специальностей (справочник ТФОМС) |
positionSpecialityName | string | Наименование специальности по справочнику V021 |
contacts | dictionary | |
type | string | Тип контакта: |
display | string | Номер телефона или email строкой |
Получение списка пациентов
Поиск пациента возможен по точному совпадению одного из параметров: findstr, snils, docnum. При отсутствии данных параметров поиск производится по комбинации параметров lastName, firstName, middleName, birthdate.
Метод HTTP: GET /forTis/find_patients
3.1. Получение списка пациента по одному параметру
Параметры запроса приведены в таблице 3.1.
Параметры | Тип | Описание |
findstr | string |
|
snils | string | Номер снилс |
docnum | string | Номер паспорта/ Номер полиса ОМС |
3.2. Получение списка пациента по комбинации параметров lastName, firstName, middleName, birthdate.
Корректный запрос должен содержать не менее 2-х параметров. Параметры запроса приведены в таблице 3.2.
Параметры | Тип | Описание |
lastName | string | Фамилия пациента* |
firstName | string | Имя пациента* |
middleName | string | Отчество пациента* |
birthDate | string | Дата рождения |
*для ФИО достаточно частичного совпадения по первым буквам
Параметры ответа приведены в таблице 3.
Выходные данные | Тип | Описание |
id | guid | Идентификатор пациента |
lastName | string | Фамилия пациента |
firstName | string | Имя пациента |
middleName | string | Отчество пациента |
gender | string | Пол |
birthDate | string | Дата рождения |
documents | dictionary | |
type | string | Тип документа. Наименование (справочник в приложении 2) |
series | string | Серия документа |
number | string | Номер документа |
address | dictionary | |
type | string | Тип адрес пациента по прописке/проживанию |
display | string | Адрес строкой |
Получение данных пациента по идентификатору
Метод HTTP: GET /forTis/patient
Параметры запроса приведены в таблице 4.1.
Параметры | Тип | Описание |
patid | guid | Идентификатор пациента (полученный в методе find_patient) |
Параметры ответа приведены в таблице 4.2.
Выходные данные | Тип | Описание |
id | guid | Идентификатор пациента |
SNILS | string | СНИЛС пациента |
lastName | string | Фамилия пациента |
firstName | string | Имя пациента |
middleName | string | Отчество пациента |
gender | string | Пол |
birthDate | string | Дата рождения |
documents | dictionary | |
type | string | Тип документа. Наименование (справочник в приложении 2) |
series | string | Серия документа |
number | string | Номер документа |
dateIssued | date | Дата выдачи документа, удостоверяющего личность |
dateBegin | date | Дата выдачи полиса ОМС (если type - Полис ОМС) |
address | dictionary | |
type | string | Тип адрес пациента по проживанию: |
display | string | Адрес строкой |
monitoring | dictionary | |
_ | string | Информация о состоянии на Д-учете |
diagnosis | string | Код диагноза в кодировке МКБ-10 |
dateBegin | date | Дата постановки на Д-учет |
dateEnd | date | Дата снятия с Д-учета |
contacts | dictionary | |
type | string | Тип контакта: Телефон / Электроннный адрес / |
display | string | Контакт строкой |
Приложение 1. Справочник «Типы должностей»
Код | Наименование |
1001 | Главный врач (директор, завед., начальник) |
1002 | Главный врач центра ГСЭН-гл.гос.сан.врач |
1003 | Заведующий-провизор |
1004 | Заместитель главного врача |
1005 | Заместитель главного врача центра ГСЭН |
1006 | Заместитель заведующего-провизор |
2001 | Заведующий (начальник) |
2002 | Заведующий приемным отделением |
2003 | Заведующий орг.-метод.отделом |
2004 | Заведующий сан.-гигиеническим отделом |
2005 | Заведующий лабораторией |
3009 | Врач-акушер-гинеколог |
3010 | Врач-акушер-гинеколог цех.врач.уч. |
3011 | Врач-аллерголог-иммунолог |
3012 | Врач-анестезиолог-реаниматолог |
3013 | Врач-гастроэнтеролог |
3014 | Врач-гематолог |
3015 | Врач-генетик |
3016 | Врач-гериатр |
3017 | Врач-дерматовенеролог |
3018 | Врач-детский онколог |
3019 | Врач-детский хирург |
3020 | Врач-детский эндокринолог |
3021 | Врач-диабетолог |
3022 | Врач-диетолог |
3023 | Врач-инфекционист |
3024 | Врач-кардиолог |
3025 | Врач клинической лабораторной диагностики |
3025 | Врач-детский кардиолог |
3026 | Врач-клинический фармаколог |
3027 | Врач-колопроктолог |
3028 | Врач-лаборант-генетик |
3029 | Врач по лечебной физкультуре |
3030 | Врач по спортивной медицине |
3031 | Врач-методист |
3032 | Врач мануальной терапии |
3033 | Врач-невролог |
3034 | Врач-нейрохирург |
3035 | Врач-нефролог |
3036 | Врач общей практики (семейный врач) |
3037 | Врач-онколог |
3038 | Врач-оториноларинголог |
3039 | Врач-офтальмолог |
3040 | Врач-офтальмолог-протезист |
3041 | Врач-патологоанатом |
3042 | Врач-педиатр |
3043 | Врач-педиатр участковый |
3044 | Врач-педиатр городской (районный) |
3045 | Врач-неонатолог |
3046 | Врач приемного отделения |
3047 | Врач-профпатолог |
3048 | Врач-психотерапевт |
3049 | Врач-психиатр |
3050 | Врач-психиатр участковый |
3051 | Врач-психиатр детский |
3052 | Врач-психиатр детский участковый |
3053 | Врач-психиатр подростковый |
3054 | Врач-психиатр подростковый участковый |
3055 | Врач-психиатр-нарколог |
3057 | Врач-пульмонолог |
3058 | Врач-радиолог |
3059 | Врач-рентгенолог |
3060 | Врач-ревматолог |
3061 | Врач-рефлексотерапевт |
3062 | Врач-сексолог |
3063 | Врач-сердечно-сосудистый хирург |
3064 | Врач скорой медицинской помощи |
3065 | Врач-статистик |
3066 | Врач-судебно-медицинский эксперт |
3067 | Врач-судебно-психиатрический эксперт |
3068 | Врач-сурдолог-оториноларинголог |
3069 | Врач-сурдолог-протезист |
3070 | Врач-терапевт |
3071 | Врач-терапевт участковый |
3072 | Врач-терапевт подростковый |
3073 | Врач-терапевт участковый цех.врач.уч. |
3074 | Врач здравпункта |
3075 | Судовой врач |
3076 | Врач-токсиколог |
3077 | Врач-торакальный хирург |
3078 | Врач-травматолог-ортопед |
3079 | Врач-трансфузиолог |
3080 | Врач ультразвуковой диагностики |
3081 | Врач-уролог |
3082 | Врач-физиотерапевт |
3083 | Врач-фтизиатр |
3084 | Врач-фтизиатр участковый |
3085 | Врач функциональной диагностики |
3086 | Врач-хирург |
3087 | Врач-эндокринолог |
3088 | Врач-эндоскопист |
3089 | Врач-бактериолог |
3090 | Врач-вирусолог |
3091 | Врач по гигиене детей и подростков |
3092 | Врач по гигиене питания |
3093 | Врач по гигиене труда |
3094 | Врач по гигиеническому воспитанию |
3095 | Врач-дезинфектолог |
3096 | Врач по коммунальной гигиене |
3097 | Врач по общей гигиене |
3098 | Врач-паразитолог |
3099 | Врач по радиационной гигиене |
3100 | Врач по сан.-гиг.лабораторным исслед. |
3101 | Врач-эпидемиолог |
3102 | Врач-ортодонт |
3103 | Врач-стоматолог |
3104 | Врач-стоматолог детский |
3105 | Врач-стоматолог-терапевт |
3106 | Врач-стоматолог-ортопед |
3107 | Врач-стоматолог-хирург |
3108 | Врач-челюстно-лицевой хирург |
3109 | Провизор-технолог |
3110 | Провизор-аналитик |
3111 | Логопед |
3995 | Врач - ЭКГ |
3999 | Врач-логопед |
4001 | Директор больницы сестр.ухода, хосписа |
4002 | Заведующая молочной кухней |
4003 | Главная медицинская сестра |
4004 | Старшая медицинская сестра АПУ |
4005 | Старший фельдшер |
4006 | Фельдшер |
4007 | Заведующий ФАП-фельдшер |
4008 | Заведующий здравпунктом-фельдшер |
4009 | Заведующий медпунктом-фельдшер |
4010 | Старшая акушерка |
4011 | Акушерка |
4012 | Заведующий ФАП-акушерка |
4013 | Зубной врач |
4014 | Зав.производ.учрежд.зубопротезирования |
4015 | Старший зубной техник |
4016 | Зубной техник |
4017 | Помощник врача эпидемиолога(паразитолога) |
4018 | Помощник санитарного врача |
4019 | Инструктор-дезинфектор |
4020 | Инструктор по санитарному просвещению |
4021 | Помощник энтомолога |
4022 | Медицинский технолог |
4023 | Медицинский лабораторный техник |
4024 | Фельдшер-лаборант |
4024 | врач-лаборант |
4025 | Лаборант |
4026 | Заведующий аптечным учреждением |
4027 | Старший фармацевт |
4028 | Фармацевт |
4029 | Старшая медицинская сестра |
4030 | Медицинская сестра/медицинский брат |
4030 | Медицинская сестра |
4031 | Палатная медицинская сестра |
4032 | Процедурная медицинская сестра |
4033 | Медицинская сестра перевязочной |
4033 | Медицинская сестра/медицинский брат перевязочной |
4034 | Заведующий ФАП-медицинская сестра |
4035 | Заведующий здравпунктом-мед.сестра |
4036 | Заведующий медпунктом-мед.сестра |
4037 | Старшая операционная медицинская сестра |
4038 | Операционная медицинская сестра |
4039 | Медицинская сестра-анестезист/медицинский брат-анестезист |
4039 | Медицинская сестра-анестезист |
4040 | Медицинская сестра/медицинский брат ВОП |
4040 | Медицинская сестра ВОП |
4041 | Рентгенолаборант |
4042 | Медицинская сестра по физиотерапии |
4042 | Медицинская сестра/медицинский брат по физиотерапии |
4043 | Медицинская сестра по массажу |
4043 | Медицинская сестра по массажу |
4043 | Медицинский брат по массажу |
4044 | Инструктор по лечебной физкультуре |
4045 | Медицинская сестра диетическая/медицинский брат диетический |
4045 | Медицинская сестра диетическая |
4046 | Медицинский статистик |
4047 | Медицинский психолог |
4048 | Логопед |
4049 | Медицинская сестра участковая |
7101 | Директор дома сестр.ухода, хосписа, мол.кухни |
7102 | Зам.гл.врача по работе с сестр.персоналом |
7103 | Главная медицинская сестра (акушерка) |
7109 | Заведующая гор.кабинетом иммунопрофилактики |
7201 | Зав.отделением сестр.ухода, мед.-соц.помощи |
7202 | Зав.орг.-метод.отделом |
7203 | Зав.отделом медицинской статистики |
7204 | Медицинский статистик |
7205 | Медицинский регистратор |
7301 | Специалисты центров общей врачебной практики |
7302 | Менеджер по организации внебюдж.деятельности |
7303 | Секретарь |
7303 | Техник ПК |
7304 | Врач-детский уролог-андролог |
9000 | Врач общепрофильной бригады СМП |
9001 | Врач специализированной бригады СМП |
9002 | Фельдшер выездной бригады СМП |
9991 | Акушерка ФАП |
9992 | Медицинская сестра/медицинский брат ФАП |
9993 | Фельдшер ФАП |
9994 | Врач по рентгенэндоваскулярным диагностике и лечению |
9999 | Врач антикоагулянтного кабинета |
9999 | Председатель врачебной комиссии |
9999 | Врач - остеопат |
Приложение 2. Справочник «Типы документов»
Код | Короткое наименование |
2 | Паспорт РФ |
3 | Свид. о рожд. РФ |
4 | Удост. личности офицера |
5 | Военный билет |
6 | Вид на жительство. |
7 | Удост. беженца РФ |
8 | Спр. об освобожд. |
9 | Прочие |
10 | Паспорт гражд. СССР |
11 | Загранпаспорт гражд. СССР |
12 | Свид. о рег. ходат. о призн. иммигранта беженцем |
13 | Дипломат. паспорт гражд. РФ |
14 | Паспорт Минморфлота |
15 | Паспорт моряка |
16 | Иностранный паспорт |
17 | Врем. удост. лич. гражданина РФ |
18 | Загранпаспорт гражданина РФ |
19 | Воен. билет офиц. запаса |
20 | Документ иностранного гражданина |
21 | Документ лица без гражданства |
22 | Разрешение на временное проживание |
23 | Свидетельство о рождении, выданное не в РФ |
24 | Свидетельство о предоставлении временного убежища на территории Российской Федерации |
25 | Удостоверение сотрудника Евразийской экономической комиссии |
26 | Копия жалобы о лишении статуса беженца |
27 | Иной документ, соответствующий свидетельству о предоставлении убежища на территории Российской Федерации |
Приложение 3. Примеры обращения к сервису
- Получение МО и филиалов
Пример запроса:
Пример ответа:
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4ad8ab9a-03cc-4159-a101-c793f6472639"><ac:plain-text-body><![CDATA[ | [ |
- Получение действующих сотрудников МО
Пример запроса:
Пример ответа:
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6fcb0475-3ffa-4151-bdd6-62ef9921fcf0"><ac:plain-text-body><![CDATA[ | [ |
- Получение списка пациентов
Пример запроса:
Пример ответа:
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a1a85597-97a1-49c5-8714-2c035cfe22aa"><ac:plain-text-body><![CDATA[ | [ |
- Получение данных пациента по идентификатору
Пример запроса:
Пример ответа:
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="765d4465-6ae9-43c2-b651-847ebfdcae22"><ac:plain-text-body><![CDATA[ | [ |