Метод предназначен для получения актуальных сведений о плане медицинского осмотра пациента.
Метод возвращает информацию о приглашениях, о текущих и прошедших мероприятиях диспансеризации.
Запрос
Адрес запроса
GET: /api/v2/epgu/disp |
Параметры запроса
Параметр | Тип | Описание | По умолчанию | Обязательный | Комментарий |
---|---|---|---|---|---|
medicalExaminationType | path | Фильтрация типов диспансеризации | - | - | Если не указан - выводятся все доступные мероприятия dispensary - выводятся мероприятия по приглашению profexam - выводятся мероприятия не требующие приглашений |
Заголовки запроса
Заголовок | Значение (тип/формат значения) | Описание | Обязательный |
---|---|---|---|
Authorization | Bearer {codToken} (без скобок и через пробел после Bearer) | COD токен, полученный с помощью сервиса авторизации | + |
Ответ сервера
В случае успешного выполнения сервер вернет ответ в формате JSON со следующими данными:
Модель: Array of MedicalExamination
Представляет собой hlt_disp_Card
Описание полей
Название | Тип данных | Описание | Комментарий |
---|---|---|---|
medicalExaminationType | string | Тип медицинского осмотра | Тип медицинского осмотра. Строка из 100 символов. Элемент условно обязательный. Может принимать следующие значения: DISPENSARY – 1 этап диспансеризации. Возможные значения данного элемента будут расширены при развитии услуги «Запись для прохождения профилактических медицинских осмотров, диспансеризации» |
cardGuid | string | Идентификатор карты диспансеризации | Идентификатор карты диспансеризации. UUID. Элемент условно обязательный |
code | string | Код типа диспансеризации | Код типа диспансеризации. Строка Элемент условно обязательны. |
name | string | Наименование типа диспансеризации | Наименование типа диспансеризации. Строка Элемент условно обязательны. |
typeGuid | string | Идентификатор типа диспансеризации | Идентификатор типа диспансеризации. Строка в формате UUID Элемент условно обязательны. |
dispStatus | string | Статус прохождения диспансеризации Invite - Пациент приглашен Process - Диспансеризация в процессе прохождения Success - Диспансеризация пройдена | Элемент условно обязательны. |
dateClosed | string | Дата закрытия карты диспансеризации | Строка в формате ГГГГ-ММ-ДД. Проставляется только для диспансеризаций со статусом Success. Для всех остальных имеет значение null. |
needQuestionnaire | bool | Флаг необходимости заполнения анкеты | true - необходимо заполнить анкету false - анкета уже заполнена либо тип диспансеризации не предусматривает прохождение анкетирования |
service | Array of ServiceType | Услуги для предварительной записи | Комплексный тип. Элемент условно обязательный. |
Возможные ошибки
Код ответа сервера | Код сообщения | Сообщение | Тип ошибки |
---|---|---|---|
403 | 5010 | Запрос должен содержать 'Authorization: Bearer ...'" | Error |
403 | 5008 | Токен некорректен | Error |
403 | 5007 | Время действия токена истекло | Error |
403 | 5009 | Подпись запроса некорректна | Error |
В случае возникновения ошибок будет возвращен стандартный ответ сервера;
В случае возникновения ошибок валидации сервер вернет стандартное сообщение валидации.