Current Build

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

2.43 Ресурс DocumentManifest - Назначение

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

A collection of documents compiled for a purpose together with metadata that applies to the collection.

Ресурс DocumentManifest используется для компоновки нескольких ресурсов в единый пакет с неким клиническим контекстом. Такой пакет может участвовать в рабочих процессах, таких как адресная доставка. A document manifest gathers a set of Resources into a single package with some clinical context that may be the subject of workflow such as targeted delivery. The usage of "document" in the case of DocumentManifest, covers the broader scope of "document" as defined in REST and HTTP. This use is not limited to the formal "Document" model used for FHIR documents or DocumentReference resources.

Как правило, ресурсы DocumentManifest используются в системах индексирования документов, например IHE XDS. Such as profiled in IHE Mobile access to Health Documents . When used as a Manifest of "Documents" in this way, the DocumentManifest will point exclusively to DocumentReference resources.

A DocumentManifest resource could be used to bring clinical context grouping to a broader set of Resources.

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. DocumentManifest TUDomainResourceA list that defines a set of documents
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... masterIdentifier Σ0..1IdentifierУникальный идентификатор набора документов
... identifier Σ0..*IdentifierДругие идентификаторы манифеста
... status ?!Σ1..1codecurrent | superseded | entered-in-error
DocumentReferenceStatus (Required)
... type Σ0..1CodeableConceptВид набора документов
v3 Code System ActCode (Example)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device)Тема (объект) набора документов
... created 0..1dateTimeКогда этот манифест документов был создан
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the DocumentManifest
... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)Кому предназначено уведомление об этом наборе документов
... source 0..1uriИсходная система/приложение/программное обеспечение
... description Σ0..1stringЧеловекочитаемое описание (заголовок)
... content Σ1..*Reference(Any)Items in manifest
... related 0..*BackboneElementСвязанные объекты
.... identifier 0..1IdentifierИдентификаторы связанных объектов
.... ref 0..1Reference(Any)Связанный ресурс

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

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

DocumentManifest (DomainResource)Один идентификатор, уникальным образом идентифицирующий этот манифест. В основном используется для ссылки на манифест в не-FHIR контекстеmasterIdentifier : Identifier [0..1]Другие идентификаторы, ассоциированные с document manifest, включая версионно-независимые идентификаторыidentifier : Identifier [0..*]Статус манифеста документов (this element modifies the meaning of other elements)status : code [1..1] « The status of the document reference. (Strength=Required)DocumentReferenceStatus! »The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifesttype : CodeableConcept [0..1] « The activity that caused the DocumentManifest to be created. (Strength=Example)v3.ActCode?? »О ком или о чем этот набор документов. Документы могут быть о человеке (пациент или медицинский работник), устройстве (например машина) или даже о группе объектов (например документ о стаде сельскохозяйственных животных или ряде пациентов, объединенных общим лечением). Если документы относятся больше чем к одному объекту, тогда здесь можно указывать больше одного значения (нетипичный случай использования)subject : Reference [0..1] « Patient|Practitioner|Group|Device »Когда манифест документов был создан для отправки на сервер (не обязательно то же самое, что и время последнего изменения ресурса, так как он может быть изменен, копирован и т. д.)created : dateTime [0..1]Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references includedauthor : Reference [0..*] « Practitioner|PractitionerRole| Organization|Device|Patient|RelatedPerson »Пациент, медицинский работник, или организация, которой предназначен этот набор документовrecipient : Reference [0..*] « Patient|Practitioner|PractitionerRole| RelatedPerson|Organization »Указывает исходную систему, приложение или программное обеспечение, в которых был создан манифест документовsource : uri [0..1]Человекочитаемое описание документа-источника. Также известно как "заголовок"description : string [0..1]The list of Resources that consist of the parts of this manifestcontent : Reference [1..*] « Any »RelatedСвязанный идентификатор этого DocumentManifest. Например порядковый номер, XDW-номерidentifier : Identifier [0..1]Связанный с этим DocumentManifest ресурс. Например Order, DiagnosticOrder, Procedure, EligibilityRequest и т. дref : Reference [0..1] « Any »Связанные идентификаторы или ресурсы, ассоциированные с этим DocumentManifestrelated[0..*]

XML-шаблон

