Jump to

• Request
• Response

Get a list of document references with $docref

get

/DocumentReference/$docref

Argonaut operation for querying document references for the supplied parameters.

Terminology Bindings

• DocumentReference.type
• Description: The precise type of clinical document
• Details: LOINC
• System: http://loinc.org
• DocumentReference.content.format
• Description: The document format codes.
• Details: DocumentReference Format Code Set
• System: urn:oid:1.3.6.1.4.1.19376.1.2.3

Authorization Types

This operation supports the following authorization types:

• Provider
• Patient
• System

Request

Query Parameters

• end: string
  The end of the date range until which document reference records should be included.

  • Must be valid dateTime values with a time component.
  • Must have eq prefixes or nothing.
  • If start is not provided, then all previous records up to the end date are included.
  • If end is not provided, then all records between the start date and the current date are included.

  Example: end=2016-09-24T12:00:00.000Z
• patient(required): string
  A reference to the patient whose document references are required.
  Example: patient=12345
• start: string
  The start of the date range from which document reference records should be included.

  • Must be valid dateTime values with a time component.
  • Must have eq prefixes or nothing.
  • If start is not provided, then all previous records up to the end date are included.
  • If end is not provided, then all records between the start date and the current date are included.

  Example: start=2014-09-24T12:00:00.000Z
• type(required): string
  The document reference type.

  • Must include both a system and a code. Example: &type=http://loinc.org|34133-9.
  • May be a single system and code or a comma-separated list.

  Example: type=http://loinc.org|34133-9

Header Parameters

• Authorization(required): string
  Contains the credentials to authenticate a consumer to the service. The credentials 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

Example Request:

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/$docref?patient=13160351&type=http%3A%2F%2Floinc.org%7C34133-9

Example Response:

{
    'resourceType': 'Bundle',
    'id': '2cb9157f-0f05-4fe4-af14-95d5808a4070',
    'type': 'searchset',
    'link': [
      {
        'relation': 'self',
        'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/$docref?patient=13160351'
      }
    ],
    'entry': [
      {
        'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/b79484c9-1170-44cd-9910-f9013ff2ea1f',
        'resource': {
          'resourceType': 'DocumentReference',
          'id': 'b79484c9-1170-44cd-9910-f9013ff2ea1f',
          'status': 'current',
          'type': {
            'coding': [
              {
                'system': 'http://loinc.org',
                'code': '34133-9',
                'display': 'Summary of episode note'
              }
            ],
            'text': 'Summary of episode note'
          },
          'subject': {
            'reference': 'Patient/13160351'
          },
          'date': '2020-12-14T08:20:26Z',
          'content': [
            {
              'attachment': {
                'contentType': 'application/xml',
                'url': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/$autogen-ccd-if?patient=13160351'
              },
              'format': {
                'system': 'urn:oid:1.3.6.1.4.1.19376.1.2.3',
                'code': 'urn:hl7-org:sdwg:ccda-structuredBody:2.1',
                'display': 'For documents following C-CDA constraints using a structured body.'
              }
            }
          ]
        }
      }
    ]
  }

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