2.43 资源之文档清单 - 简介

隔间: Device, Encounter, Patient, Practitioner, RelatedPerson

为某种目的编译的文档集合，其中包含了该集合的元数据。

2.43.1 范围与用法

一个文档清单，它将一组资源集中到一个包中，这个包拥有的临床场景可能是工作流的目标对象，如靶向给药。在DocumentManifest中，“document”的用法涵盖的范围比REST和HTTP中“document”的范围更广。此用法不限于在正式“文档”模型使用中，这些模型用于 FHIR 文档或 DocumentReference资源。

通常，文档清单DocumentManifest资源用于文档索引系统，如IHE XDS 。正如在IHE移动接入医疗文档里介绍的一样，当以这种方式用作“文档”的清单时，DocumentManifest将固定的指向DocumentReference资源。

文档清单资源可将临床场景分组带入更广泛的资源集。

Structure

Name	Flags	Card.	Type	Description & Constraints
DocumentManifest	TU		DomainResource	A list that defines a set of documents Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
masterIdentifier	Σ	0..1	Identifier	Unique Identifier for the set of documents
identifier	Σ	0..*	Identifier	Other identifiers for the manifest
status	?!Σ	1..1	code	current \| superseded \| entered-in-error DocumentReferenceStatus (Required)
type	Σ	0..1	CodeableConcept	Kind of document set v3 Code System ActCode (Example)
subject	Σ	0..1	Reference(Patient \| Practitioner \| Group \| Device)	The subject of the set of documents
created		0..1	dateTime	When this document manifest created
author	Σ	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| Device \| Patient \| RelatedPerson)	Who and/or what authored the DocumentManifest
recipient		0..*	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Organization)	Intended to get notified about this set of documents
source		0..1	uri	The source system/application/software
description	Σ	0..1	string	Human-readable description (title)
content	Σ	1..*	Reference(Any)	Items in manifest
related		0..*	BackboneElement	Related things
identifier		0..1	Identifier	Identifiers of things that are related
ref		0..1	Reference(Any)	Related Resource
Documentation for this format

XML Template

<DocumentManifest xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <masterIdentifier><!-- 0..1 Identifier Unique Identifier for the set of documents --></masterIdentifier>
 <identifier><!-- 0..* Identifier Other identifiers for the manifest --></identifier>
 <status value="[code]"/><!-- 1..1 current | superseded | entered-in-error -->
 <type><!-- 0..1 CodeableConcept Kind of document set --></type>
 <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) The subject of the set of documents --></subject>
 <created value="[dateTime]"/><!-- 0..1 When this document manifest created -->
 <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) Intended to get notified about this set of documents --></recipient>
 <source value="[uri]"/><!-- 0..1 The source system/application/software -->
 <description value="[string]"/><!-- 0..1 Human-readable description (title) -->
 <content><!-- 1..* Reference(Any) Items in manifest --></content>
 <related>  <!-- 0..* Related things -->
  <identifier><!-- 0..1 Identifier Identifiers of things that are related --></identifier>
  <ref><!-- 0..1 Reference(Any) Related Resource --></ref>
 </related>
</DocumentManifest>

JSON Template

{
  "resourceType" : "DocumentManifest",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "masterIdentifier" : { Identifier }, // Unique Identifier for the set of documents
  "identifier" : [{ Identifier }], // Other identifiers for the manifest
  "status" : "<code>", // R!  current | superseded | entered-in-error
  "type" : { CodeableConcept }, // Kind of document set
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // The subject of the set of documents
  "created" : "<dateTime>", // When this document manifest created
  "author" : [{ Reference(Practitioner|PractitionerRole|Organization|Device|
                                        Patient|RelatedPerson) }], // Who and/or what authored the DocumentManifest
  "recipient" : [{ Reference(Patient|Practitioner|PractitionerRole|
                                        RelatedPerson|Organization) }], // Intended to get notified about this set of documents
  "source" : "<uri>", // The source system/application/software
  "description" : "<string>", // Human-readable description (title)
  "content" : [{ Reference(Any) }], // R!  Items in manifest
  "related" : [{ // Related things
    "identifier" : { Identifier }, // Identifiers of things that are related
    "ref" : { Reference(Any) } // Related Resource
  }]
}

