This resource contains metadata for any kind of document so that you can locate the document in a system. You can typically use this as a reference in another resource type that includes the subject, author, and context for a related document.
You may want to use this resource if (a) you want raw XML data or (b) you want you to pick what documents to view or retrieve. If you’re familiar with our Redox data models, this is the FHIR® representation of the ClinicalSummary.DocumentGet. Learn more about the DocumentGet event type. Or, if you only want to retrieve the patient’s latest CDA, check out the PatientQuery event type.
You can receive, retrieve, or save document references.
- _id
- identifier
- patient
cURL request example
Request Body Schema
- typeArray of string
Kind of document
- categoryArray of string
The categorization of the document. Pass
urn:redox:document_kind|CDA
to retrieve XML-formatted CDA documents. - patientArray of string
Who is the subject of the document
- patient.identifierArray of string
One or more external identifiers for the patient
- dateArray of string
The date/time this document reference was created
- encounter-identifierArray of string
Identifier for encounter associated with documents
- encounterArray of string
The encounter associated with the document reference.
- encounter.identifierArray of string
Identifier(s) by which this encounter is known
- identifierArray of string
A master version specific identifier for the document reference
- periodArray of string
The time of service that is being documented
- _elementsArray of string
A comma-separated list of DocumentReference field names to return. This is helpful in reducing the initial response size, especially for DocumentReferences resources where
content
can carry binary data.Redox recommends passing
subject,masterIdentifier,date,type,context
to retrieve meaningful fields while still omitting the content which can be retrieved via subsequent searches or GET operations.