Руководство к использованию стандарта FHIR в ЦИСЗ
0.2.6803 - ci-build
Руководство к использованию стандарта FHIR в ЦИСЗ
0.2.6803 - ci-build
| Официальный URL: https://fhir.by/StructureDefinition/ImmunizationRecommendationBy | ||||
| Active as of 2026-06-25 | Имя: ImmunizationRecommendationBy | |||
Набор рекомендаций для пациента на определенный момент времени по проведению профилактических прививок в соответствии с Национальным календарем профилактических прививок или другими нормативными документами. Раздел Вакцинация
Профиль ImmunizationRecomendationBy включает набор рекомендаций для пациента на определенный момент времени по проведению профилактических прививок в соответствии с “Национальным календарем профилактических прививок” или другими нормативными документами.
Профиль включает в себя следующие данные:
Сценарии использования:
Вариант №1:
Описание:
На первичном приёме пациента составляется план вакцинации.
Сценарий:
МИС отправляет запрос в ЦИСЗ на получение имеющихся данных;
ЦИСЗ возвращает ответ: ресурс не найден;
МИС создаёт ресурс ImmunizationRecommendation и в составе Bundle импортирует в ЦИСЗ;
ЦИСЗ присваивает ресурсу уникальный id, запись сохраняется.
рис.1
sequenceDiagram activate МИС activate ЦИСЗ МИС->> ЦИСЗ: GET [FHIR_BASE]/Patient/[patient_id]/ImmunizationRecommendation?_profile=ImmunizationRecommendationBy ЦИСЗ-->> МИС: OperationOutcome: Resource not found МИС-) ЦИСЗ: POST [FHIR_BASE]/Bundle/$import Body:Bundle+ImmunizationRecommendation ЦИСЗ--) МИС: Parameters(ProcessingStatus:Pending) ЦИСЗ->> ЦИСЗ: Присвоение уникального id и cохранение новой записи ImmunizationRecommendationBy МИС->> ЦИСЗ: GET [FHIR_BASE]/Bundle/[Bundle_id]/$status ЦИСЗ--) МИС: Parameters(ProcessingStatus: Success) deactivate МИС deactivate ЦИСЗ
Вариант №2:
Описание:
В ЦИСЗ уже есть план вакцинации данного пациента. Требуется внести изменения в план.
Сценарий:
МИС отправляет запрос в ЦИСЗ на получение имеющихся данных;
ЦИСЗ возвращает ответ;
МИС редактирует ресурс и в составе Bundle импортирует в ЦИСЗ. При редактировании создаётся новый экземпляр ресурса с тем же id;
ЦИСЗ выполняет сопоставление id. При совпадении id запись изменяется и сохраняется.
рис.2
sequenceDiagram activate МИС activate ЦИСЗ МИС->> ЦИСЗ: GET [FHIR_BASE]/Patient/[patientId]/ImmunizationRecommendation?_profile=ImmunizationRecommendationBy ЦИСЗ-->> МИС: ImmunizationRecommendation:id ЦИСЗ--) МИС: Parameters(ProcessingStatus:Pending) МИС-) ЦИСЗ: POST [FHIR_BASE]/Bundle/$import Body:Bundle+ImmunizationRecommendation_1 ЦИСЗ--) МИС: Parameters(ProcessingStatus:Pending) ЦИСЗ ->> ЦИСЗ: Сверка id, изменение и cохранение новой записи ImmunizationRecommendationBy_1 МИС->> ЦИСЗ: GET [FHIR_BASE]/Bundle/[Bundle_id]/$status ЦИСЗ--) МИС: Parameters(ProcessingStatus: Success)
Вариант №3:
Описание:
В ЦИСЗ уже есть план вакцинации данного пациента.
Сценарий:
МИС отправляет запрос в ЦИСЗ на получение имеющихся данных;
ЦИСЗ возвращает ответ;
МИС создает новый ресурс ImmunizationRecommendation с новым id и в составе Bundle импортирует в ЦИСЗ;
ЦИСЗ выполняет сопоставление id и возвращает ответ: id не совпадают. Импорт не осуществляется. Ресурс ImmunizationRecommendation для данного пациента уже существует, и он может существовать только в единственном числе.
рис.3
sequenceDiagram activate МИС activate ЦИСЗ МИС->> ЦИСЗ: GET [FHIR_BASE]/Patient/[patientId]/ImmunizationRecommendation?_profile=ImmunizationRecommendationBy ЦИСЗ-->> МИС: ImmunizationRecommendation:id МИС-) ЦИСЗ: POST [FHIR_BASE]/Bundle/$import ImmunizationRecommendation_id ЦИСЗ--) МИС: Parameters(ProcessingStatus:Pending) ЦИСЗ ->> ЦИСЗ: Сверка id МИС->> ЦИСЗ: GET [FHIR_BASE]/Bundle/[Bundle_id]/$status ЦИСЗ--) МИС: OperationOutcome: error (Идентификаторы не совпали) deactivate МИС deactivate ЦИСЗ
Использование:
You can also check for usages in the FHIR IG Statistics
Описание профилей и принципов работы различных представлений..
Профиль ресурса: ImmunizationRecommendation
| Наименование | Флаги | Карта. | Тип | Описание и ограничения Filter:   |
|---|---|---|---|---|
  ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Рекомендации или советы, касающиеся иммунизации | |
  meta |