Turtle Template

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


[ 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 Unique Identifier for the set of documents
  fhir:DocumentManifest.identifier [ Identifier ], ... ; # 0..* Other identifiers for the manifest
  fhir:DocumentManifest.status [ code ]; # 1..1 current | superseded | entered-in-error
  fhir:DocumentManifest.type [ CodeableConcept ]; # 0..1 Kind of document set
  fhir:DocumentManifest.subject [ Reference(Patient|Practitioner|Group|Device) ]; # 0..1 The subject of the set of documents
  fhir:DocumentManifest.created [ dateTime ]; # 0..1 When this document manifest created
  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..* Intended to get notified about this set of documents
  fhir:DocumentManifest.source [ uri ]; # 0..1 The source system/application/software
  fhir:DocumentManifest.description [ string ]; # 0..1 Human-readable description (title)
  fhir:DocumentManifest.content [ Reference(Any) ], ... ; # 1..* Items in manifest
  fhir:DocumentManifest.related [ # 0..* Related things
    fhir:DocumentManifest.related.identifier [ Identifier ]; # 0..1 Identifiers of things that are related
    fhir:DocumentManifest.related.ref [ Reference(Any) ]; # 0..1 Related Resource
  ], ...;
]

Changes since R3

DocumentManifest

DocumentManifest.status

Change value set from http://hl7.org/fhir/ValueSet/document-reference-status to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.0

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 of which 2 fail to execute.)

Structure

Name	Flags	Card.	Type	Description & Constraints
DocumentManifest	TU		DomainResource	A list that defines a set of documents Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
masterIdentifier	Σ	0..1	Identifier	Unique Identifier for the set of documents
identifier	Σ	0..*	Identifier	Other identifiers for the manifest
status	?!Σ	1..1	code	current \| superseded \| entered-in-error DocumentReferenceStatus (Required)
type	Σ	0..1	CodeableConcept	Kind of document set v3 Code System ActCode (Example)
subject	Σ	0..1	Reference(Patient \| Practitioner \| Group \| Device)	The subject of the set of documents
created		0..1	dateTime	When this document manifest created
author	Σ	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| Device \| Patient \| RelatedPerson)	Who and/or what authored the DocumentManifest
recipient		0..*	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Organization)	Intended to get notified about this set of documents
source		0..1	uri	The source system/application/software
description	Σ	0..1	string	Human-readable description (title)
content	Σ	1..*	Reference(Any)	Items in manifest
related		0..*	BackboneElement	Related things
identifier		0..1	Identifier	Identifiers of things that are related
ref		0..1	Reference(Any)	Related Resource
Documentation for this format

XML Template

<DocumentManifest xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <masterIdentifier><!-- 0..1 Identifier Unique Identifier for the set of documents --></masterIdentifier>
 <identifier><!-- 0..* Identifier Other identifiers for the manifest --></identifier>
 <status value="[code]"/><!-- 1..1 current | superseded | entered-in-error -->
 <type><!-- 0..1 CodeableConcept Kind of document set --></type>
 <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) The subject of the set of documents --></subject>
 <created value="[dateTime]"/><!-- 0..1 When this document manifest created -->
 <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) Intended to get notified about this set of documents --></recipient>
 <source value="[uri]"/><!-- 0..1 The source system/application/software -->
 <description value="[string]"/><!-- 0..1 Human-readable description (title) -->
 <content><!-- 1..* Reference(Any) Items in manifest --></content>
 <related>  <!-- 0..* Related things -->
  <identifier><!-- 0..1 Identifier Identifiers of things that are related --></identifier>
  <ref><!-- 0..1 Reference(Any) Related Resource --></ref>
 </related>
</DocumentManifest>

JSON Template

