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

NameRequiredTypeDescription
masterIdentifierIdentifier

Master Version Specific Identifier

Details

Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

CDA Document Id extension and root.

identifierIdentifier[]

Other identifiers for the document

Details

Other identifiers associated with the document, including version independent identifiers.

statuscode

current | superseded | entered-in-error

Details

The status of this document reference.

This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

docStatuscode

preliminary | final | amended | entered-in-error

Details

The status of the underlying document.

The document that is pointed to might be in various lifecycle states.

typeCodeableConcept

Kind of document (LOINC if possible)

Details

Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

categoryCodeableConcept[]

Categorization of document

Details

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

subjectReference< Patient | Practitioner | Group | Device >

Who/what is the subject of the document

Details

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

dateinstant

When this document reference was created

Details

When the document reference was created.

Referencing/indexing time is used for tracking, organizing versions and searching.

authorReference< Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson >[]

Who and/or what authored the document

Details

Identifies who is responsible for adding the information to the document.

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

authenticatorReference< Practitioner | PractitionerRole | Organization >

Who/what authenticated the document

Details

Which person or organization authenticates that this document is valid.

Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.

custodianReference<Organization>

Organization which maintains the document

Details

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.

relatesToDocumentReferenceRelatesTo[]

Relationships to other documents

Details

Relationships that this document has with other document references that already exist.

This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

codecode

replaces | transforms | signs | appends

Details

The type of relationship that this document has with anther document.

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

targetReference<DocumentReference>

Target of the relationship

Details

The target document of this relationship.

descriptionstring

Human-readable description

Details

Human-readable description of the source document.

What the document is about, a terse summary of the document.

securityLabelCodeableConcept[]

Document security-tags

Details

A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.

contentDocumentReferenceContent[]

Document referenced

Details

The document and format referenced. There may be multiple content element repetitions, each with a different format.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

attachmentAttachment

Where to access the document

Details

The document or URL of the document along with critical metadata to prove content has integrity.

formatCoding

Format/content rules for the document

Details

An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.

contextDocumentReferenceContext

Clinical context of document

Details

The clinical context in which the document was prepared.

These values are primarily added to help with searching for interesting/relevant documents.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

encounterReference<Encounter | EpisodeOfCare>[]

Context of the document content

Details

Describes the clinical encounter or type of care that the document content is associated with.

eventCodeableConcept[]

Main clinical acts documented

Details

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.

periodPeriod

Time of service that is being documented

Details

The time period over which the service that is described by the document was provided.

facilityTypeCodeableConcept

Kind of facility where patient was seen

Details

The kind of facility where the patient was seen.

practiceSettingCodeableConcept

Additional details about where the content was created (e.g. clinical specialty)

Details

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.

sourcePatientInfoReference<Patient>

Patient demographics from source

Details

The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

relatedReference<Resource>[]

Related identifiers or resources

Details

Related identifiers or resources associated with the DocumentReference.

May be identifiers or resources that caused the DocumentReference or referenced Document to be created.

Search Parameters

NameTypeDescriptionExpression
identifiertoken Master Version Specific Identifier DocumentReference.masterIdentifier
patientreference Who/what is the subject of the document DocumentReference.subject
typetoken Kind of document (LOINC if possible) DocumentReference.type
encounterreference Context of the document content DocumentReference.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

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

A set of rules under which this content was created

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.