Current Build

Переводит команда Health Samurai . Приглашаем поучаствовать в русификации стандарта FHIR: GitHub , Email.

2.42 Ресурс DocumentReference - Назначение

Structured Documents Work GroupMaturity Level: 3 Trial UseSecurity Category: Not Classified Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

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

Как правило, ресурсы DocumentReference используются в системах индексирования документов, таких как IHE XDS , например в IHE Mobile access to Health Documents

DocumentReference is metadata describing a document such as:

  • CDA -документы в системах FHIR
  • FHIR-документы, хранящиеся в другом месте (т. е. реестре/репозитории, придерживающемся модели XDS) FHIR documents stored elsewhere (i.e. registry/repository following the XDS model)
  • PDF-документы , отсканированные документы и электронные копии факсов PDF documents , Scanned Paper, and digital records of faxes
  • Clinical Notes in various forms
  • Image files (e.g., JPEG, GIF, TIFF)
  • Non-Standard formats (e.g., WORD)
  • Other kinds of documents, such as records of prescriptions or immunizations

FHIR определяет и формат документа, и этот ресурс document reference. FHIR-документы предназначены для документов, которые созданы и собраны в FHIR. Этот ресурс предназначен в основном для общих ссылок на скомпонованные документы.

Документ, который является целью ссылки, может быть ссылкой на FHIR-документ, обслуживаемый другим сервером, либо цель может храниться в специальном FHIR-ресурсе Binary, либо цель может храниться в какой-то другой серверной системе. Document Reference также может адресовать документы, которые извлекаются с помощью вызова сервиса, такие как XDS.b RetrieveDocumentSet, или DICOM-обмен, или запрос HL7 v2 -сообщения, однако способ работы каждого их этих вызовов сервисов должен быть описан в каком-то внешнем стандарте или другой документации.

DocumentReference описывает несколько другой документ. Это означает, что имеется два ряда источников происхождения информации: происхождение документа и происхождение ссылки на документ. Иногда информация о происхождении тесно связана, например когда составитель документа также даёт и ссылку на этот документ, но в других рабочих процессах эта ссылка на документ создается позже другими участниками. В ресурсе DocumentReference содержимое элемента meta ссылается на происхождение самой ссылки, в то время как содержимое, описанное ниже, касается документа, на который даётся ссылка. Как и в случае остальных ресурсов, происходит некоторое дублирование информации в самом ресурсе и в общем ресурсе Provenance. Обсуждение на эту тему можно посмотреть в части описания ресурса Provenance.

На этот ресурс ссылаются AdverseEvent, CarePlan, Communication, CommunicationRequest, Consent, Contract, DeviceRequest, DeviceUseStatement, itself, FamilyMemberHistory, GuidanceResponse, ImagingStudy, MedicationKnowledge, MedicinalProduct, Observation, Procedure, RequestGroup, RiskAssessment, ServiceRequest, SubstanceReferenceInformation, SubstanceSpecification и SupplyRequest

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. DocumentReference TUDomainResourceСсылка на документ
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... masterIdentifier Σ0..1IdentifierИдентификатор, специфичный для мастер-версии
... identifier Σ0..*IdentifierДругие идентификаторы для этого документа
... status ?!Σ1..1codecurrent | superseded | entered-in-error
DocumentReferenceStatus (Required)
... docStatus Σ0..1codepreliminary | final | appended | amended | entered-in-error
CompositionStatus (Required)
... type Σ0..1CodeableConceptВид документа (LOINC-код, если возможно)
Document Type Value Set (Preferred)
... category Σ0..*CodeableConceptКлассификация документа
Document Class Value Set (Example)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device)Предмет документа
... date Σ0..1instantКогда этот document reference создан
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Кто и/или что является автором документа
... authenticator 0..1Reference(Practitioner | Organization)Кто/что подтвердил подлинность документа
... custodian 0..1Reference(Organization)Организация, отвечающая за обслуживание документа
... relatesTo Σ0..*BackboneElementВзаимосвязь с другими документами
.... code Σ1..1codereplaces | transforms | signs | appends
DocumentRelationshipType (Required)
.... target Σ1..1Reference(DocumentReference)Целевой документ взаимосвязи
... description Σ0..1stringHuman-readable description
... securityLabel Σ0..*CodeableConceptТеги уровня безопасности документа
SecurityLabels (Extensible)
... content Σ1..*BackboneElementОписываемый документ
.... attachment Σ1..1AttachmentГде доступен документ
.... format Σ0..1CodingПравила форматирования и структуры содержимого документа
DocumentReference Format Code Set (Preferred)
... context Σ0..1BackboneElementКлинический контекст документа
.... encounter 0..*Reference(Encounter | EpisodeOfCare)Контекст документа
.... event 0..*CodeableConceptЗадокументированные основные клинические акты
v3 Code System ActCode (Example)
.... period Σ0..1PeriodВремя услуги, которая документируется
.... facilityType 0..1CodeableConceptВид заведения, где наблюдался пациент
Facility Type Code Value Set (Example)
.... practiceSetting 0..1CodeableConceptДополнительная информация о том, где создавался контент (например клиническая специальность)
Practice Setting Code Value Set (Example)
.... sourcePatientInfo 0..1Reference(Patient)Демографическая информация о пациенте
.... related 0..*Reference(Any)Related identifiers or resources

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

