Skip to main content

DocumentManifest

ResourceFoundation · DocumentsTrial useMaturity 2

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

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
13 of 13 parameters tested

Structure​

ElementCard.TypeDescription
masterIdentifierΣ
0..1IdentifierUnique Identifier for the set of documents
identifierΣ
0..*IdentifierOther identifiers for the manifest
statusRequired?!Σ
1..1codecurrent | superseded | entered-in-errorBinding (required): document-reference-status
typeΣ
0..1CodeableConceptKind of document setBinding (example): v3-ActCode
subjectΣ
0..1Reference(Patient | Practitioner | Group | Device)The subject of the set of documents
created
0..1dateTimeWhen 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..1uriThe source system/application/software
descriptionΣ
0..1stringHuman-readable description (title)
contentRequiredΣ
1..*Reference(Resource)Items in manifest
related
0..*BackboneElementRelated things
identifier
0..1IdentifierIdentifiers of things that are related
ref
0..1Reference(Resource)Related Resource

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/DocumentManifest?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ParameterTypeDescriptionPGES
authorreference

Who and/or what authored the DocumentManifest

DocumentManifest.author
createddate

When this document manifest created

DocumentManifest.created
descriptionstring

Human-readable description (title)

DocumentManifest.description
identifiertoken

Unique Identifier for the set of documents

DocumentManifest.masterIdentifier | DocumentManifest.identifier
itemreference

Items in manifest

DocumentManifest.content
patientreference

The subject of the set of documents

DocumentManifest.subject.where(resolve() is Patient)
recipientreference

Intended to get notified about this set of documents

DocumentManifest.recipient
sourceuri

The source system/application/software

DocumentManifest.source
statustoken

current | superseded | entered-in-error

DocumentManifest.status
subjectreference

The subject of the set of documents

DocumentManifest.subject
typetoken

Kind of document set

DocumentManifest.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition