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

Профиль ресурса: Неструктурированный документ

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

Неструктурированный документ. Чаще скан-копия документа, содержащая информацию о пациенте. Раздел Прием пациента, Заказ медицинских документов

Описание ресурса:

Ресурс DocumentReference предоставляет метаданные о неструктурированном документе позволяющие искать и получать содержащуюся в нем информацию.

В ресурсе возможно сохранение информации о сканах документов, представляющих ценную информацию о здоровье пациента, но которые невозможно представить в виде FHIR-ресурсов других профилей. Например: заключения ранних исследований, консультаций, справки и выписки из медицинских документов из систем, не подключенных к ЦИСЗ, заявления и др.

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

Ресурс DocumentReference используется для индексации документа, клинической справки и других двоичных объектов, таких как фото и скан-копии документов, в том числе полученных в результате диагностики или оказания медицинской помощи, чтобы сделать их доступными для системы здравоохранения.

Элемент content.attachment.contentType - код формата неструктурированных документов. В данном профиле можно представить документы в формате JPG(JPEG) и PDF.

Элемент content.attachment.data - это последовательность байтов, которая может быть получена с помощью операции Получения неструктурированной информации.

Элемент content.attachment.title - метка для содержимого, например заголовок для файла.

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

You can also check for usages in the FHIR IG Statistics

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

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

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

НаименованиеФлагиКарта.ТипОписание и ограничения    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference Ссылка на документ
... 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/AttachDocument
.... security 0..0 Метки безопасности, примененные к этому ресурсу
.... tag 0..0 Теги, применяемые к этому ресурсу
... implicitRules 0..0 Набор правил, в соответствии с которыми был создан этот контент
... language 0..0 Language of the resource content
... contained 0..0 Автономные встроенные ресурсы
... extension 0..0 Extension
... modifierExtension 0..0 Extension
... identifier 0..1 Identifier Если требуется указывается идентификатор ресурса. Также возможно указание организации, в которой данный идентификатор был присвоен
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... use 0..0 usual | official | temp | secondary | old (Если известно)
.... type 0..0 Описание идентификатора
.... value 1..1 string Значение идентификатора
.... period 0..0 Период времени, в течение которого идентификатор действителен для использования
.... assigner 0..1 Reference(Учреждение здравоохранения) Ссылка на организацию, которая присвоила идентификатор
... basedOn 0..0 Procedure that caused this media to be created
... status 1..1 code Статус по умолчанию: current
Требуемый шаблон: current
... docStatus 0..0 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
... modality 0..0 Imaging modality used
... type 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 Если эта кодировка была выбрана непосредственно пользователем
... category 0..0 Categorization of document
... subject 1..1 Reference(Пациент без ИН | Пациент | Законный представитель пациента) Ссылка на пациента или законного представителя, о ком содержиться информация в данном ресурсе
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... context 0..1 Reference(Общий профиль для обращения пациента за медицинской помощью) Если зафиксирован ресурс типа Encounter во время которого произошло создание данного ресурса, то указывается ссылка на него
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... event 0..1 CodeableReference(Заказ медицинских документов) Ссылка на связанное с неструктурированным документом событие. К примеру для заказа документов - ссылка на ресурс Task для которого выполнено создание даннного ресурса.
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... concept 0..0 Ссылка на концепт (справочник + код + значение)
.... reference
..... id 0..0 Уникальный идентификатор для межэлементных ссылок
..... extension 0..0 Extension
..... reference 1..1 string Ссылка на ресурс в виде относительного URL
... bodySite 0..0 Body part included
... facilityType 0..0 Kind of facility where patient was seen
... practiceSetting 0..0 Additional details about where the content was created (e.g. clinical specialty)
... period 0..1 Period Период времени, охватывающий информацию в неструктурированном документе
... date 1..1 instant Дата создания этого ресурса
... author 0..* Reference(Роль медицинского работника | Учреждение здравоохранения) Автор ресурса, медицинский работник или учреждение здравоохранения, если не возможно указать медицинского работника
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... attester 0..0 Attests to accuracy of the document
... custodian 0..1 Reference(Учреждение здравоохранения) Организация ответственная или создавшая данный ресурс
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... relatesTo 0..0 Relationships to other documents
... description 0..1 markdown Описание содержимого
... securityLabel 0..0 Document security-tags
... content 1..* BackboneElement Тип содержимого и бинарная информация о содержимом неструктурированного документа
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... Разрезы для extension 0..1 Extension Extension
Разрез: Не упорядочено, Закрыто от
..... extension:releaseKind 0..1 CodeableConcept Вид выписки для неструктурированного документа
URL: https://fhir.by/StructureDefinition/AttachmentReleaseKind
Привязка: Вид выписки (required)
.... modifierExtension 0..0 Extension
.... attachment C 1..1 Attachment Где получить доступ к документу
Constraints: OnlyPDFJPGAttachRule
..... id 0..0 Уникальный идентификатор для межэлементных ссылок
..... extension 0..0 Extension
..... contentType 1..1 code Mime-тип содержимого, с кодировкой и т.д.
Привязка: Формат неструктурированных документов (required)
..... language 0..0 Human language of the content (BCP-47)
..... data 1..1 base64Binary Встроенные данные, основанные на base64ed
..... size 0..0 Number of bytes of content (if url provided)
..... title 1..1 string Метка для отображения вместо данных
..... height 0..0 Height of the image in pixels (photo/video)
..... width 0..0 Width of the image in pixels (photo/video)
..... frames 0..0 Number of frames if > 1 (photo)
..... duration 0..0 Length in seconds (audio / video)
..... pages 0..0 Number of printed pages
.... profile 0..0 Правила профиля содержимого для документа

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