<DocumentManifest 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 -->
 <type><!-- 0..1 CodeableConcept Вид набора документов --></type>
 <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) Тема (объект) набора документов --></subject>
 <created value="[dateTime]"/><!-- 0..1 Когда этот манифест документов был создан -->
 <author><!-- 0..* Reference(Practitioner|PractitionerRole|Organization|Device|
   Patient|RelatedPerson) Who and/or what authored the DocumentManifest --></author>
 <recipient><!-- 0..* Reference(Patient|Practitioner|PractitionerRole|
   RelatedPerson|Organization) Кому предназначено уведомление об этом наборе документов --></recipient>
 <source value="[uri]"/><!-- 0..1 Исходная система/приложение/программное обеспечение -->
 <description value="[string]"/><!-- 0..1 Человекочитаемое описание (заголовок) -->
 <content><!-- 1..* Reference(Any) Items in manifest --></content>
 <related>  <!-- 0..* Связанные объекты -->
  <identifier><!-- 0..1 Identifier Идентификаторы связанных объектов --></identifier>
  <ref><!-- 0..1 Reference(Any) Связанный ресурс --></ref>
 </related>
</DocumentManifest>

JSON-шаблон

{doco
  "resourceType" : "DocumentManifest",
  // 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
  "type" : { CodeableConcept }, // Вид набора документов
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // Тема (объект) набора документов
  "created" : "<dateTime>", // Когда этот манифест документов был создан
  "author" : [{ Reference(Practitioner|PractitionerRole|Organization|Device|
   Patient|RelatedPerson) }], // Who and/or what authored the DocumentManifest
  "recipient" : [{ Reference(Patient|Practitioner|PractitionerRole|
   RelatedPerson|Organization) }], // Кому предназначено уведомление об этом наборе документов
  "source" : "<uri>", // Исходная система/приложение/программное обеспечение
  "description" : "<string>", // Человекочитаемое описание (заголовок)
  "content" : [{ Reference(Any) }], // R!  Items in manifest
  "related" : [{ // Связанные объекты
    "identifier" : { Identifier }, // Идентификаторы связанных объектов
    "ref" : { Reference(Any) } // Связанный ресурс
  }]
}

Turtle-шаблон

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


[ a fhir:DocumentManifest;
  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:DocumentManifest.masterIdentifier [ Identifier ]; # 0..1 Уникальный идентификатор набора документов
  fhir:DocumentManifest.identifier [ Identifier ], ... ; # 0..* Другие идентификаторы манифеста
  fhir:DocumentManifest.status [ code ]; # 1..1 current | superseded | entered-in-error
  fhir:DocumentManifest.type [ CodeableConcept ]; # 0..1 Вид набора документов
  fhir:DocumentManifest.subject [ Reference(Patient|Practitioner|Group|Device) ]; # 0..1 Тема (объект) набора документов
  fhir:DocumentManifest.created [ dateTime ]; # 0..1 Когда этот манифест документов был создан
  fhir:DocumentManifest.author [ Reference(Practitioner|PractitionerRole|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Who and/or what authored the DocumentManifest
  fhir:DocumentManifest.recipient [ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|Organization) ], ... ; # 0..* Кому предназначено уведомление об этом наборе документов
  fhir:DocumentManifest.source [ uri ]; # 0..1 Исходная система/приложение/программное обеспечение
  fhir:DocumentManifest.description [ string ]; # 0..1 Человекочитаемое описание (заголовок)
  fhir:DocumentManifest.content [ Reference(Any) ], ... ; # 1..* Items in manifest
  fhir:DocumentManifest.related [ # 0..* Связанные объекты
    fhir:DocumentManifest.related.identifier [ Identifier ]; # 0..1 Идентификаторы связанных объектов
    fhir:DocumentManifest.related.ref [ Reference(Any) ]; # 0..1 Связанный ресурс
  ], ...;
]

Changes since R3

DocumentManifest
DocumentManifest.author
  • Type Reference: Added Target Type PractitionerRole
DocumentManifest.recipient
  • Type Reference: Added Target Type PractitionerRole
DocumentManifest.content
  • Type changed from BackboneElement to Reference(Resource)
DocumentManifest.content.p[x]
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. DocumentManifest TUDomainResourceA list that defines a set of documents
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... masterIdentifier Σ0..1IdentifierУникальный идентификатор набора документов
... identifier Σ0..*IdentifierДругие идентификаторы манифеста
... status ?!Σ1..1codecurrent | superseded | entered-in-error
DocumentReferenceStatus (Required)
... type Σ0..1CodeableConceptВид набора документов
v3 Code System ActCode (Example)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device)Тема (объект) набора документов
... created 0..1dateTimeКогда этот манифест документов был создан
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the DocumentManifest
... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)Кому предназначено уведомление об этом наборе документов
... source 0..1uriИсходная система/приложение/программное обеспечение
... description Σ0..1stringЧеловекочитаемое описание (заголовок)
... content Σ1..*Reference(Any)Items in manifest
... related 0..*BackboneElementСвязанные объекты
.... identifier 0..1IdentifierИдентификаторы связанных объектов
.... ref 0..1Reference(Any)Связанный ресурс

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

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

