Jump to

• Request
• Response

Get a document reference by ID

get

/DocumentReference/{ID}

Retrieves an individual document by the associated ID.

Note:

• The read operation is supported for clinical-note, cardiology, radiology, microbiology, and pathology charted documents and clinical-note staged documents.
• Contents of the documents are found in the attachment URL. See the Binary resource information to determine what authorization scopes are required and how to set the Accept header when downloading document contents.

Authorization Types

This operation supports the following authorization types:

• Provider
• Patient
• System

Request

Path Parameters

• ID(required): string
  The logical resource ID.

Header Parameters

• Authorization(required): string

  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.

• accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.

Back to Top

Response

Supported Media Types

• application/json+fhir

Default Response

Note:

• Contents of the documents are found in the attachment URL.
• See the Binary resource information to determine what authorization scopes are required and how to set the Accept header when downloading document contents.

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/198381924

Example Response:

{
    "resourceType": 'DocumentReference',
    "id": '198381924',
    "meta": {
      "versionId": '1',
      "lastUpdated": '2022-07-07T09:43:56.000Z'
    },
    "text": {
      "status": 'generated',
      "div": '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: GETEST, PatientOneHundredSixtySix</p><p><b>Document Type</b>: Waveform Strip</p><p><b>Document Category</b>: Unknown</p><p><b>Document Title</b>: test1</p><p><b>Service Start Date</b>: Jul  7, 2022  9:43 A.M. UTC</p><p><b>Service End Date</b>: Jul  7, 2022  9:43 A.M. UTC</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: Model, User 154 Cerner</p></div>'
    },
    "identifier": [
      {
        "system": 'https://fhir.cerner.com/ceuuid',
        "value": 'CE87caf4b7-9397-4667-9897-702218017c9e-198381924-2022070709435600'
      }
    ],
    "status": 'current',
    "docStatus": 'final',
    "type": {
      "coding": [
        {
          "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
          "code": '2574499721',
          "display": 'Waveform Strip',
          "userSelected": true
        },
        {
          "system": 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor',
          "code": 'UNK',
          "display": 'unknown'
        }
      ],
      "text": 'Waveform Strip'
    },
    "category": [
      {
        "coding": [
          {
            "system": 'http://terminology.hl7.org/CodeSystem/data-absent-reason',
            "code": 'unknown',
            "display": 'Unknown'
          }
        ],
        "text": 'Unknown'
      }
    ],
    "subject": {
      "reference": 'Patient/12769853',
      "display": 'GETEST, PatientOneHundredSixtySix'
    },
    "date": '2022-07-07T09:43:56Z',
    "author": [
      {
        "reference": 'Practitioner/11638428',
        "display": 'Model, User 154 Cerner'
      }
    ],
    "authenticator": {
      "reference": 'Practitioner/11638428',
      "display": 'Model, User 154 Cerner'
    },
    "content": [
      {
        "attachment": {
          "contentType": 'application/pdf',
          "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-198381924',
          "title": 'test1',
          "creation": '2022-07-07T09:43:56.000Z'
        },
        "format": {
          "system": 'http://terminology.hl7.org/CodeSystem/data-absent-reason',
          "code": 'unknown',
          "display": 'Unknown'
        }
      }
    ],
    "context": {
      "encounter": [
        {
          "reference": 'Encounter/97966172'
        }
      ],
      "period": {
        "start": '2022-07-07T09:43:56.000Z',
        "end": '2022-07-07T09:43:56.000Z'
      }
    }
  }

Headers

• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-with-nil-status-request Response

Note:

• Contents of the documents are found in the attachment URL.
• See the Binary resource information to determine what authorization scopes are required and how to set the Accept header when downloading document contents.

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/206098371

Example Response:

{
    "resourceType": 'OperationOutcome',
    "issue": [
      {
        "severity": 'error',
        "code": 'not-found',
        "details": {
          "text": 'Resource not found'
        }
      }
    ]
  }

Headers

• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

Back to Top