{
  "resourceType" : "DocumentManifest",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "masterIdentifier" : { Identifier }, // Unique Identifier for the set of documents
  "identifier" : [{ Identifier }], // Other identifiers for the manifest
  "status" : "<code>", // R!  current | superseded | entered-in-error
  "type" : { CodeableConcept }, // Kind of document set
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // The subject of the set of documents
  "created" : "<dateTime>", // When this document manifest created
  "author" : [{ Reference(Practitioner|PractitionerRole|Organization|Device|
                                        Patient|RelatedPerson) }], // Who and/or what authored the DocumentManifest
  "recipient" : [{ Reference(Patient|Practitioner|PractitionerRole|
                                        RelatedPerson|Organization) }], // Intended to get notified about this set of documents
  "source" : "<uri>", // The source system/application/software
  "description" : "<string>", // Human-readable description (title)
  "content" : [{ Reference(Any) }], // R!  Items in manifest
  "related" : [{ // Related things
    "identifier" : { Identifier }, // Identifiers of things that are related
    "ref" : { Reference(Any) } // Related Resource
  }]
}

Turtle Template

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


[ 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 Unique Identifier for the set of documents
  fhir:DocumentManifest.identifier [ Identifier ], ... ; # 0..* Other identifiers for the manifest
  fhir:DocumentManifest.status [ code ]; # 1..1 current | superseded | entered-in-error
  fhir:DocumentManifest.type [ CodeableConcept ]; # 0..1 Kind of document set
  fhir:DocumentManifest.subject [ Reference(Patient|Practitioner|Group|Device) ]; # 0..1 The subject of the set of documents
  fhir:DocumentManifest.created [ dateTime ]; # 0..1 When this document manifest created
  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..* Intended to get notified about this set of documents
  fhir:DocumentManifest.source [ uri ]; # 0..1 The source system/application/software
  fhir:DocumentManifest.description [ string ]; # 0..1 Human-readable description (title)
  fhir:DocumentManifest.content [ Reference(Any) ], ... ; # 1..* Items in manifest
  fhir:DocumentManifest.related [ # 0..* Related things
    fhir:DocumentManifest.related.identifier [ Identifier ]; # 0..1 Identifiers of things that are related
    fhir:DocumentManifest.related.ref [ Reference(Any) ]; # 0..1 Related Resource
  ], ...;
]

Changes since Release 3

DocumentManifest

DocumentManifest.status

Change value set from http://hl7.org/fhir/ValueSet/document-reference-status to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.0

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 of which 2 fail to execute.)

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

2.43.2.1 Terminology Bindings

Path	Definition	Type	Reference
DocumentManifest.status	The status of the document reference.	Required	DocumentReferenceStatus
DocumentManifest.type	The activity that caused the DocumentManifest to be created.	Example	v3.ActCode

Path

Definition

Type

Reference

DocumentManifest.status

The status of the document reference.

Required

DocumentReferenceStatus

DocumentManifest.type

The activity that caused the DocumentManifest to be created.

Example

v3.ActCode

2.43.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
author	reference	Who and/or what authored the DocumentManifest	DocumentManifest.author (Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson)
created	date	When this document manifest created	DocumentManifest.created
description	string	Human-readable description (title)	DocumentManifest.description
identifier	token	Unique Identifier for the set of documents	DocumentManifest.masterIdentifier \| DocumentManifest.identifier	30 Resources
item	reference	Items in manifest	DocumentManifest.content (Any)
patient	reference	The subject of the set of documents	DocumentManifest.subject.where(resolve() is Patient) (Patient)	33 Resources
recipient	reference	Intended to get notified about this set of documents	DocumentManifest.recipient (Practitioner, Organization, Patient, PractitionerRole, RelatedPerson)
related-id	token	Identifiers of things that are related	DocumentManifest.related.identifier
related-ref	reference	Related Resource	DocumentManifest.related.ref (Any)
source	uri	The source system/application/software	DocumentManifest.source
status	token	current \| superseded \| entered-in-error	DocumentManifest.status
subject	reference	The subject of the set of documents	DocumentManifest.subject (Practitioner, Group, Device, Patient)
type	token	Kind of document set	DocumentManifest.type	5 Resources

2.43 资源之 文档清单 - 简介

2.43.1 范围与用法

2.43.2 Resource Content

2.43.2.1 Terminology Bindings

2.43.3 Search Parameters

2.43 资源之文档清单 - 简介