Терминологические привязки (дифференциал)

Путь Статус Использование ValueSet Версия Источник
DocumentReference.type Base required Виды медицинских документов во вложении 📦0.2.6803 этот IG
DocumentReference.content.​attachment.contentType Base required Формат неструктурированных документов 📦0.2.6803 этот IG

Ограничения

Id Градация Путь(и) Описание Выражение
OnlyPDFJPGAttachRule error DocumentReference.content.attachment Только документы в формате PDF и JPG возможно передавать в ресурсе AttachDocument data.matches('^JVBERi0xLj[A-Za-z0-9+/=]+$') or data.matches('^/9j/[A-Za-z0-9+/=]+$')
НаименованиеФлагиКарта.ТипОписание и ограничения    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference Ссылка на документ
Constraints: docRef-1, docRef-2
... 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/AttachDocument
... text 0..1 Narrative Краткое изложение текста ресурса для интерпретации человеком
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... system Σ 0..1 uri Пространство имен для значения идентификатора
Пример General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string Значение идентификатора
Пример General: 123456
.... assigner Σ 0..1 Reference(Учреждение здравоохранения) Ссылка на организацию, которая присвоила идентификатор
... version Σ 0..1 string Явно присвоенный идентификатор изменения содержимого в ссылке на документ
... status ?!Σ 1..1 code Статус по умолчанию: current
Привязка: DocumentReferenceStatus (required): Статус ссылки на документ.
Требуемый шаблон: current
... type Σ 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 Значение кода
.... text Σ 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 Текстовая трактовка ресурса
... context C 0..1 Reference(Общий профиль для обращения пациента за медицинской помощью) Если зафиксирован ресурс типа Encounter во время которого произошло создание данного ресурса, то указывается ссылка на него
.... 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 Текстовая трактовка ресурса
... event 0..1 CodeableReference(Заказ медицинских документов) Ссылка на связанное с неструктурированным документом событие. К примеру для заказа документов - ссылка на ресурс Task для которого выполнено создание даннного ресурса.
Привязка: v3 Code System ActCode (example): Этот список кодов представляет собой основные клинические действия, которые документируются.
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... reference Σ 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 Текстовая трактовка ресурса
... period Σ 0..1 Period Период времени, охватывающий информацию в неструктурированном документе
... date Σ 1..1 instant Дата создания этого ресурса
... author Σ 0..* Reference(Роль медицинского работника | Учреждение здравоохранения) Автор ресурса, медицинский работник или учреждение здравоохранения, если не возможно указать медицинского работника
.... 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 Текстовая трактовка ресурса
... custodian 0..1 Reference(Учреждение здравоохранения) Организация ответственная или создавшая данный ресурс
.... 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 Текстовая трактовка ресурса
... description Σ 0..1 markdown Описание содержимого
... content Σ 1..* BackboneElement Тип содержимого и бинарная информация о содержимом неструктурированного документа
.... Разрезы для extension 0..1 Extension Extension
Разрез: Не упорядочено, Закрыто от
..... extension:releaseKind 0..1 CodeableConcept Вид выписки для неструктурированного документа
URL: https://fhir.by/StructureDefinition/AttachmentReleaseKind
Привязка: Вид выписки (required)
.... attachment ΣC 1..1 Attachment Где получить доступ к документу
Constraints: OnlyPDFJPGAttachRule
..... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
..... contentType ΣC 1..1 code Mime-тип содержимого, с кодировкой и т.д.
Привязка: Формат неструктурированных документов (required)
Пример General: text/plain; charset=UTF-8, image/png
..... data C 1..1 base64Binary Встроенные данные, основанные на base64ed
..... url Σ 0..1 url Uri, по которому можно найти данные
Пример General: http://www.acme.com/logo-small.png
..... hash Σ 0..1 base64Binary Хэш данных (sha-1, base64ed)
..... title Σ 1..1 string Метка для отображения вместо данных
Пример General: Official Corporate Logo
..... creation Σ 0..1 dateTime Дата создания вложения в первый раз

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

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

