Руководство к использованию стандарта FHIR в ЦИСЗ
0.2.6803 - ci-build
Руководство к использованию стандарта FHIR в ЦИСЗ
0.2.6803 - ci-build
| Официальный URL: https://fhir.by/OperationDefinition/get-bundle | ||||
| Unknown as of 2026-06-25 | Имя: get-bundle | |||
Операция получения электронного документа из ЦИСЗ. Позволяет получить ресурс Bundle являющийся электронным документом, по его идентификатору
Операция позволяет получить электронный документ (далее - ЭД) в одном из трех форматов (cms, html, json).
Доступные форматы для разных видов ЭД:
| Код ЭД | JSON | CMS | HTML |
|---|---|---|---|
| 01 | + | + | + |
| 02 | - | - | - |
| 03 | - | - | - |
| 04 | + | + | - |
| 05 | + | + | - |
Код вида ЭД задается значением из справочника Вид электронного документа (DigitalDocumentKind).
Только авторизованный пользователь может получить информацию об ЭД.
Вызов операции осуществляется с помощью HTTP GET команды.
1. для получения ресурса в формате cms:
**Header**
Accept: app/cms
GET [FHIR_BASE]/Bundle/$get-bundle?identifier=[identifier]
В случае успешного выполнения операции система возвращает:
cms.2. для получения ресурса в формате html:
**Header**
Accept: text/html
GET [FHIR_BASE]/Bundle/$get-bundle?identifier=[identifier]
В случае успешного выполнения операции система возвращает:
html страницы.3. для получения ресурса в формате json:
**Header**
Accept: app/json
GET [FHIR_BASE]/Bundle/$get-bundle?identifier=[identifier]
В случае успешного выполнения операции система возвращает:
Bundle в формате json.В случае возникновения ошибок, система возвращает ресурс OperationOutcome с соответствующим описанием ошибки:
1. если введенный идентификатор не найден:
HTTP code 200 OK
issue
severity = warning
code = not-found
details
text = "Электронный документ с идентификатором {identifier} не существует."
2. если идентификатор не был указан в запросе:
HTTP code 400 Bad Request
issue
severity = error
code = required
details
text = "Не задан обязательный параметр - identifier."
3. если заданный формат в Accept не соответствует разрешенным кодам:
HTTP code 400 Bad Request
issue
severity : error
code : invalid
details
text = "Формат данных в Accept не соответствует разрешенному переченю. Доступные форматы: app/cms, text/html, app/json."
4. если заданный формат в Accept не поддерживается для данного вида ЭД:
HTTP code 200 OK
issue
severity : error
code : not-supported
details
text = "Формат данных в Accept не соответствует разрешенному переченю для выбранного вида Электронного документа. Доступные форматы: [{accpet}]."
5. если Accept не задан в Header:
HTTP code 400 Bad Request
issue
severity : error
code : required
details
text = "Не задан обязательный параметр Header: Accept."
6. если токен организации не соответствует правам, по которым возможно получение ЭД:
HTTP code 403 forbidden
issue
severity = error
code = forbidden
details
text = "Нет прав на получение информации о ЭД {identifier}. Проверьте access token организации."
URL: [base]/$get-bundle
| Использовать | Наименование | Сфера действия | Кардинальность | Тип | Привязка | Документация |
| IN | identifier | 1..1 | Coding | Идентфикатор электронного документа | ||
| IN | accept | 1..1 | code | Атрибут Accept - app/cms, text/html, app/json. Формат ответа, который необходимо получить | ||
| OUT | outcome | 0..1 | OperationOutcome | Овет системы в случае возникновения ошибок |