Руководство к использованию стандарта FHIR в ЦИСЗ
0.1.1667 - ci-build
Руководство к использованию стандарта FHIR в ЦИСЗ - Local Development build (v0.1.1667) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Официальный URL: https://fhir.by/StructureDefinition/AttachDocument | Version: 0.1.1667 | |||
Active as of 2024-09-16 | Имя: AttachDocument |
Неструктурированный документ. Чаще скан копия документа содержащая информацию о пациенте.
Описание ресурса
Хотя термин “приложение” подразумевает более узкую направленность, для данного ресурса этот “приложение” охватывает любой документ, он включает официальные документы, ориентированные на пациента, клинические заметки, отсканированные документы. Ресурс DocumentReference предоставляет метаданные о приложении позволяющие обнаруживать его и управлять им. Фактический контент может быть встроенными данными в кодировке base64 или предоставляться по прямой ссылке !!! (требуется ревью разработчиков).
Использование
Ресурс DocumentReference используется для индексации документа, клинической справки и других двоичных объектов, таких как фото и сканы, в том числе полученных в результате диагностики или оказания медицинской помощи, чтобы сделать их доступными для системы здравоохранения. Приложение - это некоторая последовательность байтов, которая может быть идентифицирована, устанавливает свой собственный контекст (например, какая тема, автор и т.д. могут быть представлены пользователю).
В данном профиле можно представить документы в формате JPG(JPEG) и PDF.
Usage:
Описание профилей и принципов работы различных представлений..
Профиль ресурса: DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | Ссылка на документ | |
id | 1..1 | id | Логический идентификатор этого артефакта | |
meta | 1..1 | Meta | Метаданные о ресурсе | |
id | 0..0 | |||
extension | 0..0 | |||
versionId | 0..0 | |||
lastUpdated | 0..0 | |||
source | 0..0 | |||
profile | 1..1 | canonical(StructureDefinition) | Профили, которым, как утверждается, соответствует этот ресурс Required Pattern: https://fhir.by/StructureDefinition/AttachDocument | |
security | 0..0 | |||
tag | 0..0 | |||
implicitRules | 0..0 | |||
language | 0..0 | |||
contained | 0..0 | |||
extension | 0..0 | |||
modifierExtension | 0..0 | |||
identifier | 0..1 | Identifier | Бизнес-идентификаторы для документа | |
id | 0..0 | |||
extension | 0..0 | |||
use | 0..0 | |||
type | ||||
id | 0..0 | |||
extension | 0..0 | |||
coding | 1..1 | Coding | Код, определенный терминологической системой | |
extension | 0..0 | |||
system | 1..1 | uri | Идентичность терминологической системы | |
userSelected | 0..0 | |||
value | 1..1 | string | Уникальное значение | |
period | 0..0 | |||
basedOn | 0..0 | |||
docStatus | 0..0 | |||
modality | 0..0 | |||
type | 1..1 | CodeableConcept | Вид документа (по возможности, LOINC) | |
id | 0..0 | |||
extension | 0..0 | |||
coding | 1..1 | Coding | Код, определенный терминологической системой | |
extension | 0..0 | |||
system | 1..1 | uri | Идентичность терминологической системы | |
code | 0..1 | code | Код в синтаксисе, определенном системой Binding: Набор значений для видов медицинских документов во вложении (required) | |
category | 0..0 | |||
subject | 0..1 | Reference(Пациент без ИН | Пациент | Законный представитель пациента) | Кто/что является предметом документа | |
event | 0..1 | CodeableReference() | Основные задокументированные клинические акты | |
id | 0..0 | |||
extension | 0..0 | |||
concept | 0..0 | |||
reference | ||||
id | 0..0 | |||
extension | 0..0 | |||
reference | 1..1 | string | Буквальная ссылка, относительный, внутренний или абсолютный URL | |
bodySite | 0..0 | |||
facilityType | 0..0 | |||
practiceSetting | 0..0 | |||
date | 1..1 | instant | Когда была создана ссылка на этот документ | |
author | 0..* | Reference(Участник медицинского процесса | Роль медицинского работника | Учреждение здравоохранения) | Кто и/или что стало автором документа | |
attester | 0..0 | |||
custodian | 0..1 | Reference(Учреждение здравоохранения) | Организация, которая ведет этот документ | |
relatesTo | 0..0 | |||
securityLabel | 0..0 | |||
content | ||||
id | 0..0 | |||
extension | 0..0 | |||
modifierExtension | 0..0 | |||
attachment | ||||
id | 0..0 | |||
extension | 0..0 | |||
contentType | 1..1 | code | Mime-тип содержимого, с кодировкой и т.д. Binding: Тип контента в неструктурированном документе (required) | |
language | 0..0 | |||
data | 1..1 | base64Binary | Встроенные данные, основанные на base64ed | |
size | 0..0 | |||
title | 1..1 | string | Метка для отображения вместо данных | |
creation | 1..1 | dateTime | Дата создания вложения в первый раз | |
height | 0..0 | |||
width | 0..0 | |||
frames | 0..0 | |||
duration | 0..0 | |||
pages | 0..0 | |||
profile | ||||
id | 0..0 | |||
extension | 0..0 | |||
modifierExtension | 0..0 | |||
value[x] | 1..1 | Coding | Code|uri|canonical | |
id | 0..0 | |||
extension | 0..0 | |||
system | 1..1 | uri | Идентичность терминологической системы | |
code | 0..1 | code | Код в синтаксисе, определенном системой Binding: HL7 ValueSet of Format Codes for use with Document Sharing (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.modality.coding.code | required | VSModalityDICOM (a valid code from http://dicom.nema.org/resources/ontology/DCM )https://fhir.by/ValueSet/VSModalityDICOM from this IG | |
DocumentReference.type.coding.code | required | VSKindOfAttachDocument (a valid code from Виды медицинских документов во вложении)https://fhir.by/ValueSet/VSKindOfAttachDocument from this IG | |
DocumentReference.content.attachment.contentType | required | VSAttachmentContentTypehttps://fhir.by/ValueSet/VSAttachmentContentType from this IG | |
DocumentReference.content.profile.value[x].code | required | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | C | 0..* | DocumentReference | Ссылка на документ docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present |
id | Σ | 1..1 | id | Логический идентификатор этого артефакта |
meta | Σ | 1..1 | Meta | Метаданные о ресурсе |
extension | 0..0 | |||
profile | Σ | 1..1 | canonical(StructureDefinition) | Профили, которым, как утверждается, соответствует этот ресурс Required Pattern: https://fhir.by/StructureDefinition/AttachDocument |
text | 0..1 | Narrative | Краткое изложение текста ресурса для интерпретации человеком | |
identifier | Σ | 0..1 | Identifier | Бизнес-идентификаторы для документа |
extension | 0..0 | |||
type | Σ | 0..1 | CodeableConcept | Описание идентификатора Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели.. |
extension | 0..0 | |||
coding | Σ | 1..1 | Coding | Код, определенный терминологической системой |
id | 0..1 | id | Уникальный идентификатор для межэлементных ссылок | |
extension | 0..0 | |||
system | Σ | 1..1 | uri | Идентичность терминологической системы |
version | Σ | 0..1 | string | Версия системы - если это уместно |
code | ΣC | 0..1 | code | Код в синтаксисе, определенном системой |
display | ΣC | 0..1 | string | Представление, определяемое системой |
text | Σ | 0..1 | string | Простое текстовое представление концепции |
system | Σ | 0..1 | uri | Пространство имен для значения идентификатора Example General: http://www.acme.com/identifiers/patient |
value | ΣC | 1..1 | string | Уникальное значение Example General: 123456 |
assigner | Σ | 0..1 | Reference(Organization) | Организация, выдавшая идентификатор (может быть просто текстом) |
version | Σ | 0..1 | string | Явно присвоенный идентификатор изменения содержимого в ссылке на документ |
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): Статус ссылки на документ. |
type | Σ | 1..1 | CodeableConcept | Вид документа (по возможности, LOINC) Binding: FHIRDocumentTypeCodes (preferred): Точный тип документа. |
extension | 0..0 | |||
coding | Σ | 1..1 | Coding | Код, определенный терминологической системой |
id | 0..1 | id | Уникальный идентификатор для межэлементных ссылок | |
extension | 0..0 | |||
system | Σ | 1..1 | uri | Идентичность терминологической системы |
version | Σ | 0..1 | string | Версия системы - если это уместно |
code | ΣC | 0..1 | code | Код в синтаксисе, определенном системой Binding: Набор значений для видов медицинских документов во вложении (required) |
display | ΣC | 0..1 | string | Представление, определяемое системой |
userSelected | Σ | 0..1 | boolean | Если эта кодировка была выбрана непосредственно пользователем |
text | Σ | 0..1 | string | Простое текстовое представление концепции |
subject | Σ | 0..1 | Reference(Пациент без ИН | Пациент | Законный представитель пациента) | Кто/что является предметом документа |
context | C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Контекст содержания документа |
event | 0..1 | CodeableReference() | Основные задокументированные клинические акты Binding: v3 Code System ActCode (example): Этот список кодов представляет собой основные клинические действия, которые документируются. | |
extension | 0..0 | |||
reference | Σ | 0..1 | Reference() | Ссылка на ресурс (по экземпляру) |
extension | 0..0 | |||
reference | ΣC | 1..1 | string | Буквальная ссылка, относительный, внутренний или абсолютный URL |
type | Σ | 0..1 | uri | Тип, на который ссылается ссылка (например, Пациент) - должен быть ресурсом в разделе ресурсы Binding: ResourceType (extensible): Ресурс (или, для логических моделей, URI логической модели). |
identifier | ΣC | 0..1 | Identifier | Логическая ссылка, когда буквальная ссылка неизвестна |
display | ΣC | 0..1 | string | Текстовая альтернатива для ресурса |
period | Σ | 0..1 | Period | Время обслуживания, которое документируется |
date | Σ | 1..1 | instant | Когда была создана ссылка на этот документ |
author | Σ | 0..* | Reference(Участник медицинского процесса | Роль медицинского работника | Учреждение здравоохранения) | Кто и/или что стало автором документа |
custodian | 0..1 | Reference(Учреждение здравоохранения) | Организация, которая ведет этот документ | |
description | Σ | 0..1 | markdown | Удобочитаемое описание |
content | Σ | 1..* | BackboneElement | Документ, на который ссылаются |
attachment | Σ | 1..1 | Attachment | Где получить доступ к документу |
extension | 0..0 | |||
contentType | ΣC | 1..1 | code | Mime-тип содержимого, с кодировкой и т.д. Binding: Тип контента в неструктурированном документе (required) Example General: text/plain; charset=UTF-8, image/png |
data | C | 1..1 | base64Binary | Встроенные данные, основанные на base64ed |
url | Σ | 0..1 | url | Uri, по которому можно найти данные Example General: http://www.acme.com/logo-small.png |
hash | Σ | 0..1 | base64Binary | Хэш данных (sha-1, base64ed) |
title | Σ | 1..1 | string | Метка для отображения вместо данных Example General: Official Corporate Logo |
creation | Σ | 1..1 | dateTime | Дата создания вложения в первый раз |
profile | Σ | 0..* | BackboneElement | Правила профиля содержимого для документа |
value[x] | Σ | 1..1 | Coding | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Коды формата документа. |
extension | 0..0 | |||
system | Σ | 1..1 | uri | Идентичность терминологической системы |
version | Σ | 0..1 | string | Версия системы - если это уместно |
code | ΣC | 0..1 | code | Код в синтаксисе, определенном системой Binding: HL7 ValueSet of Format Codes for use with Document Sharing (required) |
display | ΣC | 0..1 | string | Представление, определяемое системой |
userSelected | Σ | 0..1 | boolean | Если эта кодировка была выбрана непосредственно пользователем |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.modality.coding.code | required | VSModalityDICOM (a valid code from http://dicom.nema.org/resources/ontology/DCM )https://fhir.by/ValueSet/VSModalityDICOM from this IG | |
DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
DocumentReference.type.coding.code | required | VSKindOfAttachDocument (a valid code from Виды медицинских документов во вложении)https://fhir.by/ValueSet/VSKindOfAttachDocument from this IG | |
DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
DocumentReference.event.reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | VSAttachmentContentTypehttps://fhir.by/ValueSet/VSAttachmentContentType from this IG | |
DocumentReference.content.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content.profile.value[x].code | required | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Профиль ресурса: DocumentReference
Summary
Mandatory: 11 elements(8 nested mandatory elements)
Prohibited: 56 elements
Structures
This structure refers to these other structures:
Схема различий
Профиль ресурса: DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | Ссылка на документ | |
id | 1..1 | id | Логический идентификатор этого артефакта | |
meta | 1..1 | Meta | Метаданные о ресурсе | |
id | 0..0 | |||
extension | 0..0 | |||
versionId | 0..0 | |||
lastUpdated | 0..0 | |||
source | 0..0 | |||
profile | 1..1 | canonical(StructureDefinition) | Профили, которым, как утверждается, соответствует этот ресурс Required Pattern: https://fhir.by/StructureDefinition/AttachDocument | |
security | 0..0 | |||
tag | 0..0 | |||
implicitRules | 0..0 | |||
language | 0..0 | |||
contained | 0..0 | |||
extension | 0..0 | |||
modifierExtension | 0..0 | |||
identifier | 0..1 | Identifier | Бизнес-идентификаторы для документа | |
id | 0..0 | |||
extension | 0..0 | |||
use | 0..0 | |||
type | ||||
id | 0..0 | |||
extension | 0..0 | |||
coding | 1..1 | Coding | Код, определенный терминологической системой | |
extension | 0..0 | |||
system | 1..1 | uri | Идентичность терминологической системы | |
userSelected | 0..0 | |||
value | 1..1 | string | Уникальное значение | |
period | 0..0 | |||
basedOn | 0..0 | |||
docStatus | 0..0 | |||
modality | 0..0 | |||
type | 1..1 | CodeableConcept | Вид документа (по возможности, LOINC) | |
id | 0..0 | |||
extension | 0..0 | |||
coding | 1..1 | Coding | Код, определенный терминологической системой | |
extension | 0..0 | |||
system | 1..1 | uri | Идентичность терминологической системы | |
code | 0..1 | code | Код в синтаксисе, определенном системой Binding: Набор значений для видов медицинских документов во вложении (required) | |
category | 0..0 | |||
subject | 0..1 | Reference(Пациент без ИН | Пациент | Законный представитель пациента) | Кто/что является предметом документа | |
event | 0..1 | CodeableReference() | Основные задокументированные клинические акты | |
id | 0..0 | |||
extension | 0..0 | |||
concept | 0..0 | |||
reference | ||||
id | 0..0 | |||
extension | 0..0 | |||
reference | 1..1 | string | Буквальная ссылка, относительный, внутренний или абсолютный URL | |
bodySite | 0..0 | |||
facilityType | 0..0 | |||
practiceSetting | 0..0 | |||
date | 1..1 | instant | Когда была создана ссылка на этот документ | |
author | 0..* | Reference(Участник медицинского процесса | Роль медицинского работника | Учреждение здравоохранения) | Кто и/или что стало автором документа | |
attester | 0..0 | |||
custodian | 0..1 | Reference(Учреждение здравоохранения) | Организация, которая ведет этот документ | |
relatesTo | 0..0 | |||
securityLabel | 0..0 | |||
content | ||||
id | 0..0 | |||
extension | 0..0 | |||
modifierExtension | 0..0 | |||
attachment | ||||
id | 0..0 | |||
extension | 0..0 | |||
contentType | 1..1 | code | Mime-тип содержимого, с кодировкой и т.д. Binding: Тип контента в неструктурированном документе (required) | |
language | 0..0 | |||
data | 1..1 | base64Binary | Встроенные данные, основанные на base64ed | |
size | 0..0 | |||
title | 1..1 | string | Метка для отображения вместо данных | |
creation | 1..1 | dateTime | Дата создания вложения в первый раз | |
height | 0..0 | |||
width | 0..0 | |||
frames | 0..0 | |||
duration | 0..0 | |||
pages | 0..0 | |||
profile | ||||
id | 0..0 | |||
extension | 0..0 | |||
modifierExtension | 0..0 | |||
value[x] | 1..1 | Coding | Code|uri|canonical | |
id | 0..0 | |||
extension | 0..0 | |||
system | 1..1 | uri | Идентичность терминологической системы | |
code | 0..1 | code | Код в синтаксисе, определенном системой Binding: HL7 ValueSet of Format Codes for use with Document Sharing (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.modality.coding.code | required | VSModalityDICOM (a valid code from http://dicom.nema.org/resources/ontology/DCM )https://fhir.by/ValueSet/VSModalityDICOM from this IG | |
DocumentReference.type.coding.code | required | VSKindOfAttachDocument (a valid code from Виды медицинских документов во вложении)https://fhir.by/ValueSet/VSKindOfAttachDocument from this IG | |
DocumentReference.content.attachment.contentType | required | VSAttachmentContentTypehttps://fhir.by/ValueSet/VSAttachmentContentType from this IG | |
DocumentReference.content.profile.value[x].code | required | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Полная Схема
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | C | 0..* | DocumentReference | Ссылка на документ docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present |
id | Σ | 1..1 | id | Логический идентификатор этого артефакта |
meta | Σ | 1..1 | Meta | Метаданные о ресурсе |
extension | 0..0 | |||
profile | Σ | 1..1 | canonical(StructureDefinition) | Профили, которым, как утверждается, соответствует этот ресурс Required Pattern: https://fhir.by/StructureDefinition/AttachDocument |
text | 0..1 | Narrative | Краткое изложение текста ресурса для интерпретации человеком | |
identifier | Σ | 0..1 | Identifier | Бизнес-идентификаторы для документа |
extension | 0..0 | |||
type | Σ | 0..1 | CodeableConcept | Описание идентификатора Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели.. |
extension | 0..0 | |||
coding | Σ | 1..1 | Coding | Код, определенный терминологической системой |
id | 0..1 | id | Уникальный идентификатор для межэлементных ссылок | |
extension | 0..0 | |||
system | Σ | 1..1 | uri | Идентичность терминологической системы |
version | Σ | 0..1 | string | Версия системы - если это уместно |
code | ΣC | 0..1 | code | Код в синтаксисе, определенном системой |
display | ΣC | 0..1 | string | Представление, определяемое системой |
text | Σ | 0..1 | string | Простое текстовое представление концепции |
system | Σ | 0..1 | uri | Пространство имен для значения идентификатора Example General: http://www.acme.com/identifiers/patient |
value | ΣC | 1..1 | string | Уникальное значение Example General: 123456 |
assigner | Σ | 0..1 | Reference(Organization) | Организация, выдавшая идентификатор (может быть просто текстом) |
version | Σ | 0..1 | string | Явно присвоенный идентификатор изменения содержимого в ссылке на документ |
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): Статус ссылки на документ. |
type | Σ | 1..1 | CodeableConcept | Вид документа (по возможности, LOINC) Binding: FHIRDocumentTypeCodes (preferred): Точный тип документа. |
extension | 0..0 | |||
coding | Σ | 1..1 | Coding | Код, определенный терминологической системой |
id | 0..1 | id | Уникальный идентификатор для межэлементных ссылок | |
extension | 0..0 | |||
system | Σ | 1..1 | uri | Идентичность терминологической системы |
version | Σ | 0..1 | string | Версия системы - если это уместно |
code | ΣC | 0..1 | code | Код в синтаксисе, определенном системой Binding: Набор значений для видов медицинских документов во вложении (required) |
display | ΣC | 0..1 | string | Представление, определяемое системой |
userSelected | Σ | 0..1 | boolean | Если эта кодировка была выбрана непосредственно пользователем |
text | Σ | 0..1 | string | Простое текстовое представление концепции |
subject | Σ | 0..1 | Reference(Пациент без ИН | Пациент | Законный представитель пациента) | Кто/что является предметом документа |
context | C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Контекст содержания документа |
event | 0..1 | CodeableReference() | Основные задокументированные клинические акты Binding: v3 Code System ActCode (example): Этот список кодов представляет собой основные клинические действия, которые документируются. | |
extension | 0..0 | |||
reference | Σ | 0..1 | Reference() | Ссылка на ресурс (по экземпляру) |
extension | 0..0 | |||
reference | ΣC | 1..1 | string | Буквальная ссылка, относительный, внутренний или абсолютный URL |
type | Σ | 0..1 | uri | Тип, на который ссылается ссылка (например, Пациент) - должен быть ресурсом в разделе ресурсы Binding: ResourceType (extensible): Ресурс (или, для логических моделей, URI логической модели). |
identifier | ΣC | 0..1 | Identifier | Логическая ссылка, когда буквальная ссылка неизвестна |
display | ΣC | 0..1 | string | Текстовая альтернатива для ресурса |
period | Σ | 0..1 | Period | Время обслуживания, которое документируется |
date | Σ | 1..1 | instant | Когда была создана ссылка на этот документ |
author | Σ | 0..* | Reference(Участник медицинского процесса | Роль медицинского работника | Учреждение здравоохранения) | Кто и/или что стало автором документа |
custodian | 0..1 | Reference(Учреждение здравоохранения) | Организация, которая ведет этот документ | |
description | Σ | 0..1 | markdown | Удобочитаемое описание |
content | Σ | 1..* | BackboneElement | Документ, на который ссылаются |
attachment | Σ | 1..1 | Attachment | Где получить доступ к документу |
extension | 0..0 | |||
contentType | ΣC | 1..1 | code | Mime-тип содержимого, с кодировкой и т.д. Binding: Тип контента в неструктурированном документе (required) Example General: text/plain; charset=UTF-8, image/png |
data | C | 1..1 | base64Binary | Встроенные данные, основанные на base64ed |
url | Σ | 0..1 | url | Uri, по которому можно найти данные Example General: http://www.acme.com/logo-small.png |
hash | Σ | 0..1 | base64Binary | Хэш данных (sha-1, base64ed) |
title | Σ | 1..1 | string | Метка для отображения вместо данных Example General: Official Corporate Logo |
creation | Σ | 1..1 | dateTime | Дата создания вложения в первый раз |
profile | Σ | 0..* | BackboneElement | Правила профиля содержимого для документа |
value[x] | Σ | 1..1 | Coding | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Коды формата документа. |
extension | 0..0 | |||
system | Σ | 1..1 | uri | Идентичность терминологической системы |
version | Σ | 0..1 | string | Версия системы - если это уместно |
code | ΣC | 0..1 | code | Код в синтаксисе, определенном системой Binding: HL7 ValueSet of Format Codes for use with Document Sharing (required) |
display | ΣC | 0..1 | string | Представление, определяемое системой |
userSelected | Σ | 0..1 | boolean | Если эта кодировка была выбрана непосредственно пользователем |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.modality.coding.code | required | VSModalityDICOM (a valid code from http://dicom.nema.org/resources/ontology/DCM )https://fhir.by/ValueSet/VSModalityDICOM from this IG | |
DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
DocumentReference.type.coding.code | required | VSKindOfAttachDocument (a valid code from Виды медицинских документов во вложении)https://fhir.by/ValueSet/VSKindOfAttachDocument from this IG | |
DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
DocumentReference.event.reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | VSAttachmentContentTypehttps://fhir.by/ValueSet/VSAttachmentContentType from this IG | |
DocumentReference.content.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content.profile.value[x].code | required | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Профиль ресурса: DocumentReference
Summary
Mandatory: 11 elements(8 nested mandatory elements)
Prohibited: 56 elements
Structures
This structure refers to these other structures:
Метод получения осуществляет доступ к текущему содержимому ресурса. Взаимодействие осуществляется с помощью HTTP GET
команды:
GET [base]/fhir/Patient/[patientId]/DocumentReference/[id]
Метод возвращает один экземпляр ресурса.
Возможные значения логического идентификатора («id») описаны в типе Id
При попытке доступа к несуществующему ресурсу будет возвращен HTTP статус код - 404 Not Found
Во всех поисковых взаимодействиях в этом руководстве используется HTTP GET
команда со следующим синтаксисом:
GET [base]/fhir/Patient/[patientId]/[Resource-type]?[parameter1]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]{&[parameter2]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]&...}
GET — это HTTP метод, используемый для получения ресурса.
Переменные указанные в «[]», обязательны для предоставления клиентом и будут заменены указанным строковым литералом.
Переменные указанные в «{}», не являются обязательными для предоставления клиентом и будут заменены указанным строковым литералом.
base: URL-адрес сервера
Resource-type: имя типа ресурса (например, “DocumentReference”).
parameter: параметры поиска, определенные для конкретного взаимодействия (например, «?documentReference=DocumentReference/01»).
value: значение параметра поиска
: модификатор параметра поиска
{c1 c2 …}: компаратор параметра поиска
{,value2,…}: логическое ИЛИ
{¶meter2={:m1 m2 …}={c1 c2 …}[value1{,value2,…}]&…}: логическое И
Простой пример запроса поиска в RESTful с использованием HTTP GET
команды:
GET [base]/fhir/Patient/[patientId]/DocumentReference?type=value&...
Параметр поиска | Тип | Описание | Выражение | Пример |
---|---|---|---|---|
_id | token | По логическому идентификатору | DocumentReference.id | GET [base]/fhir/Patient/[patientId]/DocumentReference?_id=00001 |
_profile | reference | По профилю организации | DocumentReference.meta.profile | GET [base]/fhir/Patient/[patientId]/DocumentReference?_profile=https://fhir.by/StructureDefinition/AttachDocument |
date | date | Дата в течение actualPeriod, в течение которого продолжался DocumentReference | DocumentReference.actualPeriod | GET [base]/fhir/Patient/[patientId]/DocumentReference?date=2024-01-01 |
identifier | token | Identifier(s) по которому(ам) известно об этом DocumentReference | DocumentReference.identifier | GET [base]/fhir/Patient/[patientId]/DocumentReference?identifier=enc001 |
attester | reference | Кто заверял этот документ | DocumentReference.attester.party(Practitioner, Organization, Patient, PractitionerRole, RelatedPerson) | GET [base]/fhir/Patient/[patientId]/DocumentReference?attester=attester01 |
author | reference | Кто и/или что стало автором документа | DocumentReference.author(Practitioner, Organization, CareTeam, Device, Patient, PractitionerRole, RelatedPerson) | GET [base]/fhir/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 [base]/fhir/Patient/[patientId]/DocumentReference?based-on=Procedure01 |
bodysite | token | Обследуемая часть тела | DocumentReference.bodySite.concept | GET [base]/fhir/Patient/[patientId]/DocumentReference?bodySite=76986006 |
bodysite-reference | reference | Обследуемая часть тела | DocumentReference.bodySite.reference | GET [base]/fhir/Patient/[patientId]/DocumentReference?bodySite.reference=armLeft |
category | token | Классификация документов | DocumentReference.category | GET [base]/fhir/Patient/[patientId]/DocumentReference?category=image |
contenttype | token | Mime type из содержимого, с кодировкой и т.д. | DocumentReference.content.attachment.contentType | GET [base]/fhir/Patient/[patientId]/DocumentReference?contenttype=image |
context | reference | Контекст содержания документа | DocumentReference.context(Appointment, EpisodeOfCare, Encounter) | GET [base]/fhir/Patient/[patientId]/DocumentReference?context=Encounter001 |
creation | date | Дата создания приложения | DocumentReference.content.attachment.creation | GET [base]/fhir/Patient/[patientId]/DocumentReference?content.attachment.creation=2024-01-01 |
custodian | reference | Организация, которая ведет этот документ | DocumentReference.custodian(Organization) | GET [base]/fhir/Patient/[patientId]/DocumentReference?custodian=Organization001 |
date | date | Когда была создана ссылка на этот документ | DocumentReference.date | GET [base]/fhir/Patient/[patientId]/DocumentReference?date=2024-01-01 |
description | string | Удобочитаемое описание | DocumentReference.description | GET [base]/fhir/Patient/[patientId]/DocumentReference?description=Description |
doc-status | token | preliminary | final | amended | entered-in-error | DocumentReference.docStatus | GET [base]/fhir/Patient/[patientId]/DocumentReference?docStatus=final |
event-code | token | Основные клинические акты, задокументированные | DocumentReference.event.concept | GET [base]/fhir/Patient/[patientId]/DocumentReference?event-concept=_CreditCard |
event-reference | reference | Основные клинические акты, задокументированные | DocumentReference.event.reference | GET [base]/fhir/Patient/[patientId]/DocumentReference?event-reference=Encounter001 |
facility | token | Вид учреждения, где был осмотрен пациент | DocumentReference.facilityType | GET [base]/fhir/Patient/[patientId]/DocumentReference?facilityType=79993009 |
format-canonical | reference | Правила канонического содержимого профиля для документа | (DocumentReference.content.profile.value.ofType(canonical)) | GET [base]/fhir/Patient/[patientId]/DocumentReference?format-canonical=fhir.by/0001 |
format-code | token | Правила содержания кода формата для документа | (DocumentReference.content.profile.value.ofType(Coding)) | GET [base]/fhir/Patient/[patientId]/DocumentReference?format-code=urn:ihe:qrph:fp:2014 |
format-uri | uri | Правила содержания URI профиля для документа | (DocumentReference.content.profile.value.ofType(uri)) | GET [base]/fhir/Patient/[patientId]/DocumentReference?format-uri=urn:ihe:qrph:fp:2014 |
language | token | Содержание на понятном человеку языке (BCP-47) | DocumentReference.content.attachment.language | GET [base]/fhir/Patient/[patientId]/DocumentReference?language=En |
location | uri | Uri, по которому можно найти данные | DocumentReference.content.attachment.url | GET [base]/fhir/Patient/[patientId]/DocumentReference?location=http://example.by/DocumentReference001 |
modality | token | Используемый способ (modality) | DocumentReference.modality | GET [base]/fhir/Patient/[patientId]/DocumentReference?modality=dicom-cid-33-Modality |
patient | reference | Кто/что является субъектом документа | DocumentReference.subject.where(resolve() is Patient)(Patient) | GET [base]/fhir/Patient/[patientId]/DocumentReference?subject=Patient001 |
period | date | Время обслуживания, которое документируется | DocumentReference.period | GET [base]/fhir/Patient/[patientId]/DocumentReference?period=gt2024-01-01T10:20:00+00:00<2024-01-01T10:30:00+00:00 |
relatesto | reference | Цель взаимоотношений | DocumentReference.relatesTo.target(DocumentReference) | GET [base]/fhir/Patient/[patientId]/DocumentReference?relatesto=DocumentReference002 |
relation | token | replaces | transforms | signs | appends | DocumentReference.relatesTo.code | GET [base]/fhir/Patient/[patientId]/DocumentReference?relation=signs |
relationship | composite | Сочетание relation and relatesTo | On DocumentReference.relatesTo: relatesto: code relation: target | GET [base]/fhir/Patient/[patientId]/DocumentReference?relationship=replaces or GET [base]/fhir/Patient/[patientId]/DocumentReference?relationship=DocumentReference/002 |
security-label | token | Защитные метки документа | DocumentReference.securityLabel | GET [base]/fhir/Patient/[patientId]/DocumentReference?security-label=R |
setting | token | Дополнительные сведения о том, где был создан контент (например, клиническая специальность) | DocumentReference.practiceSetting | GET [base]/fhir/Patient/[patientId]/DocumentReference?setting=394579002 |
status | token | current | superseded | entered-in-error | DocumentReference.status | GET [base]/fhir/Patient/[patientId]/DocumentReference?status=current |
subject | reference | Кто/что является предметом документа | DocumentReference.subject(Any) | GET [base]/fhir/Patient/[patientId]/DocumentReference?subject=Device001 |
type | token | Вид документа (LOINC если возможно) | DocumentReference.type | GET [base]/fhir/Patient/[patientId]/DocumentReference?type=100018-1 |
version | string | Идентификатор бизнес-версии | DocumentReference.version | GET [base]/fhir/Patient/[patientId]/DocumentReference?version=1.1.1 |
binary-access-read | string | Cчитывание двоичного содержимого из элементов вложения | DocumentReference.content.attachment | GET [base]/fhir/Patient/[patientId]/1623/$binary-access-read?path=DocumentReference.content.attachment |