Путь Статус Использование ValueSet Версия Источник
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 Стандарт FHIR
DocumentReference.type Base required Виды медицинских документов во вложении 📦0.2.6803 этот IG
DocumentReference.subject.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.context.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.event Base example v3 Code System ActCode 📦3.0.0 THO v5.5
DocumentReference.event.​reference.type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.author.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 Стандарт FHIR
DocumentReference.custodian.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 Стандарт FHIR
DocumentReference.content.​attachment.contentType Base required Формат неструктурированных документов 📦0.2.6803 этот IG
DocumentReference.content.​profile.value[x] Base preferred HL7 ValueSet of Format Codes for use with Document Sharing 📦2.0.0 THO v5.5

Ограничения

Id Градация Путь(и) Описание Выражение
OnlyPDFJPGAttachRule error DocumentReference.content.attachment Только документы в формате PDF и JPG возможно передавать в ресурсе AttachDocument data.matches('^JVBERi0xLj[A-Za-z0-9+/=]+$') or data.matches('^/9j/[A-Za-z0-9+/=]+$')
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 лучшая практика DocumentReference A resource should have narrative for robust management text.`div`.exists()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()

Полная Схема

НаименованиеФлагиКарта.ТипОписание и ограничения    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference Ссылка на документ
Constraints: docRef-1, docRef-2
... 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/AttachDocument
... text 0..1 Narrative Краткое изложение текста ресурса для интерпретации человеком
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... system Σ 0..1 uri Пространство имен для значения идентификатора
Пример General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string Значение идентификатора
Пример General: 123456
.... assigner Σ 0..1 Reference(Учреждение здравоохранения) Ссылка на организацию, которая присвоила идентификатор
... version Σ 0..1 string Явно присвоенный идентификатор изменения содержимого в ссылке на документ
... status ?!Σ 1..1 code Статус по умолчанию: current
Привязка: DocumentReferenceStatus (required): Статус ссылки на документ.
Требуемый шаблон: current
... type Σ 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 Значение кода
.... text Σ 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 Текстовая трактовка ресурса
... context C 0..1 Reference(Общий профиль для обращения пациента за медицинской помощью) Если зафиксирован ресурс типа Encounter во время которого произошло создание данного ресурса, то указывается ссылка на него
.... 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 Текстовая трактовка ресурса
... event 0..1 CodeableReference(Заказ медицинских документов) Ссылка на связанное с неструктурированным документом событие. К примеру для заказа документов - ссылка на ресурс Task для которого выполнено создание даннного ресурса.
Привязка: v3 Code System ActCode (example): Этот список кодов представляет собой основные клинические действия, которые документируются.
.... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
.... reference Σ 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 Текстовая трактовка ресурса
... period Σ 0..1 Period Период времени, охватывающий информацию в неструктурированном документе
... date Σ 1..1 instant Дата создания этого ресурса
... author Σ 0..* Reference(Роль медицинского работника | Учреждение здравоохранения) Автор ресурса, медицинский работник или учреждение здравоохранения, если не возможно указать медицинского работника
.... 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 Текстовая трактовка ресурса
... custodian 0..1 Reference(Учреждение здравоохранения) Организация ответственная или создавшая данный ресурс
.... 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 Текстовая трактовка ресурса
... description Σ 0..1 markdown Описание содержимого
... content Σ 1..* BackboneElement Тип содержимого и бинарная информация о содержимом неструктурированного документа
.... Разрезы для extension 0..1 Extension Extension
Разрез: Не упорядочено, Закрыто от
..... extension:releaseKind 0..1 CodeableConcept Вид выписки для неструктурированного документа
URL: https://fhir.by/StructureDefinition/AttachmentReleaseKind
Привязка: Вид выписки (required)
.... attachment ΣC 1..1 Attachment Где получить доступ к документу
Constraints: OnlyPDFJPGAttachRule
..... extension 0..0 Extension
Разрез: Не упорядочено, Открыто от value:url
..... contentType ΣC 1..1 code Mime-тип содержимого, с кодировкой и т.д.
Привязка: Формат неструктурированных документов (required)
Пример General: text/plain; charset=UTF-8, image/png
..... data C 1..1 base64Binary Встроенные данные, основанные на base64ed
..... url Σ 0..1 url Uri, по которому можно найти данные
Пример General: http://www.acme.com/logo-small.png
..... hash Σ 0..1 base64Binary Хэш данных (sha-1, base64ed)
..... title Σ 1..1 string Метка для отображения вместо данных
Пример General: Official Corporate Logo
..... creation Σ 0..1 dateTime Дата создания вложения в первый раз

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

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

