Skip to main content

DocumentReference

Overview​

The DocumentReference resource provides a reference to a document of any kind for any purpose. This includes clinical documents, images, reports, and other content that supports patient care.

Resource Schema​

Key fields in the DocumentReference resource:

{
  "resourceType": "DocumentReference",
  "id": "example-docref-123",
  "status": "current",
  "type": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "34133-9",
        "display": "Summarization of episode note"
      }
    ]
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
          "code": "clinical-note",
          "display": "Clinical Note"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/123456"
  },
  "date": "2023-07-15T14:30:00Z",
  "author": [
    {
      "reference": "Practitioner/789"
    }
  ],
  "content": [
    {
      "attachment": {
        "contentType": "application/pdf",
        "url": "Binary/document-456"
      }
    }
  ]
}

Operations​

The DocumentReference resource supports Read and Search operations. Support varies by CareRecord solution.

CareRecord / SolutionReadSearch
GEHRIMED✅✅
myAvatar✅✅
myEvolv✅✅
myUnity✅✅
TheraOffice✅✅

Read​

HTTP Method: GET
URL: /DocumentReference/{id}

curl -X GET https://fhir.netsmartcloud.com/uscore/v1/DocumentReference/123456 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

HTTP Method: GET or POST
URL: /DocumentReference or /DocumentReference/_search

Search by Patient
curl -X POST https://fhir.netsmartcloud.com/uscore/v1/DocumentReference/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/123"

Integration Patterns​

Common Workflows​

  1. Document Retrieval - Access clinical documents and reports
  2. Document Management - Organize and categorize patient documents
  3. Content Integration - Link documents to clinical workflows

Relationships to Other Resources​

Error Handling​

For common errors and troubleshooting guidance, see Common Errors.

Supported Profiles​