Basic
Ресурс Basic содержит информацию по одному отовариванию льготного электронного рецепта, достаточную для формирования одной строки Сводного реестра электронных рецептов (счет для оплаты).
Ограничения
Ресурс Basic формируется в рамках операции регистрации отпуска по электронному рецепту (POST MedicationDispense/$register) при успешном отоваривании Льготного ЭР с ЭЦП. В рамках операции отоваривания ЭР ресурс Basic не возвращается.
При создании ресурса Basic ему присваивается статус active. Если отоваривание отменено (через операцию отметки об ошибочности), то ресурс Basic переходит в статус entered-in-error. Для формирования Реестра доступны только ресурсы Basic в статусе active.
Если поле MedicationPrescription.meta.tag.display не заполнено, то при отоваривании клиент получит ошибку 500.
Если не указана ссылка на Location в ресурсе Claim (поле Claim.facility), то Bill не сформируется и это отоваривание не войдет в реестр.
* В ресурсе Claim.facility должна быть указана ссылка на аптеку, которая принадлежит аптечной сети клиента. (В этом ресурсе Location.managingOrganization должен соответствовать данным клиента, выполняющим отоваривание).
1.Операция формирования Сводного реестра льготных электронных рецептов
POST List/$register
Ограничения и логика работы:
- Если не найдено ни одного ресурса Basic в статусе active (Basic.extension:status), удовлетворяющего параметрам запроса, то возвращается статус 400 и OperationOutcome.
- В реестр попадают ресурсы Basic только в статусе active (Basic.extension:status=active).
- Нельзя, чтобы один и тот же ресурс Basic вошел в несколько активных Реестров. В случае пересечения периодов формирования реестра по одинаковым параметрам, возвращается статус 400 и OperationOutcome.
- Если у пациента не указан хотя бы один адрес (Patient.address), то в реестре льготных ЭР информация об адресе будет отсутствовать.
- При формировании реестра нельзя указывать конец периода равный текущей дате, только строго меньше текущей даты (Period.end < текущая дата).
- Формировать Реестр можно только для аптек своей аптечной сети.
Аутентификация
При работе с FHIR-сервером для получения валидного токена аутентификации необходимо запрашивать scope "EHR.List.$register"
Входящие параметры
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| Parameters | 1..1 | Parameters | |
| Parameters.parameter | 1..* | Список аптек, от имени которых необходимо составить сводный реестр льготных ЭР | |
| Parameters.parameter.name | 1..1 | string | Имя параметра (= Location) |
| Parameters.parameter.valueReference | 1..* | Reference(Location) | Ссылка на аптеку |
| Parameters.parameter | 1..1 | Организация-юридическое лицо, которая оплачивает счет согласно реестру | |
| Parameters.parameter.name | 1..1 | string | Имя параметра (= Organization) |
| Parameters.parameter.valueReference | 1..1 | Reference(Organization) | Ссылка на организацию юрлицо |
| Parameters.parameter | 1..1 | Период, за который необходимо сформировать сводный реестр льготных ЭР. Дата начала периода - T00:00, дата конца периода - T23:59. Date |
|
| Parameters.parameter.name | 1..1 | String | Имя параметра (= Period) |
| Parameters.parameter.valuePeriod | 1..1 | Period | Период, за который необходимо сформировать сводный реестр льготных ЭР Period |
Параметры операции передаются в Body в виде ресурса Parameters
Возвращаемый результат
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| Bundle | 1..1 | Bundle | Содержит идентификатор Реестра льготных ЭР; общее число отовариваний, вошедших в Реестр. |
| Bundle.id | 1..1 | id | Идентификатор Реестра льготных ЭР |
| Bundle.total | 1..1 | unsignedInt | Количество ресурсов Basic в ответе (количество отовариваний, вошедших в Реестр) |
| Bundle.link | 1..1 | Element | Ссылки на первую и последнюю страницу Реестра |
Результат возвращается в виде ресурса Bundle
Возвращаемые коды состояния HTTP
- HttpStatusCode 200 OK - при успешном создании реестра
- HttpStatusCode 400 BadRequest - если входящие параметры не прошли правила валидации
- HttpStatusCode 404 NotFound - если не один из ресурсов, необходимых для выполнения операции, не найден
2.Операция получения Сводного реестра льготных электронных рецептов по идентификатору
GET List/{id}/$by-identifier?_page=0&_count=1000
Ограничения и логика работы:
- Возвращаются только активные Реестры.
- Если Реестр с указанным идентификатором не найден или был отменен, то возвращается статус 400 и OperationOutcome.
- {id} - это не guid Реестра, а его числовой идентификатор
Аутентификация
При работе с FHIR-сервером для получения валидного токена аутентификации необходимо запрашивать scope "EHR.List.$by-identifier"
Входящие параметры
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| id | 1..1 | id | Идентификатор сводного реестра льготных ЭР. Не guid Реестра, а его числовой идентификатор |
| _count | 0..1 | int | Количество ресурсов, получаемых одним запросом. |
| _page | 0..1 | int | Идентификатор страницы |
Возвращаемый результат
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| Bundle | 1..1 | unsignedInt | Количество ресурсов Basic в ответе |
| Bundle.link | 1..1 | Resource(List) | Краткая информация о Реестре: идентификатор Реестра, список аптек, организация-юрлицо, дата формирования Реестра, статус Реестра |
| Bundle.entry.Basic | 1..* | Resource(Basic) | Список ресурсов Basic. Basic содержит информацию по одному отовариванию льготного электронного рецепта, достаточную для формирования одной строки Сводного реестра электронных рецептов (счет для оплаты). Сортировка ресурсов Basic в ответе по дате изменения ресурса Basic |
Результат возвращается в виде ресурса Bundle.
Возвращаемые коды состояния HTTP
- HttpStatusCode 200 OK - при успешном получении реестра
- HttpStatusCode 400 BadRequest - если входящие параметры не прошли правила валидации
- HttpStatusCode 404 NotFound - если не один из ресурсов, необходимых для выполнения операции, не найден
3.Операция отметки об ошибочности Сводного реестра льготных электронных рецептов
POST List/{id}/$set-as-error
Ограничения и логика работы:
- Отменить можно только активный Реестр. Если это условие не выполняется, то возвращается статус 400 и OperationOutcome.
- Отменять сформированный реестр может только та организация, которая его создала (аптека в рамках аптечной сети).
Аутентификация
При работе с FHIR-сервером для получения валидного токена аутентификации необходимо запрашивать scope "EHR.List.$set-as-error"
Входящие параметры
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| id | 1..1 | id | Идентификатор сводного реестра льготных ЭР, который следует отменить. |
Возвращаемый результат
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| id | 1..1 | id | Идентификатор сводного реестра льготных ЭР, который отменен в результате выполнения операции. |
В случае успешного выполнения операции возвращается статус код HttpStatusCode 200 OK.
Возвращаемые коды состояния HTTP
- HttpStatusCode 200 OK - при успешной отметке об ошибочности
- HttpStatusCode 400 BadRequest - если входящие параметры не прошли правила валидации
- HttpStatusCode 404 NotFound - если не один из ресурсов, необходимых для выполнения операции, не найден
.png){kind=icon}