1..1 | Meta | Метаданные о ресурсе | |
  id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
 extension |
0..0 | Extension | ||
| versionId |
0..1 | id | Идентификатор версии. Указывается версия ресурса, который подлежит редактированию, если предусмотрено правилами. Если версия не указана, то ресурс считается новым. | |
| source |
0..0 | Определяет, откуда берется ресурс | ||
| profile |
1..1 | canonical(StructureDefinition) | Ссылка на профиль Требуемый шаблон: https://fhir.by/StructureDefinition/ImmunizationRecommendationBy | |
| security |
0..0 | Метки безопасности, примененные к этому ресурсу | ||
 tag |
0..0 | Теги, применяемые к этому ресурсу | ||
| implicitRules |
0..0 | Набор правил, в соответствии с которыми был создан этот контент | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Автономные встроенные ресурсы | ||
 Разрезы для extension |
1..1 | Extension | Extension Разрез: Не упорядочено, Закрыто от value:$this.url | |
  extension:practitionerRoleImm |
S | 1..1 | Reference(Роль медицинского работника) | Медицинский работник, который составил/редактировал рекомендации URL: https://fhir.by/StructureDefinition/PractitionerRoleImm |
 modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | Business identifier | ||
 patient |
1..1 | Reference(Пациент | Пациент без ИН) | Ссылка на пациента, для которого составлены рекомендации по вакцинации | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| reference |
1..1 | string | Ссылка на ресурс в виде относительного URL | |
| date |
1..1 | dateTime | Дата создания/редактирования рекомендаций медицинским работником | |
| authority |
1..1 | Reference(Учреждение здравоохранения) | Учреждение здравоохранения, в котором были созданы/отредактированы рекомендации | |
 recommendation |
1..* | BackboneElement | Рекомендации по вакцинации | |
 id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| Разрезы для extension |
2..4 | Extension | Extension Разрез: Не упорядочено, Закрыто от value:$this.url | |
 extension:dateCriterionPeriod |
