Foundation
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
(v5.0.0-snapshot3:
R5
Snapshot
#3,
to
support
Connectathon
32
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
|
Work
Group
|
Maturity
Level
:
|
Trial
Use
|
Security Category : Not Classified |
Compartments
:
|
A
collection
of
documents
compiled
for
a
purpose
together
with
metadata
that
applies
to
any
the
collection.
Note to Balloters: DocumentManifest will be retired in R5 of FHIR as the functionality has been taken over by other resources such as List . Those that require DocumentManifest should look to other resources, or provide Change Requests justifying the need for DocumentManifest.
DocumentManifest resources was initially used in document indexing systems, such as IHE XDS
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
compartments
in
REST
and
HTTP.
This
use
is
not
limited
to
the
formal
"Document"
model
used
for
FHIR
documents
or
DocumentReference
resources.
A DocumentManifest resource could be used to bring clinical context grouping to a broader set of Resources.
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
|
||||
Raw
JSON
See
the
Extensions
for
this
resource
UML
Diagram
(
canonical
form
Legend
+
also
see
JSON
Format
Specification
)
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
Knowledge
Repository
Base
Capability
Statement
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(Device|Group|Patient|Practitioner) }, // The subject of the set of documents
"created" : "<dateTime>", // When this document manifest created
"author" : [{ Reference(Device|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }], // Who and/or what authored the DocumentManifest
"recipient" : [{ Reference(Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }], // 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
}]
}
Usage
note:
every
effort
has
been
made
Turtle
Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R4
| DocumentManifest |
|
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
ensure
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
|
|
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
| |
|
ref
| 0..1 | Reference ( Any ) |
Related
Resource
| |
|
Documentation
for
this
format
| ||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<DocumentManifest xmlns="http://hl7.org/fhir">
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(Device|Group|Patient|Practitioner) }, // The subject of the set of documents
"created" : "<dateTime>", // When this document manifest created
"author" : [{ Reference(Device|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }], // Who and/or what authored the DocumentManifest
"recipient" : [{ Reference(Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }], // 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/> .
Changes since Release 4
| DocumentManifest |
|
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 .)
Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| DocumentManifest.status | The status of the document reference. | Required | DocumentReferenceStatus |
| DocumentManifest.type |
A
code
specifying
the
particular
kind
of
Act
that
the
Act-instance
represents
within
its
class.
Constraints:
The
kind
of
Act
(e.g.
physical
examination,
serum
potassium,
inpatient
encounter,
charge
financial
transaction,
etc.)
is
specified
with
a
code
from
one
of
several,
typically
external,
coding
systems.
The
coding
system
will
depend
on
the
class
of
Act,
such
as
LOINC
for
observations,
etc.
Conceptually,
the
Act.code
must
be
a
specialization
of
the
Act.classCode.
This
is
why
the
structure
of
ActClass
domain
should
be
reflected
in
the
superstructure
of
the
ActCode
domain
and
| Example |
ActCode
|
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 | 6 Resources |
®©
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R5
Snapshot
3,
hl7.fhir.core#5.0.0-snapshot3
generated
on
Fri,
Nov
1,
2019
09:34+1100.
QA
Page
Wed,
Dec
14,
2022
07:16+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change