DocumentReference - FHIR Resource (dstu2)
This DocumentReference Resource uses the FHIR API standard for access and structure.
Validate an DocumentReference FHIR Resource (dstu2)
DocumentReference Attributes
AttributeField is listTypeDescription
Description: current | superseded | entered-in-error
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (DocumentReference) status FHIR attribute
Description: Who/what authenticated the document
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authenticator": Learn more about the (DocumentReference) authenticator FHIR attribute
Description: Human-readable description (title)
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (DocumentReference) description FHIR attribute
Description: "author" : [{ Reference(Practitioner|Organization|Device|Patient|
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": Learn more about the (DocumentReference) author FHIR attribute
Description: Organization which maintains the document
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"custodian": Learn more about the (DocumentReference) custodian FHIR attribute
Description: Master Version Specific Identifier
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"masterIdentifier": Learn more about the (DocumentReference) masterIdentifier FHIR attribute
Description: Relationships to other documents
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relatesTo": Learn more about the (DocumentReference) relatesTo FHIR attribute
Description: Document creation time
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"created": Learn more about the (DocumentReference) created FHIR attribute
Description: Document referenced
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"content": Learn more about the (DocumentReference) content FHIR attribute
Description: Clinical context of document
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": Learn more about the (DocumentReference) context FHIR attribute
Description: preliminary | final | appended | amended | entered-in-error
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"docStatus": Learn more about the (DocumentReference) docStatus FHIR attribute
Description: When this document reference created
FHIR Version: dstu2
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"indexed": Learn more about the (DocumentReference) indexed FHIR attribute
Description: Document security-tags
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"securityLabel": Learn more about the (DocumentReference) securityLabel FHIR attribute
Description: Other identifiers for the document
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (DocumentReference) identifier FHIR attribute
Description: Kind of document (LOINC if possible)
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (DocumentReference) type FHIR attribute
Description: Categorization of document
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"class": Learn more about the (DocumentReference) class FHIR attribute
Description: Who/what is the subject of the document
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": Learn more about the (DocumentReference) subject FHIR attribute
DocumentReference Structure
{
"resourceType" : "DocumentReference",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"masterIdentifier" : { Identifier }, // Master Version Specific Identifier
"identifier" : [{ Identifier }], // Other identifiers for the document
"subject" : { Reference(Patient|Practitioner|Group|Device) }, // Who/what is the subject of the document
"type" : { CodeableConcept }, // R! Kind of document (LOINC if possible)
"class" : { CodeableConcept }, // Categorization of document
"author" : [{ Reference(Practitioner|Organization|Device|Patient|
RelatedPerson) }], // Who and/or what authored the document
"custodian" : { Reference(Organization) }, // Organization which maintains the document
"authenticator" : { Reference(Practitioner|Organization) }, // Who/what authenticated the document
"created" : "<dateTime>", // Document creation time
"indexed" : "<instant>", // R! When this document reference created
"status" : "<code>", // R! current | superseded | entered-in-error
"docStatus" : { CodeableConcept }, // preliminary | final | appended | amended | entered-in-error
"relatesTo" : [{ // Relationships to other documents
"code" : "<code>", // R! replaces | transforms | signs | appends
"target" : { Reference(DocumentReference) } // R! Target of the relationship
}],
"description" : "<string>", // Human-readable description (title)
"securityLabel" : [{ CodeableConcept }], // Document security-tags
"content" : [{ // R! Document referenced
"attachment" : { Attachment }, // R! Where to access the document
"format" : [{ Coding }] // Format/content rules for the document
}],
"context" : { // Clinical context of document
"encounter" : { Reference(Encounter) }, // Context of the document content
"event" : [{ CodeableConcept }], // Main Clinical Acts Documented
"period" : { Period }, // Time of service that is being documented
"facilityType" : { CodeableConcept }, // Kind of facility where patient was seen
"practiceSetting" : { CodeableConcept }, // Additional details about where the content was created (e.g. clinical specialty)
"sourcePatientInfo" : { Reference(Patient) }, // Patient demographics from source
"related" : [{ // Related identifiers or resources
"identifier" : { Identifier }, // Identifier of related objects or events
"ref" : { Reference(Any) } // Related Resource
}]
}
}
DocumentReference Search Parameters
The following search parameters can be used to query DocumentReference resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/DocumentReference?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
authenticator | reference | authenticator |
author | reference | author |
class | text | class |
created | date | created |
custodian | reference | custodian |
description | text | description |
encounter | reference | context.encounter |
event | text | context.event |
facility | text | context.facilityType |
format | text | content.format |
identifier | text | masterIdentifier, DocumentReference.identifier |
indexed | date | indexed |
language | text | content.attachment.language |
location | uri | content.attachment.url |
patient | reference | subject |
period | date | context.period |
related-id | text | context.related.identifier |
related-ref | reference | context.related.ref |
relatesto | reference | relatesTo.target |
relation | text | relatesTo.code |
relationship | composite | |
securitylabel | text | securityLabel |
setting | text | context.practiceSetting |
status | text | status |
subject | reference | subject |
type | text | type |
