Jump to

• Request
• Response

Get a list of document references

get

/DocumentReference

Retrieves a list of documents that meet supplied query parameters.

Note:

• The search 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

Query Parameters

• _count: string
  The maximum number of results to return. Defaults to 10 and a maximum of 100 documents can be returned.
• _id(required): string
  The logical resource ID associated with the resource.

  • This parameter is required if the patient parameter is not used.
  • Must not be provided with any other parameters except _revinclude parameter as noted below.

  Example: 12345
• _lastUpdated: string
  The date range in which the document was last updated.

  • This parameter only qualifies clinically significant updates. For example, changes to the value or code, and other significant fields. Minor updates, such as nonclinically relevant note updates, do not qualify.
  • This parameter may be provided up to two times, and must use the eq, ge, gt, le, or lt prefixes.
  • When a value is provided without a prefix, an implied eq prefix is used.
  • When provided twice, the lower value must have a ge or gt prefix and the higher value must have an le or lt prefix.
  • The _lastUpdated parameter may not be provided at the same time as either of the date or period parameters. You may only use one of the three at a time.

  Example: _lastUpdated=gt2014-09-24 or _lastUpdated=gt2014-09-24T12:00:00.000Z
• _revinclude: string
  The Provenance resource entries to be returned as part of the bundle.

  • May be provided once with the Provenance:target value. Example: _revinclude=Provenance:target.
  • May be provided with the _id or patient parameter. Example: _id=214938095&_revinclude=Provenance:target.
  • When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding with the authorization type, such as user/Provenance.read, patient/Provenance.read, or system/Provenance.read.

  Example: _revinclude=Provenance:target
• category: string
  The categorization of the document.
  Example:

  http://loinc.org|11488-4

• date: string
  When this document reference was created.

  • For a single date occurrence:
  • May be provided with a prefix to imply a date range or without a prefix to search for documents last updated at a specific date and time.
  • The time component is optional.
  • For two date occurences:
  • Must be provided with le or lt and ge or gt prefixes to search for documents within a specific range.
  • The time component is required for both parameters.
  • The date parameter may not be provided at the same time as either of the period or _lastUpdated parameters. You may only use one of the three at a time.

  Example: date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z
• encounter: string
  The encounters in which the document was created.

  • Patient-level documents are filtered out from responses when the encounter ID is blank.
  • May be provided with a single reference or a comma-separated list of references. Example: encounter=1234 or encounter=1234,5678.

  Example: 12345
• patient(required): string
  The specific patient to return documents for. This parameter is required if the _id parameter is not used.
  Example: 12345
• period: string
  The time of service that is being documented.

  • Must be provided twice, once with the ge prefix, and once with the lt prefix.
  • Date precision must be consistent.
  • The period parameter may not be provided at the same time as either of the date or _lastUpdated parameters. You may only use one of the three at a time.

  Example: period=ge2017-01-01&period=lt2017-01-05
• type: string
  The type of document. May be a list separated by commas.
  Example:

  http://loinc.org|11488-4

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?patient=12769853

Example Response:

