DocumentReference

ResourceFoundation · DocumentsTrial useMaturity 3

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

24 of 25 parameters tested

Structure

Show inherited elements (17)

Element	Card.	Type	Description
masterIdentifierΣ	0..1	Identifier	Master Version Specific Identifier
identifierΣ	0..*	Identifier	Other identifiers for the document
statusRequired?!Σ	1..1	code	current | superseded | entered-in-errorBinding (required): document-reference-status
docStatusΣ	0..1	code	preliminary | final | amended | entered-in-errorBinding (required): composition-status
typeΣ	0..1	CodeableConcept	Kind of document (LOINC if possible)Binding (preferred): c80-doc-typecodes
categoryΣ	0..*	CodeableConcept	Categorization of documentBinding (example): document-classcodes
subjectΣ	0..1	Reference(Patient | Practitioner | Group | Device)	Who/what is the subject of the document
dateΣ	0..1	instant	When this document reference was created
authorΣ	0..*	Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)	Who and/or what authored the document
authenticator	0..1	Reference(Practitioner | PractitionerRole | Organization)	Who/what authenticated the document
custodian	0..1	Reference(Organization)	Organization which maintains the document
relatesToΣ	0..*	BackboneElement	Relationships to other documents
codeRequiredΣ	1..1	code	replaces | transforms | signs | appendsBinding (required): document-relationship-type
targetRequiredΣ	1..1	Reference(DocumentReference)	Target of the relationship
descriptionΣ	0..1	string	Human-readable description
securityLabelΣ	0..*	CodeableConcept	Document security-tagsBinding (extensible): security-labels
contentRequiredΣ	1..*	BackboneElement	Document referenced
attachmentRequiredΣ	1..1	Attachment	Where to access the document
formatΣ	0..1	Coding	Format/content rules for the documentBinding (preferred): formatcodes
contextΣ	0..1	BackboneElement	Clinical context of document
encounter	0..*	Reference(Encounter | EpisodeOfCare)	Context of the document content
event	0..*	CodeableConcept	Main clinical acts documentedBinding (example): v3-ActCode
periodΣ	0..1	Period	Time of service that is being documented
facilityType	0..1	CodeableConcept	Kind of facility where patient was seenBinding (example): c80-facilitycodes
practiceSetting	0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty)Binding (example): c80-practice-codes
sourcePatientInfo	0..1	Reference(Patient)	Patient demographics from source
related	0..*	Reference(Resource)	Related identifiers or resources

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

Search parameters

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

Parameter	Type	Description	PG	ES
authenticator	reference	Who/what authenticated the document DocumentReference.authenticator
author	reference	Who and/or what authored the document DocumentReference.author
category	token	Categorization of document DocumentReference.category
contenttype	token	Mime type of the content, with charset etc. DocumentReference.content.attachment.contentType
custodian	reference	Organization which maintains the document DocumentReference.custodian
date	date	When this document reference was created DocumentReference.date
description	string	Human-readable description DocumentReference.description
encounter	reference	Context of the document content DocumentReference.context.encounter
event	token	Main clinical acts documented DocumentReference.context.event
facility	token	Kind of facility where patient was seen DocumentReference.context.facilityType
format	token	Format/content rules for the document DocumentReference.content.format
identifier	token	Master Version Specific Identifier DocumentReference.masterIdentifier | DocumentReference.identifier
language	token	Human language of the content (BCP-47) DocumentReference.content.attachment.language
location	uri	Uri where the data can be found DocumentReference.content.attachment.url
patient	reference	Who/what is the subject of the document DocumentReference.subject.where(resolve() is Patient)
period	date	Time of service that is being documented DocumentReference.context.period
related	reference	Related identifiers or resources DocumentReference.context.related
relatesto	reference	Target of the relationship DocumentReference.relatesTo.target
relation	token	replaces | transforms | signs | appends DocumentReference.relatesTo.code
relationship	composite	Combination of relation and relatesTo DocumentReference.relatesTo
security-label	token	Document security-tags DocumentReference.securityLabel
setting	token	Additional details about where the content was created (e.g. clinical specialty) DocumentReference.context.practiceSetting
status	token	current | superseded | entered-in-error DocumentReference.status
subject	reference	Who/what is the subject of the document DocumentReference.subject
type	token	Kind of document (LOINC if possible) DocumentReference.type

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

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition