Jump to

• Request
• Response

Get a document reference by ID

get

/DocumentReference/{ID}

Retrieves an individual document by the associated ID.

Authorization Types

This operation supports the following authorization types:

• Provider
• Patient
• System

Request

Path Parameters

• ID(required): string
  The logical resource ID associated with the resource.

Header Parameters

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

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

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/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/197286315

Example Response:

{
    'resourceType': 'DocumentReference',
    'id': '197286315',
    'meta': {
      'versionId': '197286314',
      'lastUpdated': '2020-04-05T04:00:46.000Z'
    },
    'text': {
      'status': 'generated',
      'div': '<div><p><b>Document Reference</b></p><p><b>Patient Name</b>: SMART, NANCY</p><p><b>Document Type</b>: Pregnancy Summary Document</p><p><b>Document Title</b>: Pregnancy Summary Document</p><p><b>Date</b>: Apr  5, 2020  4:00 A.M. UTC</p><p><b>Document Status</b>: Auth (Verified)</p></div>'
    },
    'subject': {
      'reference': 'Patient/12724066',
      'display': 'SMART, NANCY'
    },
    'type': {
      'coding': [
        {
          'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
          'code': '22520442',
          'display': 'Pregnancy Summary Document',
          'userSelected': true
        },
        {
          'system': 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor',
          'code': 'UNK',
          'display': 'unknown'
        }
      ],
      'text': 'Pregnancy Summary Document'
    },
    'created': '2020-04-05T04:00:45.000Z',
    'indexed': '2020-04-05T04:00:45.000Z',
    'status': 'current',
    'docStatus': {
      'coding': [
        {
          'system': 'http://hl7.org/fhir/composition-status',
          'code': 'final',
          'display': 'Final'
        }
      ],
      'text': 'Auth (Verified)'
    },
    'description': 'Pregnancy Summary Document',
    'content': [
      {
        'attachment': {
          'contentType': 'application/pdf',
          'url': 'https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-197286315',
          'title': 'Pregnancy Summary Document'
        }
      }
    ]
  }

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