Путь Статус Использование ValueSet Версия Источник
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 Стандарт FHIR
DocumentReference.type Base required Виды медицинских документов во вложении 📦0.2.6803 этот IG
DocumentReference.subject.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.context.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.event Base example v3 Code System ActCode 📦3.0.0 THO v5.5
DocumentReference.event.​reference.type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.author.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 Стандарт FHIR
DocumentReference.custodian.​type Base extensible Resource Types 📍5.0.0 Стандарт FHIR
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 Стандарт FHIR
DocumentReference.content.​attachment.contentType Base required Формат неструктурированных документов 📦0.2.6803 этот IG
DocumentReference.content.​profile.value[x] Base preferred HL7 ValueSet of Format Codes for use with Document Sharing 📦2.0.0 THO v5.5

Ограничения

Id Градация Путь(и) Описание Выражение
OnlyPDFJPGAttachRule error DocumentReference.content.attachment Только документы в формате PDF и JPG возможно передавать в ресурсе AttachDocument data.matches('^JVBERi0xLj[A-Za-z0-9+/=]+$') or data.matches('^/9j/[A-Za-z0-9+/=]+$')
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 DocumentReference 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 DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 лучшая практика DocumentReference A resource should have narrative for robust management text.`div`.exists()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()

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

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

НаименованиеФлагиКарта.ТипОписание и ограничения    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference Ссылка на документ
... 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/AttachDocument
.... security 0..0 Метки безопасности, примененные к этому ресурсу
.... tag 0..0 Теги, применяемые к этому ресурсу
... implicitRules 0..0 Набор правил, в соответствии с которыми был создан этот контент
... language 0..0 Language of the resource content
... contained 0..0 Автономные встроенные ресурсы
... extension 0..0 Extension
... modifierExtension 0..0 Extension
... identifier 0..1 Identifier Если требуется указывается идентификатор ресурса. Также возможно указание организации, в которой данный идентификатор был присвоен
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... use 0..0 usual | official | temp | secondary | old (Если известно)
.... type 0..0 Описание идентификатора
.... value 1..1 string Значение идентификатора
.... period 0..0 Период времени, в течение которого идентификатор действителен для использования
.... assigner 0..1 Reference(Учреждение здравоохранения) Ссылка на организацию, которая присвоила идентификатор
... basedOn 0..0 Procedure that caused this media to be created
... status 1..1 code Статус по умолчанию: current
Требуемый шаблон: current
... docStatus 0..0 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
... modality 0..0 Imaging modality used
... type 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 Если эта кодировка была выбрана непосредственно пользователем
... category 0..0 Categorization of document
... subject 1..1 Reference(Пациент без ИН | Пациент | Законный представитель пациента) Ссылка на пациента или законного представителя, о ком содержиться информация в данном ресурсе
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... context 0..1 Reference(Общий профиль для обращения пациента за медицинской помощью) Если зафиксирован ресурс типа Encounter во время которого произошло создание данного ресурса, то указывается ссылка на него
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... event 0..1 CodeableReference(Заказ медицинских документов) Ссылка на связанное с неструктурированным документом событие. К примеру для заказа документов - ссылка на ресурс Task для которого выполнено создание даннного ресурса.
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... extension 0..0 Extension
.... concept 0..0 Ссылка на концепт (справочник + код + значение)
.... reference
..... id 0..0 Уникальный идентификатор для межэлементных ссылок
..... extension 0..0 Extension
..... reference 1..1 string Ссылка на ресурс в виде относительного URL
... bodySite 0..0 Body part included
... facilityType 0..0 Kind of facility where patient was seen
... practiceSetting 0..0 Additional details about where the content was created (e.g. clinical specialty)
... period 0..1 Period Период времени, охватывающий информацию в неструктурированном документе
... date 1..1 instant Дата создания этого ресурса
... author 0..* Reference(Роль медицинского работника | Учреждение здравоохранения) Автор ресурса, медицинский работник или учреждение здравоохранения, если не возможно указать медицинского работника
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... attester 0..0 Attests to accuracy of the document
... custodian 0..1 Reference(Учреждение здравоохранения) Организация ответственная или создавшая данный ресурс
.... reference 1..1 string Ссылка на ресурс в виде относительного URL
... relatesTo 0..0 Relationships to other documents
... description 0..1 markdown Описание содержимого
... securityLabel 0..0 Document security-tags
... content 1..* BackboneElement Тип содержимого и бинарная информация о содержимом неструктурированного документа
.... id 0..0 Уникальный идентификатор для межэлементных ссылок
.... Разрезы для extension 0..1 Extension Extension
Разрез: Не упорядочено, Закрыто от
..... extension:releaseKind 0..1 CodeableConcept Вид выписки для неструктурированного документа
URL: https://fhir.by/StructureDefinition/AttachmentReleaseKind
Привязка: Вид выписки (required)
.... modifierExtension 0..0 Extension
.... attachment C 1..1 Attachment Где получить доступ к документу
Constraints: OnlyPDFJPGAttachRule
..... id 0..0 Уникальный идентификатор для межэлементных ссылок
..... extension 0..0 Extension
..... contentType 1..1 code Mime-тип содержимого, с кодировкой и т.д.
Привязка: Формат неструктурированных документов (required)
..... language 0..0 Human language of the content (BCP-47)
..... data 1..1 base64Binary Встроенные данные, основанные на base64ed
..... size 0..0 Number of bytes of content (if url provided)
..... title 1..1 string Метка для отображения вместо данных
..... height 0..0 Height of the image in pixels (photo/video)
..... width 0..0 Width of the image in pixels (photo/video)
..... frames 0..0 Number of frames if > 1 (photo)
..... duration 0..0 Length in seconds (audio / video)
..... pages 0..0 Number of printed pages
.... profile 0..0 Правила профиля содержимого для документа

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

