Skip to main content

DocumentReference

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.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
masterIdentifier0..1IdentifierMaster Version Specific Identifier
identifier0..*IdentifierOther identifiers for the document
status1..1codecurrent | superseded | entered-in-error
docStatus0..1codepreliminary | final | amended | entered-in-error
type0..1CodeableConceptKind of document (LOINC if possible)
category0..*CodeableConceptCategorization of document
subject0..1ReferenceWho/what is the subject of the document
date0..1instantWhen this document reference was created
author0..*ReferenceWho and/or what authored the document
authenticator0..1ReferenceWho/what authenticated the document
custodian0..1ReferenceOrganization which maintains the document
relatesTo0..*BackboneElementRelationships to other documents
description0..1stringHuman-readable description
securityLabel0..*CodeableConceptDocument security-tags
content1..*BackboneElementDocument referenced
context0..1BackboneElementClinical context of document

Search Parameters

NameTypeDescriptionExpression
identifiertokenMaster Version Specific IdentifierDocumentReference.masterIdentifier
patientreferenceWho/what is the subject of the documentDocumentReference.subject
typetokenKind of document (LOINC if possible)DocumentReference.type
encounterreferenceContext of the document contentDocumentReference.context.encounter
authenticatorreferenceWho/what authenticated the documentDocumentReference.authenticator
authorreferenceWho and/or what authored the documentDocumentReference.author
categorytokenCategorization of documentDocumentReference.category
contenttypetokenMime type of the content, with charset etc.DocumentReference.content.attachment.contentType
custodianreferenceOrganization which maintains the documentDocumentReference.custodian
datedateWhen this document reference was createdDocumentReference.date
descriptionstringHuman-readable descriptionDocumentReference.description
eventtokenMain clinical acts documentedDocumentReference.context.event
facilitytokenKind of facility where patient was seenDocumentReference.context.facilityType
formattokenFormat/content rules for the documentDocumentReference.content.format
languagetokenHuman language of the content (BCP-47)DocumentReference.content.attachment.language
locationuriUri where the data can be foundDocumentReference.content.attachment.url
perioddateTime of service that is being documentedDocumentReference.context.period
relatedreferenceRelated identifiers or resourcesDocumentReference.context.related
relatestoreferenceTarget of the relationshipDocumentReference.relatesTo.target
relationtokenreplaces | transforms | signs | appendsDocumentReference.relatesTo.code
security-labeltokenDocument security-tagsDocumentReference.securityLabel
settingtokenAdditional details about where the content was created (e.g. clinical specialty)DocumentReference.context.practiceSetting
statustokencurrent | superseded | entered-in-errorDocumentReference.status
subjectreferenceWho/what is the subject of the documentDocumentReference.subject
relationshipcompositeCombination of relation and relatesToDocumentReference.relatesTo