UML-диаграмма (Legend)

DocumentReference (DomainResource)Идентификатор документа, назначенный источником этого документа. Этот идентификатор специфичен для данной версии документа. Этот уникальный идентификатор может использоваться в других местах для указания на эту версию документаmasterIdentifier : Identifier [0..1]Другие идентификаторы, ассоциированные с документом, включая версионно-независимые идентификаторыidentifier : Identifier [0..*]Статус документа (this element modifies the meaning of other elements)status : code [1..1] « The status of the document reference. (Strength=Required)DocumentReferenceStatus! »Статус лежащего в основе документаdocStatus : code [0..1] « Статус лежащего в основе документа. (Strength=Required)CompositionStatus! »Определяет конкретный вид документа (например анамнез и физикальный осмотр, выписной эпикриз, текущие заметки). Как правило, он совпадает с целью составления этого документаtype : CodeableConcept [0..1] « Точный тип клинического документа. (Strength=Preferred)DocumentTypeValueSet? »Классификация типа документа - содействует индексации и поиску. Может подразумеваться или вытекать из кода, указанного в элементе DocumentReference.typecategory : CodeableConcept [0..*] « Высокоуровневая классификация клинического документа на макроуровне. (Strength=Example)DocumentClassValueSet?? »О ком или о чем этот документ. Документ может быть о человеке (пациент или медицинский работник), об устройстве (т. е. машине) или даже о группе субъектов (например документ о стаде сельскохозяйственных животных, или документ о ряде пациентов, испытавших общее воздействие)subject : Reference [0..1] « Patient|Practitioner|Group|Device »Когда этот document reference был созданdate : instant [0..1]Определяет, кто ответственен за добавление информации в документauthor : Reference [0..*] « Practitioner|PractitionerRole| Organization|Device|Patient|RelatedPerson »Какое лицо или организация удостоверяет, что это документ действителенauthenticator : Reference [0..1] « Practitioner|Organization »Определяет организацию или группу, которая несет ответственность за текущее обслуживание и доступ к документуcustodian : Reference [0..1] « Organization »Human-readable description of the source documentdescription : string [0..1]A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers tosecurityLabel : CodeableConcept [0..*] « Security Labels from the Healthcare Privacy and Security Classification System. (Strength=Extensible)All Security Labels+ »RelatesToТип взаимосвязи этого документа с другим документомcode : code [1..1] « Тип взаимосвязи между документами. (Strength=Required)DocumentRelationshipType! »Целевой документ этой взаимосвязиtarget : Reference [1..1] « DocumentReference »ContentДокумент или URL-адрес документа вместе с важными метаданными для подтверждения целостности содержимогоattachment : Attachment [1..1]Идентификатор, определяющий кодировку документа, структуру и шаблон, которому соответствует документ помимо базового формата, указанного в mimeTypeformat : Coding [0..1] « Код формата документа. (Strength=Preferred)DocumentReferenceFormatCodeSet? »ContextОписывает случай клинического обслуживания или вид помощи, с которым связано содержимое документаencounter : Reference [0..*] « Encounter|EpisodeOfCare »Этот перечень кодов представляет собой задокументированные основные клинические акты, например колоноскопия или аппендэктомия. В некоторых случаях событие берется из typeCode, например "History and Physical Report", в котором документируемой процедурой обязательно будет акт "History and Physical"event : CodeableConcept [0..*] « Перечень кодов основных документируемых клинических актов. (Strength=Example)v3.ActCode?? »Период времени, в течение которого услуга, которая описана в документе, была предоставленаperiod : Period [0..1]Вид заведения, где наблюдался пациентfacilityType : CodeableConcept [0..1] « XDS Facility Type. (Strength=Example)FacilityTypeCodeValueSet?? »Это свойство может передавать подробности рабочих условий, в которых был создан контент, часто отражающие клиническую специальностьpracticeSetting : CodeableConcept [0..1] « Дополнительная информация о том, где был создан данный контент (например клиническая специальность). (Strength=Example) PracticeSettingCodeValueSet?? »Информация о пациенте, известная на момент публикации документа. Может быть ссылкой на конкретную версию или вложенный ресурсsourcePatientInfo : Reference [0..1] « Patient »Связанные идентификаторы или ресурсы, сопутствующие данному DocumentReferencerelated : Reference [0..*] « Any »Взаимосвязи этого документа с другими существующими document referencesrelatesTo[0..*]Документ и формат. Допустимо повторение элемента "content" с указанием разных форматовcontent[1..*]Клинический контекст, в котором документ был подготовленcontext[0..1]

XML-шаблон