Терминологические привязки (дифференциал)

Путь Статус Использование ValueSet Версия Источник
DocumentReference.type Base required Виды медицинских документов во вложении 📦0.2.6803 этот IG
DocumentReference.content.​attachment.contentType Base required Формат неструктурированных документов 📦0.2.6803 этот IG

Ограничения

Id Градация Путь(и) Описание Выражение
OnlyPDFJPGAttachRule error DocumentReference.content.attachment Только документы в формате PDF и JPG возможно передавать в ресурсе AttachDocument data.matches('^JVBERi0xLj[A-Za-z0-9+/=]+$') or data.matches('^/9j/[A-Za-z0-9+/=]+$')

 


Примечания:

  • ресурсы поддерживают односторонние связи, которые указывают в обратном направлении. Например: “новый” документ, указывает на “старый” документ, который он заменяет. Обратные связи можно проследить с помощью параметров поиска (описаны ниже) используя индексы, созданные на основе ресурсов. Учитывая, что в документах могут быть указаны другие документы, которые их заменяют или дополняют, необходимо всегда проверять взаимосвязи при доступе к документам;
  • параметр поиска _content выполняет поиск по элементам DocumentReference.content.attachment.data и DocumentReference.content.url;
  • если ресурс, на который ссылается элемент, изменяется, то соответствующая ссылка может быть временно не синхронизирована. Для того, чтобы DocumentReference обновлялся при изменении ресурса, на который ссылается элемент, и чтобы не допускать обновления DocumentReference, которое приводит к несогласованности с ресурсом, на который ссылается элемент, необходима координация.

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

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

