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.
The [patient|user|system]/DocumentReference.r authorization scope is required.
| Name | Description | DataType |
| ID | The ID for the DocumentReference Resource. | Token |
| Response Code | Description |
| 200 OK | The requested DocumentReference resource was found and is contained within the body of the HTTP response. |
| 400 Bad Request | The server could not understand the request due to invalid syntax. |
| 404 Not Found | The requested resource does not exist. |
| 500 Internal Server Error | The server has encountered a situation it doesn't know how to handle, resulting in an error. |
Example GET syntax of ResourceID 7d836647-0506-4f12-93ad-78b39e9bf44e:
This would return a Resource like the one below.
{
"resourceType": "DocumentReference",
"id": "7d836647-0506-4f12-93ad-78b39e9bf44e",
"identifier": [
{
"system": "https://localhost:44391/fhir/DocumentReference/",
"value": "7d836647-0506-4f12-93ad-78b39e9bf44e"
}
],
"status": "current",
"docStatus": "final",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34133-9",
"display": "Summary of Episode Note"
}
]
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
],
"text": "Clinical Note"
}
],
"subject": {
"reference": "Patient/66"
},
"date": "2022-11-23T13:03:41.013692-06:00",
"author": [
{
"reference": "https://localhost:44391/fhir/Practitioner/NP-0000000000"
}
],
"custodian": {
"reference": "Systemedx Inc.",
"type": "Organization"
},
"content": [
{
"attachment": {
"contentType": "application/xml",
"url": "Binary/16ee9531-9306-455e-af2d-5a95b603f7f2"
},
"format": {
"system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
"code": "urn:hl7-org:sdwg:ccda-structuredBody:2.1"
}
}
],
"context": {
"encounter": [
{
"extension": [
{
"url": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
],
"period": {
"start": "1900-01-01T00:00:00-06:00",
"end": "2099-12-31T00:00:00-06:00"
}
}
}
The [patient|user|system]/DocumentReference.rs authorization scope is required.
The following additional authorization scopes might be required depending on _revinclude search parameters used:
| Name | Description | DataType |
| PatientID | The ID of the patient the DocumentReference is for. | Reference |
| Category | The DocumentReference category. | Token |
| Date | The Date the DocumentReference was generated. | Date |
| Type | Kind of document (LOINC if possible) | Token |
Example SEARCH syntax of DocumentReference searches:
This would return a bundle containing one or more DocumentReferences Resources like the one above.