<DocumentReference xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <masterIdentifier><!-- 0..1 Identifier Идентификатор, специфичный для мастер-версии --></masterIdentifier>
 <identifier><!-- 0..* Identifier Другие идентификаторы для этого документа --></identifier>
 <status value="[code]"/><!-- 1..1 current | superseded | entered-in-error -->
 <docStatus value="[code]"/><!-- 0..1 preliminary | final | appended | amended | entered-in-error -->
 <type><!-- 0..1 CodeableConcept Вид документа (LOINC-код, если возможно) --></type>
 <category><!-- 0..* CodeableConcept Классификация документа --></category>
 <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) Предмет документа --></subject>
 <date value="[instant]"/><!-- 0..1 Когда этот document reference создан -->
 <author><!-- 0..* Reference(Practitioner|PractitionerRole|Organization|Device|
   Patient|RelatedPerson) Кто и/или что является автором документа --></author>
 <authenticator><!-- 0..1 Reference(Practitioner|Organization) Кто/что подтвердил подлинность документа --></authenticator>
 <custodian><!-- 0..1 Reference(Organization) Организация, отвечающая за обслуживание документа --></custodian>
 <relatesTo>  <!-- 0..* Взаимосвязь с другими документами -->
  <code value="[code]"/><!-- 1..1 replaces | transforms | signs | appends -->
  <target><!-- 1..1 Reference(DocumentReference) Целевой документ взаимосвязи --></target>
 </relatesTo>
 <description value="[string]"/><!-- 0..1 Human-readable description -->
 <securityLabel><!-- 0..* CodeableConcept Теги уровня безопасности документа --></securityLabel>
 <content>  <!-- 1..* Описываемый документ -->
  <attachment><!-- 1..1 Attachment Где доступен документ --></attachment>
  <format><!-- 0..1 Coding Правила форматирования и структуры содержимого документа --></format>
 </content>
 <context>  <!-- 0..1 Клинический контекст документа -->
  <encounter><!-- 0..* Reference(Encounter|EpisodeOfCare) Контекст документа --></encounter>
  <event><!-- 0..* CodeableConcept Задокументированные основные клинические акты --></event>
  <period><!-- 0..1 Period Время услуги, которая документируется --></period>
  <facilityType><!-- 0..1 CodeableConcept Вид заведения, где наблюдался пациент --></facilityType>
  <practiceSetting><!-- 0..1 CodeableConcept Дополнительная информация о том, где создавался контент (например клиническая специальность) --></practiceSetting>
  <sourcePatientInfo><!-- 0..1 Reference(Patient) Демографическая информация о пациенте --></sourcePatientInfo>
  <related><!-- 0..* Reference(Any) Related identifiers or resources --></related>
 </context>
</DocumentReference>

JSON-шаблон

{doco
  "resourceType" : "DocumentReference",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "masterIdentifier" : { Identifier }, // Идентификатор, специфичный для мастер-версии
  "identifier" : [{ Identifier }], // Другие идентификаторы для этого документа
  "status" : "<code>", // R!  current | superseded | entered-in-error
  "docStatus" : "<code>", // preliminary | final | appended | amended | entered-in-error
  "type" : { CodeableConcept }, // Вид документа (LOINC-код, если возможно)
  "category" : [{ CodeableConcept }], // Классификация документа
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // Предмет документа
  "date" : "<instant>", // Когда этот document reference создан
  "author" : [{ Reference(Practitioner|PractitionerRole|Organization|Device|
   Patient|RelatedPerson) }], // Кто и/или что является автором документа
  "authenticator" : { Reference(Practitioner|Organization) }, // Кто/что подтвердил подлинность документа
  "custodian" : { Reference(Organization) }, // Организация, отвечающая за обслуживание документа
  "relatesTo" : [{ // Взаимосвязь с другими документами
    "code" : "<code>", // R!  replaces | transforms | signs | appends
    "target" : { Reference(DocumentReference) } // R!  Целевой документ взаимосвязи
  }],
  "description" : "<string>", // Human-readable description
  "securityLabel" : [{ CodeableConcept }], // Теги уровня безопасности документа
  "content" : [{ // R!  Описываемый документ
    "attachment" : { Attachment }, // R!  Где доступен документ
    "format" : { Coding } // Правила форматирования и структуры содержимого документа
  }],
  "context" : { // Клинический контекст документа
    "encounter" : [{ Reference(Encounter|EpisodeOfCare) }], // Контекст документа
    "event" : [{ CodeableConcept }], // Задокументированные основные клинические акты
    "period" : { Period }, // Время услуги, которая документируется
    "facilityType" : { CodeableConcept }, // Вид заведения, где наблюдался пациент
    "practiceSetting" : { CodeableConcept }, // Дополнительная информация о том, где создавался контент (например клиническая специальность)
    "sourcePatientInfo" : { Reference(Patient) }, // Демографическая информация о пациенте
    "related" : [{ Reference(Any) }] // Related identifiers or resources
  }
}