GET [FHIR_BASE]/Patient/[patientId]/DocumentReference/[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: имя типа ресурса (например, “DocumentReference”).

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

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

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

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

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

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

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

GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?type=value&...

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

Параметр поиска Тип Описание Выражение Пример
_id token По логическому идентификатору DocumentReference.id GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?_id=00001
_profile reference По профилю организации DocumentReference.meta.profile GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?_profile=https://fhir.by/StructureDefinition/AttachDocument
date date Дата в течение actualPeriod, в течение которого продолжался DocumentReference DocumentReference.actualPeriod GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?date=2024-01-01
identifier token Identifier(s) по которому(ам) известно об этом DocumentReference DocumentReference.identifier GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?identifier=enc001
attester reference Кто заверял этот документ DocumentReference.attester.party(Practitioner, Organization, Patient, PractitionerRole, RelatedPerson) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?attester=attester01
author reference Кто и/или что стало автором документа DocumentReference.author(Practitioner, Organization, CareTeam, Device, Patient, PractitionerRole, RelatedPerson) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?author=author001
based-on reference Процедура, которая привела к созданию этого DocumentReference DocumentReference.basedOn(Appointment, MedicationRequest, RequestOrchestration, VisionPrescription, ServiceRequest, SupplyRequest, AppointmentResponse, CoverageEligibilityRequest, CarePlan, EnrollmentRequest, NutritionOrder, DeviceRequest, Contract, Claim, CommunicationRequest, ImmunizationRecommendation) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?based-on=Procedure01
bodysite token Обследуемая часть тела DocumentReference.bodySite.concept GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?bodySite=76986006
bodysite-reference reference Обследуемая часть тела DocumentReference.bodySite.reference GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?bodySite.reference=armLeft
category token Классификация документов DocumentReference.category GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?category=image
contenttype token Mime type из содержимого, с кодировкой и т.д. DocumentReference.content.attachment.contentType GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?contenttype=image
context reference Контекст содержания документа DocumentReference.context(Appointment, EpisodeOfCare, Encounter) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?context=Encounter001
creation date Дата создания приложения DocumentReference.content.attachment.creation GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?content.attachment.creation=2024-01-01
custodian reference Организация, которая ведет этот документ DocumentReference.custodian(Organization) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?custodian=Organization001
date date Когда была создана ссылка на этот документ DocumentReference.date GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?date=2024-01-01
description string Удобочитаемое описание DocumentReference.description GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?description=Description
doc-status token preliminary | final | amended | entered-in-error DocumentReference.docStatus GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?docStatus=final
event-code token Основные клинические акты, задокументированные DocumentReference.event.concept GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?event-concept=_CreditCard
event-reference reference Основные клинические акты, задокументированные DocumentReference.event.reference GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?event-reference=Encounter001
facility token Вид учреждения, где был осмотрен пациент DocumentReference.facilityType GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?facilityType=79993009
format-canonical reference Правила канонического содержимого профиля для документа (DocumentReference.content.profile.value.ofType(canonical)) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?format-canonical=fhir.by/0001
format-code token Правила содержания кода формата для документа (DocumentReference.content.profile.value.ofType(Coding)) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?format-code=urn:ihe:qrph:fp:2014
format-uri uri Правила содержания URI профиля для документа (DocumentReference.content.profile.value.ofType(uri)) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?format-uri=urn:ihe:qrph:fp:2014
language token Содержание на понятном человеку языке (BCP-47) DocumentReference.content.attachment.language GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?language=En
location uri Uri, по которому можно найти данные DocumentReference.content.attachment.url GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?location=http://example.by/DocumentReference001
modality token Используемый способ (modality) DocumentReference.modality GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?modality=dicom-cid-33-Modality
patient reference Кто/что является субъектом документа DocumentReference.subject.where(resolve() is Patient)(Patient) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?subject=Patient001
period date Время обслуживания, которое документируется DocumentReference.period GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?period=gt2024-01-01T10:20:00+00:00&lt2024-01-01T10:30:00+00:00
relatesto reference Цель взаимоотношений DocumentReference.relatesTo.target(DocumentReference) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?relatesto=DocumentReference002
relation token replaces | transforms | signs | appends DocumentReference.relatesTo.code GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?relation=signs
relationship composite Сочетание relation and relatesTo On DocumentReference.relatesTo:  relatesto: code  relation: target GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?relationship=replaces or GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?relationship=DocumentReference/002
security-label token Защитные метки документа DocumentReference.securityLabel GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?security-label=R
setting token Дополнительные сведения о том, где был создан контент (например, клиническая специальность) DocumentReference.practiceSetting GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?setting=394579002
status token current | superseded | entered-in-error DocumentReference.status GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?status=current
subject reference Кто/что является предметом документа DocumentReference.subject(Any) GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?subject=Device001
type token Вид документа (LOINC если возможно) DocumentReference.type GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?type=100018-1
version string Идентификатор бизнес-версии DocumentReference.version GET [FHIR_BASE]/Patient/[patientId]/DocumentReference?version=1.1.1

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

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