Руководство к использованию стандарта FHIR в ЦИСЗ
0.2.6803 - ci-build

Профиль ресурса: Сообщение ( Experimental )

Официальный URL: https://fhir.by/StructureDefinition/CommunicationBy
Unknown as of 2026-06-25 Имя: CommunicationBy

Профиль для создания ресурсов сообщений

Необходимо добавить описание!!!!!!

Для добавления описания нужно добавить файл input/intro-notes/StructureDefinition-CommunicationBy-intro.md

Использование:

  • Это Профиль не используется ни в одном профиле в этом руководстве по реализации

You can also check for usages in the FHIR IG Statistics

Контент профиля

Описание профилей и принципов работы различных представлений..

Профиль ресурса: Communication

НаименованиеФлагиКарта.ТипОписание и ограничения    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... meta 1..1 Meta Метаданные о ресурсе
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... versionId 0..1 id Идентификатор версии. Указывается версия ресурса, который подлежит редактированию, если предусмотрено правилами. Если версия не указана, то ресурс считается новым.
.... lastUpdated 0..1 instant Дата и время последнего обновления
.... source 0..0 Определяет, откуда берется ресурс
.... profile 1..1 canonical(StructureDefinition) Ссылка на профиль
Требуемый шаблон: https://fhir.by/StructureDefinition/CommunicationBy
.... security 0..0 Метки безопасности, примененные к этому ресурсу
.... tag 0..0 Теги, применяемые к этому ресурсу
... implicitRules 0..0 Набор правил, в соответствии с которыми был создан этот контент
... language 0..0 Language of the resource content
... text 0..0 Краткое изложение текста ресурса для интерпретации человеком
... contained 0..0 Автономные встроенные ресурсы
... extension 0..0 Extension
... modifierExtension 0..0 Extension
... identifier 0..0 Unique identifier
... instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
... instantiatesUri 0..0 Instantiates external protocol or definition
... basedOn 0..0 Request fulfilled by this communication
... partOf 0..0 Часть события, на которое ссылается ссылка (e.g. Communication, Procedure)
... inResponseTo 0..0 Reply to
... status 1..1 code Статус сообщения
... statusReason 0..0 Reason for current status
... category 0..0 Message category
... priority 0..0 routine | urgent | asap | stat
... medium 1..1 CodeableConcept Канал передачи сообщений
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... coding
..... id 0..0 Уникальный идентификатор для межэлементных ссылок
..... extension 0..0 Extension
..... system 1..1 uri Ссылка на справочник
..... code 1..1 code Код
..... userSelected 0..0 Если эта кодировка была выбрана непосредственно пользователем
.... text 0..0 Простое текстовое представление концепции
... subject 1..1 Reference(Пациент | Пациент без ИН) Ссылка на пациента
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... topic 0..1 CodeableConcept Тема сообщения
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... coding
..... id 0..0 Уникальный идентификатор для межэлементных ссылок
..... extension 0..0 Extension
..... system 1..1 uri Ссылка на справочник
..... code 1..1 code Код
..... userSelected 0..0 Если эта кодировка была выбрана непосредственно пользователем
.... text 0..0 Простое текстовое представление концепции
... about 0..* Reference(Resource) Ссылка на ресурс, связанный с сообщением. К примеру: в сообщении передается информация о создании направления на консультацию и в этом элементе фиксируется ссылка на ресурс направления
... sent 1..1 dateTime Дата отправки сообщения
... received 0..0 When received
... recipient 0..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender 1..1 Reference(Учреждение здравоохранения) Who shares the information
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... reason 0..0 Indication for message
... payload
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... content[x] 1..1 Reference(Неструктурированный документ) Message part content
... note 1..1 Annotation Шаблон уведомления
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... author[x] 0..0 Individual responsible for the annotation
.... time 0..0 Когда была сделана аннотация

doco Документация для этого формата
НаименованиеФлагиКарта.ТипОписание и ограничения    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... 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/CommunicationBy
... status ?!Σ 1..1 code Статус сообщения
Привязка: EventStatus (required): The status of the communication.
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... coding Σ 0..* 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 Значение кода
... subject Σ 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 Текстовая трактовка ресурса
... topic 0..1 CodeableConcept Тема сообщения
Привязка: CommunicationTopic (example): Codes describing the purpose or content of the communication.
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... coding Σ 0..* 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 Значение кода
... about 0..* Reference(Resource) Ссылка на ресурс, связанный с сообщением. К примеру: в сообщении передается информация о создании направления на консультацию и в этом элементе фиксируется ссылка на ресурс направления
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this Communication was created
... sent 1..1 dateTime Дата отправки сообщения
... recipient 0..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender 1..1 Reference(Учреждение здравоохранения) Who shares the information
.... id 0..1 id Уникальный идентификатор для межэлементных ссылок
.... extension 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 Текстовая трактовка ресурса
... payload 0..* BackboneElement Message payload
.... modifierExtension ?!Σ 0..* Extension Расширения, которые нельзя игнорировать даже если его не узнают
.... content[x] 1..1 Reference(Неструктурированный документ) Message part content
... note 1..1 Annotation Шаблон уведомления
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... text Σ 1..1 markdown Текстовое содержимое аннотации

