api-doc

Методы API для ДЭЗО

1. Сценарии работы внешней системы с API для ДЭЗО
   • Базовый сценарий работы c записями
   • Сценарий работы с вложениями
2. Методы API
   • Получение документов ДЭЗО
   • Поисковые функции для медицинских записей
   • Работа со статусами записей
   • Работа со справочниками
   • Работа с пациентами
   • Работа с медицинскими записями
   • Работа с вложениями к записям (attachment)

---

Сценарии работы внешней системы с API для ДЭЗО

Базовый сценарий работы c записями

1. Посредством пользовательского интерфейса ОНКОР создается запись Заявка на ДЭЗО (Rc.RcTm66Order)
2. Поиск новых заявок на ДЭЗО с конкретной даты (или без нее) - по текущее время Получаем ID задачи (SearchJob.id) используя который отдельным запросом, можно постранично получать данные
3. Постраничное получение заявок, найденных в запросе (п.2) Запрос: page.job.id - ID задачи; page.offset - смещение от 0 объекта содержимого задачи; page.size - количество требумых объектов. Ответ: result.page.job.ready=false - задача еще не закончила обрабатывать запрос, необходимо повторить этот метод через некоторое время; result.size=X - фактическое количество объектов в задаче без учета page.offset
4. Получение информации о пациенте
5. Установка статуса “Обработка началась”
6. Установка статуса “DICOM ассоциирован с заказом”
7. Выполнение ДЭЗО I. Отказ в проведении ДЭЗО II. Сформировано заключение - Сначала передается сформированный файл заключения и, по мере необходимости, файл открепленной ЭЦП к первому файлу. Полученные файлов, используются в запросе передачи заключения 1. Передача файла(-ов) заключения (файл протокола заключения и открепленно ЭЦП) 2. Передача заключения со ссылкой на ранее переданные файлы заключения
8. Проведена экспертиза DICOM
9. Проведена экспертиза первичного протокола исследования

Сценарий работы с вложениями

1. Загрузка файла - Загрузка файла для прикрепления к записи (документа) производится до момента непосредственного прикрепления
2. Прикрепление файла к записи - При использовании метода [attachment/create] получаем значение {attachment.id}, его указываем для прикрепления в других API-методах
3. Получение мета-информации о прикрепленных файлах
   • /attachment/get - получаем и мета-информацию и сами данные файла в формате Base64 в поле Attachment.data
   • /attachment/query - получаем только мета-информацию о нескольких вложениях
4. Получение файла
   • /attachment/get - получаем и мета-информацию о файле и сами данные файла
   • /attachment/file - получаем сам файл
5. Прямая ссылка на файл - зная мета-информацию о файле можно сформировать прямую ссылку на файл вида /attachment/${digest}:${id}"

    Attachment.id :     "#1587:4384" // символ # в итоговом адресе нужно удалить  
    Attachment.digest:  "6e4a3290ff2ab22fed4e747c95678bbf534b41d0"
       
    http:///attachment/6e4a3290ff2ab22fed4e747c95678bbf534b41d0:1587:4384
   

   Attachment.id - не предназначен для долговременного хранения во внешних системах, т.к. id может "устареть" и быть удален. —

   Методы API

Добавление документов ДЭЗО

• /tm66/order/addRcTm66OrderReject - загрузка документа "Отказ в проведении ДЭЗО"
• /tm66/order/addRcTm66OrderConclusion - загрузка документа "Заключение эксперта ДЭЗО"
• /tm66/order/addRcTm66OrderExpertiseDicom - загрузка документа "Экспертиза качества DICOM"
• /tm66/order/addRcTm66OrderExpertiseProtocol - загрузка документа "Экспертиза качества первичного протокола исследования"

Поисковые функции для медицинских записей

• /search/start/RcTm66OrderQuery - поиск заявок на ДЭЗО
• /search/get/RecordsPage - постраничное получение найденных ранее в поисковом запросе записей
• /search/start/RcTm66OrderExpertiseDicomQuery - поиск документов "Экспертиза качества DICOM"
• /search/start/RcTm66OrderExpertiseProtocolQuery - поиск документов "Экспертиза качества первичного протокола исследования""
• /search/start/RcTm66OrderConclusionQuery - поиск докуметов "Заключение эксперта ДЭЗО"

Работа со статусами записей

Работа со статусами записи Заявки на ДЭЗО (Rc.RcTm66Order) в рамках ДЭЗО осуществляется приведенными ниже методами. Статус также обновляется при загрузке документов по этой заявке или по другим событиям

• /rc/getInstanceStatus - получение статуса медицинской записи
• /rc/updateInstanceStatus - установка статуса медицинской записи

Работа со справочниками

• /directory/get/Tm66OrderPurpose - справочник Цель ДЭЗО
• /directory/get/Tm66DiagnosticsType - справочник Тип диагностики ДЭЗО
• /directory/get/Tm66DiagnosticsMethod - справочник Тип инструментальной диагностики в первичном протоколе исследования
• /directory/get/Tm66ConclusionType - справочник Тип заключения ДЭЗО
• /directory/get/Tm66OrderRejectReason - справочник Причины отказа проведения ДЭЗО
• /directory/get/Tm66ExpertProtocolResult - cправочник типа значимости замечаний эксперта к к первичному протоколу исследования
• /directory/get/Tm66ExpertDicomResult - cправочник типа значимости замечаний эксперта к DICOM
• /directory/get/MedOrganization - cправочник медицинских организаций
• /directory/get/MedDepart - cправочник подразделений медицинских организаций
• /directory/get/MedResource - cправочник врачей медицинских организаций

Работа с пациентами

• /patient/get - получение данных пациента по его ключу

Работа с медицинскими записями

• /rc/get - получение медицинской записи пациента по ключу
• ссылка для просмотра документов в пользовательском интерфейсе

Работа с вложениями к записям

• /attachment/create - загружаем новый файл
• /attachment/get - получаем и мета-информацию и сам файл в формате ByteString в поле Attachment.data
• /attachment/query - получаем только мета-информацию о нескольких файлах
• /attachment/file - получаем сам файл