Turtle-шаблон

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DocumentReference;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:DocumentReference.masterIdentifier [ Identifier ]; # 0..1 Идентификатор, специфичный для мастер-версии
  fhir:DocumentReference.identifier [ Identifier ], ... ; # 0..* Другие идентификаторы для этого документа
  fhir:DocumentReference.status [ code ]; # 1..1 current | superseded | entered-in-error
  fhir:DocumentReference.docStatus [ code ]; # 0..1 preliminary | final | appended | amended | entered-in-error
  fhir:DocumentReference.type [ CodeableConcept ]; # 0..1 Вид документа (LOINC-код, если возможно)
  fhir:DocumentReference.category [ CodeableConcept ], ... ; # 0..* Классификация документа
  fhir:DocumentReference.subject [ Reference(Patient|Practitioner|Group|Device) ]; # 0..1 Предмет документа
  fhir:DocumentReference.date [ instant ]; # 0..1 Когда этот document reference создан
  fhir:DocumentReference.author [ Reference(Practitioner|PractitionerRole|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Кто и/или что является автором документа
  fhir:DocumentReference.authenticator [ Reference(Practitioner|Organization) ]; # 0..1 Кто/что подтвердил подлинность документа
  fhir:DocumentReference.custodian [ Reference(Organization) ]; # 0..1 Организация, отвечающая за обслуживание документа
  fhir:DocumentReference.relatesTo [ # 0..* Взаимосвязь с другими документами
    fhir:DocumentReference.relatesTo.code [ code ]; # 1..1 replaces | transforms | signs | appends
    fhir:DocumentReference.relatesTo.target [ Reference(DocumentReference) ]; # 1..1 Целевой документ взаимосвязи
  ], ...;
  fhir:DocumentReference.description [ string ]; # 0..1 Human-readable description
  fhir:DocumentReference.securityLabel [ CodeableConcept ], ... ; # 0..* Теги уровня безопасности документа
  fhir:DocumentReference.content [ # 1..* Описываемый документ
    fhir:DocumentReference.content.attachment [ Attachment ]; # 1..1 Где доступен документ
    fhir:DocumentReference.content.format [ Coding ]; # 0..1 Правила форматирования и структуры содержимого документа
  ], ...;
  fhir:DocumentReference.context [ # 0..1 Клинический контекст документа
    fhir:DocumentReference.context.encounter [ Reference(Encounter|EpisodeOfCare) ], ... ; # 0..* Контекст документа
    fhir:DocumentReference.context.event [ CodeableConcept ], ... ; # 0..* Задокументированные основные клинические акты
    fhir:DocumentReference.context.period [ Period ]; # 0..1 Время услуги, которая документируется
    fhir:DocumentReference.context.facilityType [ CodeableConcept ]; # 0..1 Вид заведения, где наблюдался пациент
    fhir:DocumentReference.context.practiceSetting [ CodeableConcept ]; # 0..1 Дополнительная информация о том, где создавался контент (например клиническая специальность)
    fhir:DocumentReference.context.sourcePatientInfo [ Reference(Patient) ]; # 0..1 Демографическая информация о пациенте
    fhir:DocumentReference.context.related [ Reference(Any) ], ... ; # 0..* Related identifiers or resources
  ];
]

Changes since R3

DocumentReference
DocumentReference.type
  • Min Cardinality changed from 1 to 0
DocumentReference.category
  • Renamed from class to category
  • Max Cardinality changed from 1 to *
DocumentReference.date
  • Added Element
DocumentReference.author
  • Type Reference: Added Target Type PractitionerRole
DocumentReference.relatesTo
  • No longer marked as Modifier
DocumentReference.context.encounter
  • Max Cardinality changed from 1 to *
  • Type Reference: Added Target Type EpisodeOfCare
DocumentReference.context.related
  • Type changed from BackboneElement to Reference(Resource)
DocumentReference.created
  • deleted
DocumentReference.indexed
  • deleted
DocumentReference.context.related.identifier
  • deleted
DocumentReference.context.related.ref
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. DocumentReference TUDomainResourceСсылка на документ
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... masterIdentifier Σ0..1IdentifierИдентификатор, специфичный для мастер-версии
... identifier Σ0..*IdentifierДругие идентификаторы для этого документа
... status ?!Σ1..1codecurrent | superseded | entered-in-error
DocumentReferenceStatus (Required)
... docStatus Σ0..1codepreliminary | final | appended | amended | entered-in-error
CompositionStatus (Required)
... type Σ0..1CodeableConceptВид документа (LOINC-код, если возможно)
Document Type Value Set (Preferred)
... category Σ0..*CodeableConceptКлассификация документа
Document Class Value Set (Example)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device)Предмет документа
... date Σ0..1instantКогда этот document reference создан
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Кто и/или что является автором документа
... authenticator 0..1Reference(Practitioner | Organization)Кто/что подтвердил подлинность документа
... custodian 0..1Reference(Organization)Организация, отвечающая за обслуживание документа
... relatesTo Σ0..*BackboneElementВзаимосвязь с другими документами
.... code Σ1..1codereplaces | transforms | signs | appends
DocumentRelationshipType (Required)
.... target Σ1..1Reference(DocumentReference)Целевой документ взаимосвязи
... description Σ0..1stringHuman-readable description
... securityLabel Σ0..*CodeableConceptТеги уровня безопасности документа
SecurityLabels (Extensible)
... content Σ1..*BackboneElementОписываемый документ
.... attachment Σ1..1AttachmentГде доступен документ
.... format Σ0..1CodingПравила форматирования и структуры содержимого документа
DocumentReference Format Code Set (Preferred)
... context Σ0..1BackboneElementКлинический контекст документа
.... encounter 0..*Reference(Encounter | EpisodeOfCare)Контекст документа
.... event 0..*CodeableConceptЗадокументированные основные клинические акты
v3 Code System ActCode (Example)
.... period Σ0..1PeriodВремя услуги, которая документируется
.... facilityType 0..1CodeableConceptВид заведения, где наблюдался пациент
Facility Type Code Value Set (Example)
.... practiceSetting 0..1CodeableConceptДополнительная информация о том, где создавался контент (например клиническая специальность)
Practice Setting Code Value Set (Example)
.... sourcePatientInfo 0..1Reference(Patient)Демографическая информация о пациенте
.... related 0..*Reference(Any)Related identifiers or resources

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

