DocumentReference
DocumentReference
draftResource52 elementsv5.0.0
A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this “document” encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.
Metadata
hl7.org/fhir- Canonical URL
- http://hl7.org/fhir/StructureDefinition/DocumentReference
- ID
- DocumentReference
- Type
- Base Definition
- Derivation
- specialization
- Publisher
- Health Level Seven International (Orders and Observations)
- Version
- 5.0.0
| Path | Card. | Type | Description |
|---|---|---|---|
DocumentReference | 0..* | A reference to a document | |
id | 0..1 | string | Logical id of this artifact |
meta | 0..1 | Metadata about the resource | |
implicitRules | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource contentrequired: all-languages |
text | 0..1 | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources |
extension | 0..* | Additional content defined by implementations | |
modifierExtension | 0..* | Extensions that cannot be ignored | |
identifier | 0..* | Business identifiers for the document | |
version | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference |
basedOn | 0..* | Procedure that caused this media to be created | |
status | 1..1 | code | current | superseded | entered-in-errorrequired: document-reference-status |
docStatus | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknownrequired: composition-status |
modality | 0..* | Imaging modality usedextensible: sect_CID_33.html | |
type | 0..1 | Kind of document (LOINC if possible)preferred: doc-typecodes | |
category | 0..* | Categorization of documentexample: referenced-item-category | |
subject | 0..1 | Who/what is the subject of the document | |
context | 0..* | Context of the document content | |
event | 0..* | Main clinical acts documentedexample: v3-ActCode | |
bodySite | 0..* | Body part includedexample: body-site | |
facilityType | 0..1 | Kind of facility where patient was seenexample: c80-facilitycodes | |
practiceSetting | 0..1 | Additional details about where the content was created (e.g. clinical specialty)example: c80-practice-codes | |
period | 0..1 | Time of service that is being documented | |
date | 0..1 | instant | When this document reference was created |
author | 0..* | Who and/or what authored the document | |
attester | 0..* | BackboneElement | Attests to accuracy of the document |
custodian | 0..1 | Organization which maintains the document | |
relatesTo | 0..* | BackboneElement | Relationships to other documents |
description | 0..1 | markdown | Human-readable description |
securityLabel | 0..* | Document security-tagsexample: security-label-examples | |
content | 1..* | BackboneElement | Document referenced |