S | 1..1 | Period | Период, за который рекомендовано выполнить вакцинацию URL: https://fhir.by/StructureDefinition/DateCriterionPeriod |
| extension:vaccinationType |
S | 1..1 | CodeableConcept | Тип профилактической прививки URL: https://fhir.by/StructureDefinition/VaccinationType Привязка: Тип профилактической прививки АИС "Отчет" (required) |
| extension:vaccineDose |
S | 0..1 | Quantity | Доза вакцины URL: https://fhir.by/StructureDefinition/VaccineDose Привязка: Кодификатор единиц измерения АИС "Отчет" (required) |
| extension:attachDocumentImmun |
S | 0..1 | Reference(Неструктурированный документ) | Информация о проведенной вакцинации в виде неструктурированного документа URL: https://fhir.by/StructureDefinition/AttachDocumentImmun |
| modifierExtension |
0..0 | Extension | ||
| vaccineCode |
0..0 | Vaccine or vaccine group recommendation applies to | ||
| targetDisease |
1..* | CodeableConcept | Заболевание, для предотвращения которого рекомендуется вакцинация Привязка: Заболевание, на профилактику которого направлено действие иммунобиологического средства. АИС "Отчет" (required) | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| coding |
1..1 | Coding | Код, определенный в справочнике НСИ Терминология | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| system |
1..1 | uri | Ссылка на справочник | |
| code |
1..1 | code | Код | |
| userSelected |
0..0 | Если эта кодировка была выбрана непосредственно пользователем | ||
| text |
0..0 | Простое текстовое представление концепции | ||
| contraindicatedVaccineCode |
0..0 | Vaccine which is contraindicated to fulfill the recommendation | ||
| forecastStatus |
1..1 | CodeableConcept | Статус рекомендации по вакцинации Привязка: Статус рекомендации по вакцинации (required) | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| coding |
1..1 | Coding | Код, определенный в справочнике НСИ Терминология | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| system |
1..1 | uri | Ссылка на справочник | |
| code |
1..1 | code | Код | |
| userSelected |
0..0 | Если эта кодировка была выбрана непосредственно пользователем | ||
| text |
0..0 | Простое текстовое представление концепции | ||
| forecastReason |
0..0 | Vaccine administration status reason | ||
| dateCriterion |
0..0 | Dates governing proposed immunization | ||
| description |
0..1 | markdown | Дополнительные детали для рекомендаций по вакцинации. Поле предназначено для описания причин изменения статуса рекомендации, противопоказаний к проведению вакцинации и др. | |
| series |
0..0 | Name of vaccination series | ||
| doseNumber |
0..0 | Recommended dose number within series | ||
| seriesDoses |
0..0 | Recommended number of doses for immunity | ||
| supportingImmunization |
0..1 | Reference(Случай введения пациенту вакцины) | Информация о проведенной вакцинации | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| reference |
1..1 | string | Ссылка на ресурс в виде относительного URL | |
| supportingPatientInformation |
0..0 | Patient observations supporting recommendation | ||
| Документация для этого формата | ||||
| Путь | Статус | Использование | ValueSet | Версия | Источник |
| ImmunizationRecommendation.recommendation.targetDisease | Base | required | Заболевание, на профилактику которого направлено действие иммунобиологического средства. АИС "Отчет" | 📦0.2.6803 | этот IG |
| ImmunizationRecommendation.recommendation.forecastStatus | Base | required | Статус рекомендации по вакцинации | 📦0.2.6803 | этот IG |
| Наименование | Флаги | Карта. | Тип | Описание и ограничения Filter: |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Рекомендации или советы, касающиеся иммунизации | |
 id |
Σ | 0..1 | id | Логический идентификатор этого артефакта |
 meta |