UML-диаграмма (Legend)

DocumentReference (DomainResource)Идентификатор документа, назначенный источником этого документа. Этот идентификатор специфичен для данной версии документа. Этот уникальный идентификатор может использоваться в других местах для указания на эту версию документаmasterIdentifier : Identifier [0..1]Другие идентификаторы, ассоциированные с документом, включая версионно-независимые идентификаторыidentifier : Identifier [0..*]Статус документа (this element modifies the meaning of other elements)status : code [1..1] « The status of the document reference. (Strength=Required)DocumentReferenceStatus! »Статус лежащего в основе документаdocStatus : code [0..1] « Статус лежащего в основе документа. (Strength=Required)CompositionStatus! »Определяет конкретный вид документа (например анамнез и физикальный осмотр, выписной эпикриз, текущие заметки). Как правило, он совпадает с целью составления этого документаtype : CodeableConcept [0..1] « Точный тип клинического документа. (Strength=Preferred)DocumentTypeValueSet? »Классификация типа документа - содействует индексации и поиску. Может подразумеваться или вытекать из кода, указанного в элементе DocumentReference.typecategory : CodeableConcept [0..*] « Высокоуровневая классификация клинического документа на макроуровне. (Strength=Example)DocumentClassValueSet?? »О ком или о чем этот документ. Документ может быть о человеке (пациент или медицинский работник), об устройстве (т. е. машине) или даже о группе субъектов (например документ о стаде сельскохозяйственных животных, или документ о ряде пациентов, испытавших общее воздействие)subject : Reference [0..1] « Patient|Practitioner|Group|Device »Когда этот document reference был созданdate : instant [0..1]Определяет, кто ответственен за добавление информации в документauthor : Reference [0..*] « Practitioner|PractitionerRole| Organization|Device|Patient|RelatedPerson »Какое лицо или организация удостоверяет, что это документ действителенauthenticator : Reference [0..1] « Practitioner|Organization »Определяет организацию или группу, которая несет ответственность за текущее обслуживание и доступ к документуcustodian : Reference [0..1] « Organization »Human-readable description of the source documentdescription : string [0..1]A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers tosecurityLabel : CodeableConcept [0..*] « Security Labels from the Healthcare Privacy and Security Classification System. (Strength=Extensible)All Security Labels+ »RelatesToТип взаимосвязи этого документа с другим документомcode : code [1..1] « Тип взаимосвязи между документами. (Strength=Required)DocumentRelationshipType! »Целевой документ этой взаимосвязиtarget : Reference [1..1] « DocumentReference »ContentДокумент или URL-адрес документа вместе с важными метаданными для подтверждения целостности содержимогоattachment : Attachment [1..1]Идентификатор, определяющий кодировку документа, структуру и шаблон, которому соответствует документ помимо базового формата, указанного в mimeTypeformat : Coding [0..1] « Код формата документа. (Strength=Preferred)DocumentReferenceFormatCodeSet? »ContextОписывает случай клинического обслуживания или вид помощи, с которым связано содержимое документаencounter : Reference [0..*] « Encounter|EpisodeOfCare »Этот перечень кодов представляет собой задокументированные основные клинические акты, например колоноскопия или аппендэктомия. В некоторых случаях событие берется из typeCode, например "History and Physical Report", в котором документируемой процедурой обязательно будет акт "History and Physical"event : CodeableConcept [0..*] « Перечень кодов основных документируемых клинических актов. (Strength=Example)v3.ActCode?? »Период времени, в течение которого услуга, которая описана в документе, была предоставленаperiod : Period [0..1]Вид заведения, где наблюдался пациентfacilityType : CodeableConcept [0..1] « XDS Facility Type. (Strength=Example)FacilityTypeCodeValueSet?? »Это свойство может передавать подробности рабочих условий, в которых был создан контент, часто отражающие клиническую специальностьpracticeSetting : CodeableConcept [0..1] « Дополнительная информация о том, где был создан данный контент (например клиническая специальность). (Strength=Example) PracticeSettingCodeValueSet?? »Информация о пациенте, известная на момент публикации документа. Может быть ссылкой на конкретную версию или вложенный ресурсsourcePatientInfo : Reference [0..1] « Patient »Связанные идентификаторы или ресурсы, сопутствующие данному DocumentReferencerelated : Reference [0..*] « Any »Взаимосвязи этого документа с другими существующими document referencesrelatesTo[0..*]Документ и формат. Допустимо повторение элемента "content" с указанием разных форматовcontent[1..*]Клинический контекст, в котором документ был подготовленcontext[0..1]