doco Документация для этого формата

Привязки к терминологии

Путь Статус Использование ValueSet Версия Источник
Communication.status Base required EventStatus 📍5.0.0 Стандарт FHIR
Communication.medium Base example ParticipationMode 📦3.0.0 THO v5.5
Communication.subject.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
Communication.topic Base example Communication Topic 📍5.0.0 Стандарт FHIR
Communication.sender.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR

Ограничения

Id Градация Путь(и) Описание Выражение
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication 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 Communication 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 Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 лучшая практика Communication 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()

Профиль ресурса: Communication

Summary

Обязательный: 9 элементs(4 вложенные обязательны элементs)
Запрещено: 42 элементs

Структуры

Эта структура относится к этим другим структурам:

Полная Схема

НаименованиеФлагиКарта.ТипОписание и ограничения    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... 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/CommunicationBy
... status ?!Σ 1..1 code Статус сообщения
Привязка: EventStatus (required): The status of the communication.
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... coding Σ 0..* 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 Значение кода
... subject Σ 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 Текстовая трактовка ресурса
... topic 0..1 CodeableConcept Тема сообщения
Привязка: CommunicationTopic (example): Codes describing the purpose or content of the communication.
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... coding Σ 0..* 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 Значение кода
... about 0..* Reference(Resource) Ссылка на ресурс, связанный с сообщением. К примеру: в сообщении передается информация о создании направления на консультацию и в этом элементе фиксируется ссылка на ресурс направления
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this Communication was created
... sent 1..1 dateTime Дата отправки сообщения
... recipient 0..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender 1..1 Reference(Учреждение здравоохранения) Who shares the information
.... id 0..1 id Уникальный идентификатор для межэлементных ссылок
.... extension 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 Текстовая трактовка ресурса
... payload 0..* BackboneElement Message payload
.... modifierExtension ?!Σ 0..* Extension Расширения, которые нельзя игнорировать даже если его не узнают
.... content[x] 1..1 Reference(Неструктурированный документ) Message part content
... note 1..1 Annotation Шаблон уведомления
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... text Σ 1..1 markdown Текстовое содержимое аннотации

doco Документация для этого формата

Привязки к терминологии

Путь Статус Использование ValueSet Версия Источник
Communication.status Base required EventStatus 📍5.0.0 Стандарт FHIR
Communication.medium Base example ParticipationMode 📦3.0.0 THO v5.5
Communication.subject.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
Communication.topic Base example Communication Topic 📍5.0.0 Стандарт FHIR
Communication.sender.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR

Ограничения

Id Градация Путь(и) Описание Выражение
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication 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 Communication 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 Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 лучшая практика Communication 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()

Схема различий

Профиль ресурса: Communication