DocumentManifest (DomainResource)Один идентификатор, уникальным образом идентифицирующий этот манифест. В основном используется для ссылки на манифест в не-FHIR контекстеmasterIdentifier : Identifier [0..1]Другие идентификаторы, ассоциированные с document manifest, включая версионно-независимые идентификаторыidentifier : Identifier [0..*]Статус манифеста документов (this element modifies the meaning of other elements)status : code [1..1] « The status of the document reference. (Strength=Required)DocumentReferenceStatus! »The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifesttype : CodeableConcept [0..1] « The activity that caused the DocumentManifest to be created. (Strength=Example)v3.ActCode?? »О ком или о чем этот набор документов. Документы могут быть о человеке (пациент или медицинский работник), устройстве (например машина) или даже о группе объектов (например документ о стаде сельскохозяйственных животных или ряде пациентов, объединенных общим лечением). Если документы относятся больше чем к одному объекту, тогда здесь можно указывать больше одного значения (нетипичный случай использования)subject : Reference [0..1] « Patient|Practitioner|Group|Device »Когда манифест документов был создан для отправки на сервер (не обязательно то же самое, что и время последнего изменения ресурса, так как он может быть изменен, копирован и т. д.)created : dateTime [0..1]Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references includedauthor : Reference [0..*] « Practitioner|PractitionerRole| Organization|Device|Patient|RelatedPerson »Пациент, медицинский работник, или организация, которой предназначен этот набор документовrecipient : Reference [0..*] « Patient|Practitioner|PractitionerRole| RelatedPerson|Organization »Указывает исходную систему, приложение или программное обеспечение, в которых был создан манифест документовsource : uri [0..1]Человекочитаемое описание документа-источника. Также известно как "заголовок"description : string [0..1]The list of Resources that consist of the parts of this manifestcontent : Reference [1..*] « Any »RelatedСвязанный идентификатор этого DocumentManifest. Например порядковый номер, XDW-номерidentifier : Identifier [0..1]Связанный с этим DocumentManifest ресурс. Например Order, DiagnosticOrder, Procedure, EligibilityRequest и т. дref : Reference [0..1] « Any »Связанные идентификаторы или ресурсы, ассоциированные с этим DocumentManifestrelated[0..*]

XML-шаблон

<DocumentManifest 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 -->
 <type><!-- 0..1 CodeableConcept Вид набора документов --></type>
 <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) Тема (объект) набора документов --></subject>
 <created value="[dateTime]"/><!-- 0..1 Когда этот манифест документов был создан -->
 <author><!-- 0..* Reference(Practitioner|PractitionerRole|Organization|Device|
   Patient|RelatedPerson) Who and/or what authored the DocumentManifest --></author>
 <recipient><!-- 0..* Reference(Patient|Practitioner|PractitionerRole|
   RelatedPerson|Organization) Кому предназначено уведомление об этом наборе документов --></recipient>
 <source value="[uri]"/><!-- 0..1 Исходная система/приложение/программное обеспечение -->
 <description value="[string]"/><!-- 0..1 Человекочитаемое описание (заголовок) -->
 <content><!-- 1..* Reference(Any) Items in manifest --></content>
 <related>  <!-- 0..* Связанные объекты -->
  <identifier><!-- 0..1 Identifier Идентификаторы связанных объектов --></identifier>
  <ref><!-- 0..1 Reference(Any) Связанный ресурс --></ref>
 </related>
</DocumentManifest>

JSON-шаблон