XML-шаблон

<DocumentReference xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <masterIdentifier><!-- 0..1 Identifier Идентификатор, специфичный для мастер-версии --></masterIdentifier>
 <identifier><!-- 0..* Identifier Другие идентификаторы для этого документа --></identifier>
 <status value="[code]"/><!-- 1..1 current | superseded | entered-in-error -->
 <docStatus value="[code]"/><!-- 0..1 preliminary | final | appended | amended | entered-in-error -->
 <type><!-- 0..1 CodeableConcept Вид документа (LOINC-код, если возможно) --></type>
 <category><!-- 0..* CodeableConcept Классификация документа --></category>
 <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) Предмет документа --></subject>
 <date value="[instant]"/><!-- 0..1 Когда этот document reference создан -->
 <author><!-- 0..* Reference(Practitioner|PractitionerRole|Organization|Device|
   Patient|RelatedPerson) Кто и/или что является автором документа --></author>
 <authenticator><!-- 0..1 Reference(Practitioner|Organization) Кто/что подтвердил подлинность документа --></authenticator>
 <custodian><!-- 0..1 Reference(Organization) Организация, отвечающая за обслуживание документа --></custodian>
 <relatesTo>  <!-- 0..* Взаимосвязь с другими документами -->
  <code value="[code]"/><!-- 1..1 replaces | transforms | signs | appends -->
  <target><!-- 1..1 Reference(DocumentReference) Целевой документ взаимосвязи --></target>
 </relatesTo>
 <description value="[string]"/><!-- 0..1 Human-readable description -->
 <securityLabel><!-- 0..* CodeableConcept Теги уровня безопасности документа --></securityLabel>
 <content>  <!-- 1..* Описываемый документ -->
  <attachment><!-- 1..1 Attachment Где доступен документ --></attachment>
  <format><!-- 0..1 Coding Правила форматирования и структуры содержимого документа --></format>
 </content>
 <context>  <!-- 0..1 Клинический контекст документа -->
  <encounter><!-- 0..* Reference(Encounter|EpisodeOfCare) Контекст документа --></encounter>
  <event><!-- 0..* CodeableConcept Задокументированные основные клинические акты --></event>
  <period><!-- 0..1 Period Время услуги, которая документируется --></period>
  <facilityType><!-- 0..1 CodeableConcept Вид заведения, где наблюдался пациент --></facilityType>
  <practiceSetting><!-- 0..1 CodeableConcept Дополнительная информация о том, где создавался контент (например клиническая специальность) --></practiceSetting>
  <sourcePatientInfo><!-- 0..1 Reference(Patient) Демографическая информация о пациенте --></sourcePatientInfo>
  <related><!-- 0..* Reference(Any) Related identifiers or resources --></related>
 </context>
</DocumentReference>

JSON-шаблон

{doco
  "resourceType" : "DocumentReference",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "masterIdentifier" : { Identifier }, // Идентификатор, специфичный для мастер-версии
  "identifier" : [{ Identifier }], // Другие идентификаторы для этого документа
  "status" : "<code>", // R!  current | superseded | entered-in-error
  "docStatus" : "<code>", // preliminary | final | appended | amended | entered-in-error
  "type" : { CodeableConcept }, // Вид документа (LOINC-код, если возможно)
  "category" : [{ CodeableConcept }], // Классификация документа
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // Предмет документа
  "date" : "<instant>", // Когда этот document reference создан
  "author" : [{ Reference(Practitioner|PractitionerRole|Organization|Device|
   Patient|RelatedPerson) }], // Кто и/или что является автором документа
  "authenticator" : { Reference(Practitioner|Organization) }, // Кто/что подтвердил подлинность документа
  "custodian" : { Reference(Organization) }, // Организация, отвечающая за обслуживание документа
  "relatesTo" : [{ // Взаимосвязь с другими документами
    "code" : "<code>", // R!  replaces | transforms | signs | appends
    "target" : { Reference(DocumentReference) } // R!  Целевой документ взаимосвязи
  }],
  "description" : "<string>", // Human-readable description
  "securityLabel" : [{ CodeableConcept }], // Теги уровня безопасности документа
  "content" : [{ // R!  Описываемый документ
    "attachment" : { Attachment }, // R!  Где доступен документ
    "format" : { Coding } // Правила форматирования и структуры содержимого документа
  }],
  "context" : { // Клинический контекст документа
    "encounter" : [{ Reference(Encounter|EpisodeOfCare) }], // Контекст документа
    "event" : [{ CodeableConcept }], // Задокументированные основные клинические акты
    "period" : { Period }, // Время услуги, которая документируется
    "facilityType" : { CodeableConcept }, // Вид заведения, где наблюдался пациент
    "practiceSetting" : { CodeableConcept }, // Дополнительная информация о том, где создавался контент (например клиническая специальность)
    "sourcePatientInfo" : { Reference(Patient) }, // Демографическая информация о пациенте
    "related" : [{ Reference(Any) }] // Related identifiers or resources
  }
}