НаименованиеФлагиКарта.ТипОписание и ограничения    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... meta 1..1 Meta Метаданные о ресурсе
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... versionId 0..1 id Идентификатор версии. Указывается версия ресурса, который подлежит редактированию, если предусмотрено правилами. Если версия не указана, то ресурс считается новым.
.... lastUpdated 0..1 instant Дата и время последнего обновления
.... source 0..0 Определяет, откуда берется ресурс
.... profile 1..1 canonical(StructureDefinition) Ссылка на профиль
Требуемый шаблон: https://fhir.by/StructureDefinition/CommunicationBy
.... security 0..0 Метки безопасности, примененные к этому ресурсу
.... tag 0..0 Теги, применяемые к этому ресурсу
... implicitRules 0..0 Набор правил, в соответствии с которыми был создан этот контент
... language 0..0 Language of the resource content
... text 0..0 Краткое изложение текста ресурса для интерпретации человеком
... contained 0..0 Автономные встроенные ресурсы
... extension 0..0 Extension
... modifierExtension 0..0 Extension
... identifier 0..0 Unique identifier
... instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
... instantiatesUri 0..0 Instantiates external protocol or definition
... basedOn 0..0 Request fulfilled by this communication
... partOf 0..0 Часть события, на которое ссылается ссылка (e.g. Communication, Procedure)
... inResponseTo 0..0 Reply to
... status 1..1 code Статус сообщения
... statusReason 0..0 Reason for current status
... category 0..0 Message category
... priority 0..0 routine | urgent | asap | stat
... medium 1..1 CodeableConcept Канал передачи сообщений
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... coding
..... id 0..0 Уникальный идентификатор для межэлементных ссылок
..... extension 0..0 Extension
..... system 1..1 uri Ссылка на справочник
..... code 1..1 code Код
..... userSelected 0..0 Если эта кодировка была выбрана непосредственно пользователем
.... text 0..0 Простое текстовое представление концепции
... subject 1..1 Reference(Пациент | Пациент без ИН) Ссылка на пациента
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... topic 0..1 CodeableConcept Тема сообщения
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... coding
..... id 0..0 Уникальный идентификатор для межэлементных ссылок
..... extension 0..0 Extension
..... system 1..1 uri Ссылка на справочник
..... code 1..1 code Код
..... userSelected 0..0 Если эта кодировка была выбрана непосредственно пользователем
.... text 0..0 Простое текстовое представление концепции
... about 0..* Reference(Resource) Ссылка на ресурс, связанный с сообщением. К примеру: в сообщении передается информация о создании направления на консультацию и в этом элементе фиксируется ссылка на ресурс направления
... sent 1..1 dateTime Дата отправки сообщения
... received 0..0 When received
... recipient 0..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender 1..1 Reference(Учреждение здравоохранения) Who shares the information
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... reason 0..0 Indication for message
... payload
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... content[x] 1..1 Reference(Неструктурированный документ) Message part content
... note 1..1 Annotation Шаблон уведомления
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... author[x] 0..0 Individual responsible for the annotation
.... time 0..0 Когда была сделана аннотация

doco Документация для этого формата

Профиль ресурса: Communication

Summary

Обязательный: 9 элементs(4 вложенные обязательны элементs)
Запрещено: 42 элементs

Структуры

Эта структура относится к этим другим структурам:

 


Необходимо добавить дополнительную информацию!!!!!!

Для добавления дополнительной информации нужно добавить файл input/intro-notes/StructureDefinition-CommunicationBy-notes.md

Синтаксис метода получения ресурса

Метод получения осуществляет доступ к текущему содержимому ресурса. Взаимодействие осуществляется с помощью HTTP GET команды:

GET [FHIR_BASE]/Patient/[patientId]/Communication/[id]

Метод возвращает один экземпляр ресурса.

Возможные значения логического идентификатора («id») описаны в типе Id

При попытке доступа к несуществующему ресурсу будет возвращен HTTP статус код - 404 Not Found

Синтаксис поиска ресурса

Во всех поисковых взаимодействиях, кроме ресурса Patient, в этом руководстве используется 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: имя типа ресурса (например, Communication).

  • patientId: идентификатор пациента для которого будет производится поиск по связаным лицам.

  • parameter: параметры поиска, определенные для конкретного взаимодействия (например, «?status=completed»).

  • value: значение параметра поиска

  • {:m1 m2 …}: модификатор параметра поиска

  • {c1 c2 …}: компаратор параметра поиска

  • {,value2,…}: логическое ИЛИ

  • {&parameter2={:m1 m2 …}={c1 c2 …}[value1{,value2,…}]&…}: логическое И

Простой пример запроса поиска в RESTful с использованием HTTP GET команды:

GET [FHIR_BASE]/Patient/[patientId]/Communication?name=value&...

Поддерживаемые параметры поиска ресурса

Параметр поиска Тип Описание Выражение Пример
_id token По логическому идентификатору Communication.id GET [FHIR_BASE]/Patient/[patientId]/Communication?_id=00001
_profile reference По профилю Communication Communication.meta.profile GET [FHIR_BASE]/Patient/[patientId]/Communication?_profile=https://fhir.by/StructureDefinition/PatientNotification
_lastUpdated date По дате последнего изменения (создания) Communication.meta.lastUpdated GET [FHIR_BASE]/Communication?_lastUpdated=2025-05-05T10:30:00Z
patient reference По пациенту, которому адресовано сообщение Communication.subject.where(resolve() is Patient) (Patient) GET [FHIR_BASE]/Patient/[patientId]/Communication?patient=Patient001
subject reference По пациенту, которому адресовано сообщение Communication.subject(Patient) GET [FHIR_BASE]/Patient/[patientId]/Communication?subject=Patient001
status token Статус процедуры Communication.status GET [FHIR_BASE]/Patient/[patientId]/Communication?status=completed
sent date По времени создания уведомления Communication.sent GET [FHIR_BASE]/Patient/[patientId]/Communication?sent=gt2024-08-22T10:20:00+00:00&lt2024-08-22T10:30:00+00:00

Необходимо добавить описание Прав доступа!!!!!!

Для добавления описания нужно добавить файл input/rules/StructureDefinition-CommunicationBy-rules.md