{
    'resourceType': 'Bundle',
    'id': '271fc608-6a12-48f3-a9f8-2d1bfe395328',
    'type': 'searchset',
    'link': [
      {
        'relation': 'self',
        'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?patient=12769853'
      }
    ],
    'entry': [
      {
        'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/198381924',
        'resource': {
          "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'
            }
          }
        }
      },
      {
        'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/198381926',
        'resource': {
          "resourceType": 'DocumentReference',
          "id": '198381926',
          "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></div>'
          },
          "identifier": [
            {
              "system": 'https://fhir.cerner.com/ceuuid',
              "value": 'CE87caf4b7-9397-4667-9897-702218017c9e-198381926-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',
          "content": [
            {
              "attachment": {
                "contentType": 'application/pdf',
                "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-198381926',
                "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'
            }
          }
        }
      },
      {
        'resourceType': 'DocumentReference',
        'id': '201318478',
        'meta': {
          'versionId': '1',
          'lastUpdated': '2022-12-08T08: 26: 36.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>: Admission Note Physician</p><p><b>Service Start Date</b>: Dec  7, 2022  6:51 A.M. UTC</p><p><b>Service End Date</b>: Dec  7, 2022  6:51 A.M. UTC</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: SYSTEM, SYSTEM Cerner</p></div>'
        },
        'identifier': [
          {
            'system': 'https: //fhir.cerner.com/ceuuid',
            'value': 'CE87caf4b7-9397-4667-9897-702218017c9e-201318478-2022120808263700'
          }
        ],
        'status': 'current',
        'docStatus': 'final',
        'type': {
          'coding': [
            {
              'system': 'https: //fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
              'code': '2820507',
              'display': 'Admission Note Physician',
              'userSelected': true
            },
            {
              'system': 'http: //loinc.org',
              'code': '83805-2',
              'display': 'Physician Admission evaluation note',
              'userSelected': false
            }
          ],
          'text': 'Admission Note Physician'
        },
        'category': [
          {
            'coding': [
              {
                'system': 'http://loinc.org',
                'code': 'LP29684-5',
                'display': 'Radiology',
                'userSelected': false
              }
            ],
            'text': 'Radiology'
          },
          {
            'coding': [
              {
                'system': 'http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category',
                'code': 'clinical-note',
                'display': 'Clinical Note',
                'userSelected': false
              }
            ],
            'text': 'Clinical Note'
          }
        ],
        'subject': {
          'reference': 'Patient/12769853',
          'display': 'GETEST, PatientOneHundredSixtySix'
        },
        'date': '2022-12-08T08: 26: 36Z',
        'author': [
          {
            'reference': 'Practitioner/1',
            'display': 'SYSTEM, SYSTEM Cerner'
          }
        ],
        'authenticator': {
          'reference': 'Practitioner/1',
          'display': 'SYSTEM, SYSTEM Cerner'
        },
        'content': [
          {
            'attachment': {
              'contentType': 'application/xhtml+xml',
              'url': 'https: //fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/R-201318478',
              'creation': '2022-12-07T06: 51: 22.000Z'
            },
            'format': {
              'system': 'http: //ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem',
              'code': 'urn:ihe:iti:xds: 2017:mimeTypeSufficient',
              'display': 'mimeType Sufficient'
            }
          },
          {
            'attachment': {
              'contentType': 'application/xml',
              'url': 'https: //fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XML-201318478',
              'creation': '2022-12-07T06: 51: 22.000Z'
            },
            'format': {
              'system': 'http: //ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem',
              'code': 'urn:ihe:iti:xds: 2017:mimeTypeSufficient',
              'display': 'mimeType Sufficient'
            }
          }
        ],
        'context': {
          'period': {
            'start': '2022-12-07T06: 51: 22Z',
            'end': '2022-12-07T06: 51: 22Z'
          },
          'related': [
            {
              'reference': 'DiagnosticReport/201318478'
            }
          ]
        }
      }
    ]
  }

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-_revinclude 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-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?_id=198449751&_revinclude=Provenance:target

Example Response:

