DocumentManifest - FHIR Resource (r4)
This DocumentManifest Resource uses the FHIR API standard for access and structure.
Validate an DocumentManifest FHIR Resource (r4)
DocumentManifest Attributes
AttributeField is listTypeDescription
Description: Unique Identifier for the set of documents
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"masterIdentifier": {
"system": "http://example.org/documents",
"value": "23425234234-2346"
}Learn more about the (DocumentManifest) masterIdentifier FHIR attribute
Description: Other identifiers for the manifest
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://example.org/documents",
"value": "23425234234-2347"
}
]Learn more about the (DocumentManifest) identifier FHIR attribute
Description: current | superseded | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "current"Learn more about the (DocumentManifest) status FHIR attribute
Description: Kind of document set
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": {
"text": "History and Physical"
}Learn more about the (DocumentManifest) type FHIR attribute
Description: The subject of the set of documents
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/xcda"
}Learn more about the (DocumentManifest) subject FHIR attribute
Description: When this document manifest created
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"created": "2004-12-25T23:50:50-05:00"Learn more about the (DocumentManifest) created FHIR attribute
Description: "author" : [{ Reference(Practitioner|PractitionerRole|Organization|Device|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": [
{
"reference": "#a1"
}
]Learn more about the (DocumentManifest) author FHIR attribute
Description: "recipient" : [{ Reference(Patient|Practitioner|PractitionerRole|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recipient": [
{
"reference": "Practitioner/xcda1"
}
]Learn more about the (DocumentManifest) recipient FHIR attribute
Description: The source system/application/software
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"source": "urn:oid:1.3.6.1.4.1.21367.2009.1.2.1"Learn more about the (DocumentManifest) source FHIR attribute
Description: Human-readable description (title)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "Physical"Learn more about the (DocumentManifest) description FHIR attribute
Description: Items in manifest
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"content": [
{
"reference": "DocumentReference/example"
}
]Learn more about the (DocumentManifest) content FHIR attribute
Description: Related things
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"related": [
{
"identifier": {
"system": "http://example.org/documents",
"value": "23425234234-9999"
},
"ref": {
"reference": "DocumentReference/example"
}
}
]Learn more about the (DocumentManifest) related FHIR attribute
DocumentManifest Example
{
"resourceType": "DocumentManifest",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Text</div>"
},
"contained": [
{
"resourceType": "Practitioner",
"id": "a1",
"name": [
{
"family": "Dopplemeyer",
"given": [
"Sherry"
]
}
],
"telecom": [
{
"system": "email",
"value": "john.doe@healthcare.example.org"
}
]
}
],
"masterIdentifier": {
"system": "http://example.org/documents",
"value": "23425234234-2346"
},
"identifier": [
{
"system": "http://example.org/documents",
"value": "23425234234-2347"
}
],
"status": "current",
"type": {
"text": "History and Physical"
},
"subject": {
"reference": "Patient/xcda"
},
"created": "2004-12-25T23:50:50-05:00",
"author": [
{
"reference": "#a1"
}
],
"recipient": [
{
"reference": "Practitioner/xcda1"
}
],
"source": "urn:oid:1.3.6.1.4.1.21367.2009.1.2.1",
"description": "Physical",
"content": [
{
"reference": "DocumentReference/example"
}
],
"related": [
{
"identifier": {
"system": "http://example.org/documents",
"value": "23425234234-9999"
},
"ref": {
"reference": "DocumentReference/example"
}
}
]
}DocumentManifest Structure
{
"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
}]
}
DocumentManifest Search Parameters
The following search parameters can be used to query DocumentManifest resources. Just submit them like so:
https://api.1up.health/fhir/r4/DocumentManifest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
author | reference | author |
created | date | created |
description | text | description |
identifier | text | masterIdentifier |
item | reference | content |
patient | reference | subject.where |
recipient | reference | recipient |
related-id | text | related.identifier |
related-ref | reference | related.ref |
source | uri | source |
status | text | status |
subject | reference | subject |
type | text | type |