Turtle-шаблон

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DocumentReference;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:DocumentReference.masterIdentifier [ Identifier ]; # 0..1 Идентификатор, специфичный для мастер-версии
  fhir:DocumentReference.identifier [ Identifier ], ... ; # 0..* Другие идентификаторы для этого документа
  fhir:DocumentReference.status [ code ]; # 1..1 current | superseded | entered-in-error
  fhir:DocumentReference.docStatus [ code ]; # 0..1 preliminary | final | appended | amended | entered-in-error
  fhir:DocumentReference.type [ CodeableConcept ]; # 0..1 Вид документа (LOINC-код, если возможно)
  fhir:DocumentReference.category [ CodeableConcept ], ... ; # 0..* Классификация документа
  fhir:DocumentReference.subject [ Reference(Patient|Practitioner|Group|Device) ]; # 0..1 Предмет документа
  fhir:DocumentReference.date [ instant ]; # 0..1 Когда этот document reference создан
  fhir:DocumentReference.author [ Reference(Practitioner|PractitionerRole|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Кто и/или что является автором документа
  fhir:DocumentReference.authenticator [ Reference(Practitioner|Organization) ]; # 0..1 Кто/что подтвердил подлинность документа
  fhir:DocumentReference.custodian [ Reference(Organization) ]; # 0..1 Организация, отвечающая за обслуживание документа
  fhir:DocumentReference.relatesTo [ # 0..* Взаимосвязь с другими документами
    fhir:DocumentReference.relatesTo.code [ code ]; # 1..1 replaces | transforms | signs | appends
    fhir:DocumentReference.relatesTo.target [ Reference(DocumentReference) ]; # 1..1 Целевой документ взаимосвязи
  ], ...;
  fhir:DocumentReference.description [ string ]; # 0..1 Human-readable description
  fhir:DocumentReference.securityLabel [ CodeableConcept ], ... ; # 0..* Теги уровня безопасности документа
  fhir:DocumentReference.content [ # 1..* Описываемый документ
    fhir:DocumentReference.content.attachment [ Attachment ]; # 1..1 Где доступен документ
    fhir:DocumentReference.content.format [ Coding ]; # 0..1 Правила форматирования и структуры содержимого документа
  ], ...;
  fhir:DocumentReference.context [ # 0..1 Клинический контекст документа
    fhir:DocumentReference.context.encounter [ Reference(Encounter|EpisodeOfCare) ], ... ; # 0..* Контекст документа
    fhir:DocumentReference.context.event [ CodeableConcept ], ... ; # 0..* Задокументированные основные клинические акты
    fhir:DocumentReference.context.period [ Period ]; # 0..1 Время услуги, которая документируется
    fhir:DocumentReference.context.facilityType [ CodeableConcept ]; # 0..1 Вид заведения, где наблюдался пациент
    fhir:DocumentReference.context.practiceSetting [ CodeableConcept ]; # 0..1 Дополнительная информация о том, где создавался контент (например клиническая специальность)
    fhir:DocumentReference.context.sourcePatientInfo [ Reference(Patient) ]; # 0..1 Демографическая информация о пациенте
    fhir:DocumentReference.context.related [ Reference(Any) ], ... ; # 0..* Related identifiers or resources
  ];
]

Changes since Release 3

DocumentReference
DocumentReference.type
  • Min Cardinality changed from 1 to 0
DocumentReference.category
  • Renamed from class to category
  • Max Cardinality changed from 1 to *
DocumentReference.date
  • Added Element
DocumentReference.author
  • Type Reference: Added Target Type PractitionerRole
DocumentReference.relatesTo
  • No longer marked as Modifier
DocumentReference.context.encounter
  • Max Cardinality changed from 1 to *
  • Type Reference: Added Target Type EpisodeOfCare
DocumentReference.context.related
  • Type changed from BackboneElement to Reference(Resource)
DocumentReference.created
  • deleted
DocumentReference.indexed
  • deleted
DocumentReference.context.related.identifier
  • deleted
DocumentReference.context.related.ref
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)

 

See the Profiles & Extensions and the Альтернативные определения: Основное определение XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the Анализ зависимостей