{
    "resourceType": 'Bundle',
    "id": 'e6af8dd8-78e2-4e9e-b04c-760b76128426',
    "type": 'searchset',
    "link": [
      {
        "relation": 'self',
        "url": 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?_id=198449751&_revinclude=Provenance%3Atarget'
      }
    ],
    "entry": [
      {
        "fullUrl": 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/198449751',
        "resource": {
          "resourceType": 'DocumentReference',
          "id": '198449751',
          "meta": {
            "versionId": '1',
            "lastUpdated": '2022-07-15T07:45:48.000Z'
          },
          "text": {
            "status": 'generated',
            "div": '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: SMART, WILMA</p><p><b>Document Type</b>: Height Weight Allergy Rule - Text</p><p><b>Document Category</b>: Unknown</p><p><b>Document Title</b>: Clinical Note</p><p><b>Service Start Date</b>: Jul 15, 2022  1:15 P.M. UTC</p><p><b>Service End Date</b>: Jul 15, 2022  1:15 P.M. UTC</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: Allen, Jodi</p></div>'
          },
          "identifier": [
            {
              "system": 'https://fhir.cerner.com/ceuuid',
              "value": 'CE87caf4b7-9397-4667-9897-702218017c9e-198449751-2022071507454800'
            }
          ],
          "status": 'current',
          "docStatus": 'final',
          "type": {
            "coding": [
              {
                "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
                "code": '20732501',
                "display": 'Height Weight Allergy Rule - Text',
                "userSelected": true
              },
              {
                "system": 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor',
                "code": 'UNK',
                "display": 'unknown'
              }
            ],
            "text": 'Height Weight Allergy Rule - Text'
          },
          "category": [
            {
              "coding": [
                {
                  "system": 'http://terminology.hl7.org/CodeSystem/data-absent-reason',
                  "code": 'unknown',
                  "display": 'Unknown'
                }
              ],
              "text": 'Unknown'
            }
          ],
          "subject": {
            "reference": 'Patient/12724065',
            "display": 'SMART, WILMA'
          },
          "date": '2022-07-15T07:45:48Z',
          "author": [
            {
              "reference": 'Practitioner/12743472',
              "display": 'Allen, Jodi'
            }
          ],
          "authenticator": {
            "reference": 'Practitioner/12743472',
            "display": 'Allen, Jodi'
          },
          "content": [
            {
              "attachment": {
                "contentType": 'text/plain',
                "url": 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/R-198449751',
                "title": 'Clinical Note',
                "creation": '2022-07-15T13:15:46.000Z'
              },
              "format": {
                "system": 'http://terminology.hl7.org/CodeSystem/data-absent-reason',
                "code": 'unknown',
                "display": 'Unknown'
              }
            }
          ],
          "context": {
            "encounter": [
              {
                "reference": 'Encounter/97953483'
              }
            ],
            "period": {
              "start": '2022-07-15T13:15:46.000Z',
              "end": '2022-07-15T13:15:46.000Z'
            }
          }
        },
        "search": {
          "mode": 'match'
        }
      },
      {
        "fullUrl": 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/INT.doc-198449751',
        "resource": {
          "resourceType": 'Provenance',
          "id": 'INT.doc-198449751',
          "meta": {
            "versionId": '198449751',
            "lastUpdated": '2022-07-15T07:45:48Z'
          },
          "text": {
            "status": 'generated',
            "div": '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>DocumentReference/198449751</li></ul><p><b>Recorded</b>: Jul 15, 2022  7:45 A.M. UTC</p><p><b>Agents</b>:</p><dl><dt>Allen, Jodi</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd><dt>Model Cancer Center</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl></div>'
          },
          "target": [
            {
              "reference": 'DocumentReference/198449751'
            }
          ],
          "recorded": '2022-07-15T07:45:48Z',
          "agent": [
            {
              "type": {
                "coding": [
                  {
                    "system": 'http://terminology.hl7.org/CodeSystem/provenance-participant-type',
                    "code": 'author'
                  }
                ],
                "text": 'Author'
              },
              "role": [
                {
                  "coding": [
                    {
                      "system": 'http://terminology.hl7.org/CodeSystem/contractsignertypecodes',
                      "code": 'SOURCE'
                    }
                  ],
                  "text": 'Source'
                }
              ],
              "who": {
                "reference": 'Practitioner/12743472',
                "display": 'Allen, Jodi'
              }
            },
            {
              "type": {
                "coding": [
                  {
                    "system": 'http://terminology.hl7.org/CodeSystem/provenance-participant-type',
                    "code": 'author'
                  }
                ],
                "text": 'Author'
              },
              "role": [
                {
                  "coding": [
                    {
                      "system": 'http://terminology.hl7.org/CodeSystem/contractsignertypecodes',
                      "code": 'SOURCE'
                    }
                  ],
                  "text": 'Source'
                }
              ],
              "who": {
                "reference": 'Organization/1024451',
                "display": 'Model Cancer Center'
              }
            }
          ]
        },
        "search": {
          "mode": 'include'
        }
      }
    ]
  }

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-encounter-filtering 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-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?patient=12769853&encounter=97966172

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>: M., 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'
        },
        {
          "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": 'M., User 154 Cerner'
      }
    ],
    "authenticator": {
      "reference": 'Practitioner/11638428',
      "display": 'M., User 154 Cerner'
    },
    "content": [
      {
        "attachment": {
          "contentType": 'application/pdf',
          "url": 'https://fhir-ehr.devcerner.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?patient=12769853

Example Response:

{
    "resourceType": 'Bundle',
    "id": '271fc608-6a12-48f3-a9f8-2d1bfe395328',
    "type": 'searchset',
    "link": [
      {
        "relation": 'self',
        "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?patient=12769853'
      }
    ],
    "entry": [
      {
        "fullUrl": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/198381924',
        "resource": {
          "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'
            }
          }
        }
      },
      {
        "fullUrl": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/198381926',
        "resource": {
          "resourceType": 'DocumentReference',
          "id": '198381926',
          "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></div>'
          },
          "identifier": [
            {
              "system": 'https://fhir.cerner.com/ceuuid',
              "value": 'CE87caf4b7-9397-4667-9897-702218017c9e-198381926-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',
          "content": [
            {
              "attachment": {
                "contentType": 'application/pdf',
                "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-198381926',
                "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'
            }
          }
        }
      },
      {
        "fullUrl": 'urn:uuid:98ae7843-46b7-4792-8613-a0b9cf196b27',
        "resource": {
          "resourceType": 'OperationOutcome',
          "issue": [
            {
              "severity": 'warning',
              "code": 'suppressed',
              "diagnostics": 'Other search results were found but could not be compliantly expressed and hence have been suppressed'
            }
          ]
        },
        "search": {
          "mode": 'outcome'
        }
      }
    ]
  }

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