{doco
  "resourceType" : "DocumentManifest",
  // 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
  "type" : { CodeableConcept }, // Вид набора документов
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // Тема (объект) набора документов
  "created" : "<dateTime>", // Когда этот манифест документов был создан
  "author" : [{ Reference(Practitioner|PractitionerRole|Organization|Device|
   Patient|RelatedPerson) }], // Who and/or what authored the DocumentManifest
  "recipient" : [{ Reference(Patient|Practitioner|PractitionerRole|
   RelatedPerson|Organization) }], // Кому предназначено уведомление об этом наборе документов
  "source" : "<uri>", // Исходная система/приложение/программное обеспечение
  "description" : "<string>", // Человекочитаемое описание (заголовок)
  "content" : [{ Reference(Any) }], // R!  Items in manifest
  "related" : [{ // Связанные объекты
    "identifier" : { Identifier }, // Идентификаторы связанных объектов
    "ref" : { Reference(Any) } // Связанный ресурс
  }]
}

Turtle-шаблон

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


[ a fhir:DocumentManifest;
  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:DocumentManifest.masterIdentifier [ Identifier ]; # 0..1 Уникальный идентификатор набора документов
  fhir:DocumentManifest.identifier [ Identifier ], ... ; # 0..* Другие идентификаторы манифеста
  fhir:DocumentManifest.status [ code ]; # 1..1 current | superseded | entered-in-error
  fhir:DocumentManifest.type [ CodeableConcept ]; # 0..1 Вид набора документов
  fhir:DocumentManifest.subject [ Reference(Patient|Practitioner|Group|Device) ]; # 0..1 Тема (объект) набора документов
  fhir:DocumentManifest.created [ dateTime ]; # 0..1 Когда этот манифест документов был создан
  fhir:DocumentManifest.author [ Reference(Practitioner|PractitionerRole|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Who and/or what authored the DocumentManifest
  fhir:DocumentManifest.recipient [ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|Organization) ], ... ; # 0..* Кому предназначено уведомление об этом наборе документов
  fhir:DocumentManifest.source [ uri ]; # 0..1 Исходная система/приложение/программное обеспечение
  fhir:DocumentManifest.description [ string ]; # 0..1 Человекочитаемое описание (заголовок)
  fhir:DocumentManifest.content [ Reference(Any) ], ... ; # 1..* Items in manifest
  fhir:DocumentManifest.related [ # 0..* Связанные объекты
    fhir:DocumentManifest.related.identifier [ Identifier ]; # 0..1 Идентификаторы связанных объектов
    fhir:DocumentManifest.related.ref [ Reference(Any) ]; # 0..1 Связанный ресурс
  ], ...;
]

Changes since Release 3

DocumentManifest
DocumentManifest.author
  • Type Reference: Added Target Type PractitionerRole
DocumentManifest.recipient
  • Type Reference: Added Target Type PractitionerRole
DocumentManifest.content
  • Type changed from BackboneElement to Reference(Resource)
DocumentManifest.content.p[x]
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 2 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ОписаниеТипСсылка
DocumentManifest.status The status of the document reference.RequiredDocumentReferenceStatus
DocumentManifest.type The activity that caused the DocumentManifest to be created.Examplev3.ActCode

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

ИмяТипОпределениеВыражениеIn Common
authorreferenceWho and/or what authored the DocumentManifestDocumentManifest.author
(Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson)
createddateКогда этот манифест документов был созданDocumentManifest.created
descriptionstringЧеловекочитаемое описание (заголовок)DocumentManifest.description
identifiertokenУникальный идентификатор набора документовDocumentManifest.masterIdentifier | DocumentManifest.identifier30 Resources
itemreferenceItems in manifestDocumentManifest.content
(Any)
patientreferenceТема (объект) набора документовDocumentManifest.subject.where(resolve() is Patient)
(Patient)
29 Resources
recipientreferenceКому предназначено уведомление об этом наборе документовDocumentManifest.recipient
(Practitioner, Organization, Patient, PractitionerRole, RelatedPerson)
related-idtokenИдентификаторы связанных объектовDocumentManifest.related.identifier
related-refreferenceСвязанный ресурсDocumentManifest.related.ref
(Any)
sourceuriИсходная система/приложение/программное обеспечениеDocumentManifest.source
statustokencurrent | superseded | entered-in-errorDocumentManifest.status
subjectreferenceТема (объект) набора документовDocumentManifest.subject
(Practitioner, Group, Device, Patient)
typetokenВид набора документовDocumentManifest.type5 Resources