PathОписаниеТипСсылка
DocumentReference.status The status of the document reference.RequiredDocumentReferenceStatus
DocumentReference.docStatus Статус лежащего в основе документа.RequiredCompositionStatus
DocumentReference.type Точный тип клинического документа.PreferredDocumentTypeValueSet
DocumentReference.category Высокоуровневая классификация клинического документа на макроуровне.ExampleDocumentClassValueSet
DocumentReference.relatesTo.code Тип взаимосвязи между документами.RequiredDocumentRelationshipType
DocumentReference.securityLabel Security Labels from the Healthcare Privacy and Security Classification System.ExtensibleAll Security Labels
DocumentReference.content.format Код формата документа.PreferredDocumentReferenceFormatCodeSet
DocumentReference.context.event Перечень кодов основных документируемых клинических актов.Examplev3.ActCode
DocumentReference.context.facilityType XDS Facility Type.ExampleFacilityTypeCodeValueSet
DocumentReference.context.practiceSetting Дополнительная информация о том, где был создан данный контент (например клиническая специальность).ExamplePracticeSettingCodeValueSet

  • Использование кодов .docStatus рассматривается в статье Описание ресурса Composition
  • Ресурсы поддерживают односторонние взаимосвязи, которые ведут в обратном направлении - например документ, который замещает другой документ, указывает на документ, который он замещает. Обратные взаимосвязи можно отслеживать с помощью индексов, построенных из ресурсов. Как правило, это выполняется с помощью параметров поиска, описанных ниже. При условии, что документы могут иметь другие документы, которые их замещают или прилагаются к ним, клиенты должны всегда проверять эти взаимосвязи при обращении к документам

Клиент может запросить сервер сгенерировать Document Reference из документа. Сервер читает существующий документ и генерирует соответствующий ресурс DocumentReference, либо возвращает сгенерированный ранее. Серверы могут возвращать или генерировать DocumentReference для следующих типов контента:

Тип Комментарии
FHIR-документы URI ведет на существующий Document
CDA -документ URI - это ссылка на точку взаимодействия ресурса Binary, которая возвращает либо CDA-документ, либо какой-то вид CDA Package, который сервер знает как обрабатывать (например IHE .zip)
Другое Сервер могут запросить сгенерировать DocumentReference для других видов документов. Для некоторых из этих документов (например PDF-документов) сервер может предложить только ссылку на документ, если он уже существует, либо сервер имеет особые сведения об этом документе.

Сервер либо возвращает результаты поиска, содержащие отдельную ссылку на документ, либо он возвращает ошибку. Если этот URI ссылается на другой сервер, то решение о том, извлекать его или вернуть ошибку, остается на усмотрение сервера,.

Операция инициируется именованным запросом с помощью выполнения _query=generate в точке взаимодействия /DocumentReference:

  GET [service-url]/DocumentReference/?_query=generate&uri=:url&...

Параметр "uri" - это относительная или абсолютная ссылка на один из типов документов, описанных выше. Могут использоваться и другие параметры:

Имя Значение
persist Хранить ли документ в точке взаимодействия документа (/Document) или нет, после того как он сгенерирован. Value = true или false (значение по умолчанию - на усмотрение сервера).

Параметры поиска для этого ресурса. Также к нему применяются общие параметры. Более подробную информацию о поиске в REST, обмене сообщениями и сервисах см. в разделе Поиск.

ИмяТипОпределениеВыражениеIn Common
authenticatorreferenceКто/что подтвердил подлинность документаDocumentReference.authenticator
(Practitioner, Organization)
authorreferenceКто и/или что является автором документаDocumentReference.author
(Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson)
categorytokenКлассификация документаDocumentReference.category
contenttypetokenMime type of the content, with charset etc.DocumentReference.content.attachment.contentType
custodianreferenceОрганизация, отвечающая за обслуживание документаDocumentReference.custodian
(Organization)
datedateКогда этот document reference созданDocumentReference.date
descriptionstringHuman-readable descriptionDocumentReference.description
encounterreferenceКонтекст документаDocumentReference.context.encounter
(EpisodeOfCare, Encounter)
12 Resources
eventtokenЗадокументированные основные клинические актыDocumentReference.context.event
facilitytokenВид заведения, где наблюдался пациентDocumentReference.context.facilityType
formattokenПравила форматирования и структуры содержимого документаDocumentReference.content.format
identifiertokenИдентификатор, специфичный для мастер-версииDocumentReference.masterIdentifier | DocumentReference.identifier30 Resources
languagetokenHuman language of the content (BCP-47)DocumentReference.content.attachment.language
locationuriUri where the data can be foundDocumentReference.content.attachment.url
patientreferenceПредмет документаDocumentReference.subject.where(resolve() is Patient)
(Patient)
29 Resources
perioddateВремя услуги, которая документируетсяDocumentReference.context.period
relatedreferenceRelated identifiers or resourcesDocumentReference.context.related
(Any)
relatestoreferenceЦелевой документ взаимосвязиDocumentReference.relatesTo.target
(DocumentReference)
relationtokenreplaces | transforms | signs | appendsDocumentReference.relatesTo.code
relationshipcompositeКомбинация из relation и relatesToOn DocumentReference.relatesTo:
  relatesto: code
  relation: target
security-labeltokenТеги уровня безопасности документаDocumentReference.securityLabel
settingtokenДополнительная информация о том, где создавался контент (например клиническая специальность)DocumentReference.context.practiceSetting
statustokencurrent | superseded | entered-in-errorDocumentReference.status
subjectreferenceПредмет документаDocumentReference.subject
(Practitioner, Group, Device, Patient)
typetokenВид документа (LOINC-код, если возможно)DocumentReference.type5 Resources