Σ | 1..1 | Meta | Метаданные о ресурсе |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| versionId |
Σ | 0..1 | id | Идентификатор версии. Указывается версия ресурса, который подлежит редактированию, если предусмотрено правилами. Если версия не указана, то ресурс считается новым. |
| lastUpdated |
Σ | 0..1 | instant | Когда в последний раз менялась версия ресурса |
| profile |
Σ | 1..1 | canonical(StructureDefinition) | Ссылка на профиль Требуемый шаблон: https://fhir.by/StructureDefinition/ImmunizationRecommendationBy |
| text |
0..1 | Narrative | Краткое изложение текста ресурса для интерпретации человеком This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| Разрезы для extension |
1..1 | Extension | Extension Разрез: Не упорядочено, Закрыто от value:$this.url | |
| extension:practitionerRoleImm |
S | 1..1 | Reference(Роль медицинского работника) | Медицинский работник, который составил/редактировал рекомендации URL: https://fhir.by/StructureDefinition/PractitionerRoleImm |
| patient |
Σ | 1..1 | Reference(Пациент | Пациент без ИН) | Ссылка на пациента, для которого составлены рекомендации по вакцинации |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| reference |
ΣC | 1..1 | string | Ссылка на ресурс в виде относительного URL |
| type |
Σ | 0..1 | uri | Тип ресурса Привязка: ResourceType (extensible): Ресурс (или, для логических моделей, URI логической модели). |
| identifier |
ΣC | 0..1 | Identifier | Идентификатор ресурса, если не известна ссылка на него |
| display |
ΣC | 0..1 | string | Текстовая трактовка ресурса |
| date |
Σ | 1..1 | dateTime | Дата создания/редактирования рекомендаций медицинским работником |
| authority |
1..1 | Reference(Учреждение здравоохранения) | Учреждение здравоохранения, в котором были созданы/отредактированы рекомендации | |
| recommendation |
ΣC | 1..* | BackboneElement | Рекомендации по вакцинации Constraints: imr-1 |
| Разрезы для extension |
2..4 | Extension | Extension Разрез: Не упорядочено, Закрыто от value:$this.url | |
| extension:dateCriterionPeriod |
S | 1..1 | Period | Период, за который рекомендовано выполнить вакцинацию URL: https://fhir.by/StructureDefinition/DateCriterionPeriod |
| extension:vaccinationType |
S | 1..1 | CodeableConcept | Тип профилактической прививки URL: https://fhir.by/StructureDefinition/VaccinationType Привязка: Тип профилактической прививки АИС "Отчет" (required) |
| extension:vaccineDose |
S | 0..1 | Quantity | Доза вакцины URL: https://fhir.by/StructureDefinition/VaccineDose Привязка: Кодификатор единиц измерения АИС "Отчет" (required) |
| extension:attachDocumentImmun |
S | 0..1 | Reference(Неструктурированный документ) | Информация о проведенной вакцинации в виде неструктурированного документа URL: https://fhir.by/StructureDefinition/AttachDocumentImmun |
| targetDisease |
ΣC | 1..* | CodeableConcept | Заболевание, для предотвращения которого рекомендуется вакцинация Привязка: Заболевание, на профилактику которого направлено действие иммунобиологического средства. АИС "Отчет" (required) |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| coding |
Σ | 1..1 | Coding | Код, определенный в справочнике НСИ Терминология |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| system |
Σ | 1..1 | uri | Ссылка на справочник |
| version |
Σ | 0..1 | string | Версия системы |
| code |
ΣC | 1..1 | code | Код |
| display |
ΣC | 0..1 | string | Значение кода |
| forecastStatus |
?!Σ | 1..1 | CodeableConcept | Статус рекомендации по вакцинации Привязка: Статус рекомендации по вакцинации (required) |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| coding |
Σ | 1..1 | Coding | Код, определенный в справочнике НСИ Терминология |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| system |
Σ | 1..1 | uri | Ссылка на справочник |
| version |
Σ | 0..1 | string | Версия системы |
| code |
ΣC | 1..1 | code | Код |
| display |
ΣC | 0..1 | string | Значение кода |
| description |
0..1 | markdown | Дополнительные детали для рекомендаций по вакцинации. Поле предназначено для описания причин изменения статуса рекомендации, противопоказаний к проведению вакцинации и др. | |
| supportingImmunization |
0..1 | Reference(Случай введения пациенту вакцины) | Информация о проведенной вакцинации | |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| reference |
ΣC | 1..1 | string | Ссылка на ресурс в виде относительного URL |
| type |
Σ | 0..1 | uri | Тип ресурса Привязка: ResourceType (extensible): Ресурс (или, для логических моделей, URI логической модели). |
| identifier |
ΣC | 0..1 | Identifier | Идентификатор ресурса, если не известна ссылка на него |
| display |
ΣC | 0..1 | string | Текстовая трактовка ресурса |
| Документация для этого формата | ||||
| Путь | Статус | Использование | ValueSet | Версия | Источник |
| ImmunizationRecommendation.patient.type | Base | extensible | Resource Types | 📍5.0.0 | Стандарт FHIR |
| ImmunizationRecommendation.recommendation.targetDisease | Base | required | Заболевание, на профилактику которого направлено действие иммунобиологического средства. АИС "Отчет" | 📦0.2.6803 | этот IG |
| ImmunizationRecommendation.recommendation.forecastStatus | Base | required | Статус рекомендации по вакцинации | 📦0.2.6803 | этот IG |
| ImmunizationRecommendation.recommendation.dateCriterion.code | Base | example | Immunization Recommendation Date Criterion Codes | 📍5.0.0 | Стандарт FHIR |
| ImmunizationRecommendation.recommendation.supportingImmunization.type | Base | extensible | Resource Types | 📍5.0.0 | Стандарт FHIR |
| Id | Градация | Путь(и) | Описание | Выражение |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | лучшая практика | ImmunizationRecommendation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ВСЕ** элементы | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ВСЕ** расширения | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present |
vaccineCode.exists() or targetDisease.exists()
|
Профиль ресурса: ImmunizationRecommendation
Summary
Обязательный: 15 элементs(1 вложенные обязательны элемент)
Обязательная поддержка: 5 элементs
Запрещено: 36 элементs
Структуры
Эта структура относится к этим другим структурам:
Расширения
Эта структура ссылается на эти расширения:
Полная Схема
| Наименование | Флаги | Карта. | Тип | Описание и ограничения Filter: |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Рекомендации или советы, касающиеся иммунизации | |
| id |
Σ | 0..1 | id | Логический идентификатор этого артефакта |
| meta |
Σ | 1..1 | Meta | Метаданные о ресурсе |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| versionId |
Σ | 0..1 | id | Идентификатор версии. Указывается версия ресурса, который подлежит редактированию, если предусмотрено правилами. Если версия не указана, то ресурс считается новым. |
| lastUpdated |
Σ | 0..1 | instant | Когда в последний раз менялась версия ресурса |
| profile |
Σ | 1..1 | canonical(StructureDefinition) | Ссылка на профиль Требуемый шаблон: https://fhir.by/StructureDefinition/ImmunizationRecommendationBy |
| text |
0..1 | Narrative | Краткое изложение текста ресурса для интерпретации человеком This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| Разрезы для extension |
1..1 | Extension | Extension Разрез: Не упорядочено, Закрыто от value:$this.url | |
| extension:practitionerRoleImm |
S | 1..1 | Reference(Роль медицинского работника) | Медицинский работник, который составил/редактировал рекомендации URL: https://fhir.by/StructureDefinition/PractitionerRoleImm |
| patient |
Σ | 1..1 | Reference(Пациент | Пациент без ИН) | Ссылка на пациента, для которого составлены рекомендации по вакцинации |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| reference |
ΣC | 1..1 | string | Ссылка на ресурс в виде относительного URL |
| type |
Σ | 0..1 | uri | Тип ресурса Привязка: ResourceType (extensible): Ресурс (или, для логических моделей, URI логической модели). |
| identifier |
ΣC | 0..1 | Identifier | Идентификатор ресурса, если не известна ссылка на него |
| display |
ΣC | 0..1 | string | Текстовая трактовка ресурса |
| date |
Σ | 1..1 | dateTime | Дата создания/редактирования рекомендаций медицинским работником |
| authority |
1..1 | Reference(Учреждение здравоохранения) | Учреждение здравоохранения, в котором были созданы/отредактированы рекомендации | |
| recommendation |
ΣC | 1..* | BackboneElement | Рекомендации по вакцинации Constraints: imr-1 |
| Разрезы для extension |
2..4 | Extension | Extension Разрез: Не упорядочено, Закрыто от value:$this.url | |
| extension:dateCriterionPeriod |
S | 1..1 | Period | Период, за который рекомендовано выполнить вакцинацию URL: https://fhir.by/StructureDefinition/DateCriterionPeriod |
| extension:vaccinationType |
S | 1..1 | CodeableConcept | Тип профилактической прививки URL: https://fhir.by/StructureDefinition/VaccinationType Привязка: Тип профилактической прививки АИС "Отчет" (required) |
| extension:vaccineDose |
S | 0..1 | Quantity | Доза вакцины URL: https://fhir.by/StructureDefinition/VaccineDose Привязка: Кодификатор единиц измерения АИС "Отчет" (required) |
| extension:attachDocumentImmun |
S | 0..1 | Reference(Неструктурированный документ) | Информация о проведенной вакцинации в виде неструктурированного документа URL: https://fhir.by/StructureDefinition/AttachDocumentImmun |
| targetDisease |
ΣC | 1..* | CodeableConcept | Заболевание, для предотвращения которого рекомендуется вакцинация Привязка: Заболевание, на профилактику которого направлено действие иммунобиологического средства. АИС "Отчет" (required) |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| coding |
Σ | 1..1 | Coding | Код, определенный в справочнике НСИ Терминология |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| system |
Σ | 1..1 | uri | Ссылка на справочник |
| version |
Σ | 0..1 | string | Версия системы |
| code |
ΣC | 1..1 | code | Код |
| display |
ΣC | 0..1 | string | Значение кода |
| forecastStatus |
?!Σ | 1..1 | CodeableConcept | Статус рекомендации по вакцинации Привязка: Статус рекомендации по вакцинации (required) |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| coding |
Σ | 1..1 | Coding | Код, определенный в справочнике НСИ Терминология |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| system |
Σ | 1..1 | uri | Ссылка на справочник |
| version |
Σ | 0..1 | string | Версия системы |
| code |
ΣC | 1..1 | code | Код |
| display |
ΣC | 0..1 | string | Значение кода |
| description |
0..1 | markdown | Дополнительные детали для рекомендаций по вакцинации. Поле предназначено для описания причин изменения статуса рекомендации, противопоказаний к проведению вакцинации и др. | |
| supportingImmunization |
0..1 | Reference(Случай введения пациенту вакцины) | Информация о проведенной вакцинации | |
| extension |
0..0 | Extension Разрез: Не упорядочено, Открыто от value:url | ||
| reference |
ΣC | 1..1 | string | Ссылка на ресурс в виде относительного URL |
| type |
Σ | 0..1 | uri | Тип ресурса Привязка: ResourceType (extensible): Ресурс (или, для логических моделей, URI логической модели). |
| identifier |
ΣC | 0..1 | Identifier | Идентификатор ресурса, если не известна ссылка на него |
| display |
ΣC | 0..1 | string | Текстовая трактовка ресурса |
| Документация для этого формата | ||||
| Путь | Статус | Использование | ValueSet | Версия | Источник |
| ImmunizationRecommendation.patient.type | Base | extensible | Resource Types | 📍5.0.0 | Стандарт FHIR |
| ImmunizationRecommendation.recommendation.targetDisease | Base | required | Заболевание, на профилактику которого направлено действие иммунобиологического средства. АИС "Отчет" | 📦0.2.6803 | этот IG |
| ImmunizationRecommendation.recommendation.forecastStatus | Base | required | Статус рекомендации по вакцинации | 📦0.2.6803 | этот IG |
| ImmunizationRecommendation.recommendation.dateCriterion.code | Base | example | Immunization Recommendation Date Criterion Codes | 📍5.0.0 | Стандарт FHIR |
| ImmunizationRecommendation.recommendation.supportingImmunization.type | Base | extensible | Resource Types | 📍5.0.0 | Стандарт FHIR |
| Id | Градация | Путь(и) | Описание | Выражение |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | лучшая практика | ImmunizationRecommendation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ВСЕ** элементы | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ВСЕ** расширения | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present |
vaccineCode.exists() or targetDisease.exists()
|
Схема различий
Профиль ресурса: ImmunizationRecommendation
| Наименование | Флаги | Карта. | Тип | Описание и ограничения Filter: |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Рекомендации или советы, касающиеся иммунизации | |
| meta |
1..1 | Meta | Метаданные о ресурсе | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| versionId |
0..1 | id | Идентификатор версии. Указывается версия ресурса, который подлежит редактированию, если предусмотрено правилами. Если версия не указана, то ресурс считается новым. | |
| source |
0..0 | Определяет, откуда берется ресурс | ||
| profile |
1..1 | canonical(StructureDefinition) | Ссылка на профиль Требуемый шаблон: https://fhir.by/StructureDefinition/ImmunizationRecommendationBy | |
| security |
0..0 | Метки безопасности, примененные к этому ресурсу | ||
| tag |
0..0 | Теги, применяемые к этому ресурсу | ||
| implicitRules |
0..0 | Набор правил, в соответствии с которыми был создан этот контент | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Автономные встроенные ресурсы | ||
| Разрезы для extension |
1..1 | Extension | Extension Разрез: Не упорядочено, Закрыто от value:$this.url | |
| extension:practitionerRoleImm |
S | 1..1 | Reference(Роль медицинского работника) | Медицинский работник, который составил/редактировал рекомендации URL: https://fhir.by/StructureDefinition/PractitionerRoleImm |
| modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | Business identifier | ||
| patient |
1..1 | Reference(Пациент | Пациент без ИН) | Ссылка на пациента, для которого составлены рекомендации по вакцинации | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| reference |
1..1 | string | Ссылка на ресурс в виде относительного URL | |
| date |
1..1 | dateTime | Дата создания/редактирования рекомендаций медицинским работником | |
| authority |
1..1 | Reference(Учреждение здравоохранения) | Учреждение здравоохранения, в котором были созданы/отредактированы рекомендации | |
| recommendation |
1..* | BackboneElement | Рекомендации по вакцинации | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| Разрезы для extension |
2..4 | Extension | Extension Разрез: Не упорядочено, Закрыто от value:$this.url | |
| extension:dateCriterionPeriod |
S | 1..1 | Period | Период, за который рекомендовано выполнить вакцинацию URL: https://fhir.by/StructureDefinition/DateCriterionPeriod |
| extension:vaccinationType |
S | 1..1 | CodeableConcept | Тип профилактической прививки URL: https://fhir.by/StructureDefinition/VaccinationType Привязка: Тип профилактической прививки АИС "Отчет" (required) |
| extension:vaccineDose |
S | 0..1 | Quantity | Доза вакцины URL: https://fhir.by/StructureDefinition/VaccineDose Привязка: Кодификатор единиц измерения АИС "Отчет" (required) |
| extension:attachDocumentImmun |
S | 0..1 | Reference(Неструктурированный документ) | Информация о проведенной вакцинации в виде неструктурированного документа URL: https://fhir.by/StructureDefinition/AttachDocumentImmun |
| modifierExtension |
0..0 | Extension | ||
| vaccineCode |
0..0 | Vaccine or vaccine group recommendation applies to | ||
| targetDisease |
1..* | CodeableConcept | Заболевание, для предотвращения которого рекомендуется вакцинация Привязка: Заболевание, на профилактику которого направлено действие иммунобиологического средства. АИС "Отчет" (required) | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| coding |
1..1 | Coding | Код, определенный в справочнике НСИ Терминология | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| system |
1..1 | uri | Ссылка на справочник | |
| code |
1..1 | code | Код | |
| userSelected |
0..0 | Если эта кодировка была выбрана непосредственно пользователем | ||
| text |
0..0 | Простое текстовое представление концепции | ||
| contraindicatedVaccineCode |
0..0 | Vaccine which is contraindicated to fulfill the recommendation | ||
| forecastStatus |
1..1 | CodeableConcept | Статус рекомендации по вакцинации Привязка: Статус рекомендации по вакцинации (required) | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| coding |
1..1 | Coding | Код, определенный в справочнике НСИ Терминология | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| system |
1..1 | uri | Ссылка на справочник | |
| code |
1..1 | code | Код | |
| userSelected |
0..0 | Если эта кодировка была выбрана непосредственно пользователем | ||
| text |
0..0 | Простое текстовое представление концепции | ||
| forecastReason |
0..0 | Vaccine administration status reason | ||
| dateCriterion |
0..0 | Dates governing proposed immunization | ||
| description |
0..1 | markdown | Дополнительные детали для рекомендаций по вакцинации. Поле предназначено для описания причин изменения статуса рекомендации, противопоказаний к проведению вакцинации и др. | |
| series |
0..0 | Name of vaccination series | ||
| doseNumber |
0..0 | Recommended dose number within series | ||
| seriesDoses |
0..0 | Recommended number of doses for immunity | ||
| supportingImmunization |
0..1 | Reference(Случай введения пациенту вакцины) | Информация о проведенной вакцинации | |
| id |
0..0 | Уникальный идентификатор для межэлементных ссылок | ||
| extension |
0..0 | Extension | ||
| reference |
1..1 | string | Ссылка на ресурс в виде относительного URL | |
| supportingPatientInformation |
0..0 | Patient observations supporting recommendation | ||
| Документация для этого формата | ||||
| Путь | Статус | Использование | ValueSet | Версия | Источник |
| ImmunizationRecommendation.recommendation.targetDisease | Base | required | Заболевание, на профилактику которого направлено действие иммунобиологического средства. АИС "Отчет" | 📦0.2.6803 | этот IG |
| ImmunizationRecommendation.recommendation.forecastStatus | Base | required | Статус рекомендации по вакцинации | 📦0.2.6803 | этот IG |
Профиль ресурса: ImmunizationRecommendation
Summary
Обязательный: 15 элементs(1 вложенные обязательны элемент)
Обязательная поддержка: 5 элементs
Запрещено: 36 элементs
Структуры
Эта структура относится к этим другим структурам:
Расширения
Эта структура ссылается на эти расширения:
Правила редактирования ресурса:
id является уникальным, изменяться не может, имеет кардинальность 0..1. Так как МИС отправляет ресурс не присваивая id, id присваивается на стороне ЦИСЗ;
расширение practitionerRoleImm первоначально ссылается на ресурс PractitionerRoleBy специалиста, составившего ImmunizationRecommendation. В дальнейшем ссылка на ресурс PractitionerRoleBy заменяется на специалиста, который последним редактировал ImmunizationRecommendation;
date (дата создания рекомендаций): первоначальная дата создания ImmunizationRecommendation;
дата последних изменений хранится в meta.lastUpdated;
authority (организация, которая отвечает за рекомендации) первоначально ссылается на учреждение здравоохранения, в котором был составлен ImmunizationRecommendation. Изменяется в случае редактирования ресурса специалистом другой организации, либо при достижении пациентом возраста 18 лет и переходе из детской поликлиники во взрослую (ответственность несёт взрослая поликлиника);
сроки вакцинации устанавливаются в соответствии с Национальным календарем профилактических прививок, но в течении жизни могут изменяться по различным причинам;
расширение recommendation.extension: DateCriterionPeriod является обязательным и используется для установления сроков вакцинации. NB: если срок вакцинации прошёл, то forecastStatus автоматически меняется на overdue.
В supportingPatientInformation предоставляется информация, которая подтверждает рекомендации по вакцинации.
Например:
если в contraindicatedVaccineCode содержится информация о вакцине, которая противопоказана для выполнения, то в supportingPatientInformation указывается ссылка на профиль аллергической реакции или непереносимости на эту вакцину;
если в forecastStatus выставлен статус immune (иммунитет сформирован), то в supportingPatientInformation указывается ссылка на диагноз.
P.S.: Иммунитет может быть сформирован, когда пациент переболел какой-то инфекцией. В таком случае дальнейшая вакцинация не показана.
Статус рекомендации по вакцинации прописывается в recommendation.forecastStatus и является обязательным, статус может меняться.
| forecastStatus | значение |
|---|---|
| plan | вакцинация планируется |
| immune | иммунитет сформирован |
| overdue | запланированный срок вакцинации истек |
| complete | вакцинация завершена |
| contraindicated | вакцинация противопоказана |
| refusal | отказ |
Метод получения осуществляет доступ к текущему содержимому ресурса. Взаимодействие осуществляется с помощью HTTP GET команды:
GET [FHIR_BASE]/Patient/[patientId]/ImmunizationRecommendation/[id]
Метод возвращает один экземпляр ресурса.
Возможные значения логического идентификатора («id») описаны в типе Id
При попытке доступа к несуществующему ресурсу будет возвращен HTTP статус код - 404 Not Found
Во всех поисковых взаимодействиях в этом руководстве используется HTTP GET команда со следующим синтаксисом:
GET [FHIR_BASE]/Patient/[patientId]/[Resource-type]?[parameter1]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]{&[parameter2]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]&...}
GET — это HTTP метод, используемый для получения ресурса.
Переменные указанные в «[]», обязательны для предоставления клиентом и будут заменены указанным строковым литералом.
Переменные указанные в «{}», не являются обязательными для предоставления клиентом и будут заменены указанным строковым литералом.
FHIR_BASE: URL-адрес сервера
Resource-type: имя типа ресурса (например, “ImmunizationRecommendation”).
parameter: параметры поиска, определенные для конкретного взаимодействия (например, «?immunization=ImmunizationRecommendation/01»).
value: значение параметра поиска
{:m1 m2 …}: модификатор параметра поиска
{c1 c2 …}: компаратор параметра поиска
{,value2,…}: логическое ИЛИ
{¶meter2={:m1 m2 …}={c1 c2 …}[value1{,value2,…}]&…}: логическое И
Простой пример запроса поиска в RESTful с использованием HTTP GET команды:
GET [FHIR_BASE]/Patient/[patientId]/ImmunizationRecommendation?category=value&...
| Параметр поиска | Тип | Описание | Выражение | Пример |
|---|---|---|---|---|
| _id | token | По логическому идентификатору | ImmunizationRecommendation.id | GET http://staging.cisz.by/api/fhir/Patient/[patientId]/ImmunizationRecommendation?_id=000001 |
| _profile | reference | По профилю Immunization | ImmunizationRecommendation.meta.profile | GET http://staging.cisz.by/api/fhir/Patient/[patientId]/Immunization?__profile=https://fhir.by/StructureDefinition/ImmunizationRecommendationBy |
| authority | reference | Организация, которая отвечает за рекомендации | ImmunizationRecommendation.authority.as(Reference) | GET http://staging.cisz.by/api/fhir/Patient/[patientId]/ImmunizationRecommendation?authority=[organization_guid] |
| date | date | Дата введения вакцины | ImmunizationRecommendation.date | GET http://staging.cisz.by/api/fhir/Patient/[patientId]/ImmunizationRecommendation?date=2024-05-02 |
| patient | reference | Пациент, которому составлены рекомендации | ImmunizationRecommendation.patient | GET http://staging.cisz.by/api/fhir/Patient/[patientId]/ImmunizationRecommendation?patient=Patient/Patient001 |
| status | token | Статус рекомендации по вакцинации | ImmunizationRecommendation.recommendation.forecastStatus | GET http://staging.cisz.by/api/fhir/Patient/[patientId]/ImmunizationRecommendation?status=due |
| support | reference | Проведенная вакцинация | ImmunizationRecommendation.recommendation.supportingImmunization | GET http://staging.cisz.by/api/fhir/Patient/[patientId]/ImmunizationRecommendation?support=ImmunizationBy |
| target-disease | token | Заболевание, для предотвращения которого рекомендуется вакцинация | ImmunizationRecommendation.recommendation.targetDisease | GET http://staging.cisz.by/api/fhir/Patient/[patientId]/ImmunizationRecommendation?target-disease=12 |