1. REST APIs for Oracle Health Clinical Data Exchange
  2. Tasks
  3. DocumentReference

Get a list of document references

get

/fhir/r4/{query_endpoint_alias}/DocumentReference

This path retrieves documents using the patient ID, the source patient medical record number (MRN), and the specific encounter or visit number.

Use the following query parameters to retrieve the generated Consolidated Clinical Document Architecture (C-CDA) documents for a given patient within a specified date range:

  • Patient (required): cdex-patient-id
  • Date (conditional): The date range within which the encounter occurs.

Example: DocumentReference?patient=1979464&date=ge2023-11-04

Use the following query parameters to retrieve the generated C-CDA documents for a given patient identifier within a specified date range:

  • Patient identifier (required): The patient's MRN. The format includes the assigning authority and the value separated by a vertical bar (|). For example, aa|value.
  • Date (conditional): The date range within which the encounter occurs.

Example: DocumentReference?patient.identifier=891c71549f4a4bb439b4de8a532f155c_2.16.840.1.113883.3.995.10.1.1|8133&date=ge2023-01-01

Use the following query parameters to retrieve the generated C-CDA documents for a given patient encounter or account number:

  • Patient (required): The Oracle Health Clinical Data Exchange patient ID.
  • Encounter (conditional): The patient account number. The format includes the assigning authority and the value separated by a vertical bar (|). For example, aa|value.

Example: DocumentReference?patient={global-patient-id}&encounter={aa|fin}

Post-filter request parameters:

When responding to a request, the Oracle Health Clinical Data Exchange FHIR server first retrieves all results that match your primary search parameters above, then the server filters those results based on the additional post-filtered parameters that you have specified.

The post-filtering parameters are status, category, type, setting, facility, security-label, and format.

Note:

  • The DocumentReference does not retrieve existing C-CDA documents for a patient. Instead, it generates new C-CDA documents based on the current clinical content in the system. This functionality prevents communicating outdated data, and also ensures that the C-CDA content contains only data that the requesting payer is authorized to retrieve.
  • Separate C-CDAs are generated for each encounter context from the system in the DocumentReference response.

Request

Query Parameters

  • The DocumentEntry class code (the LOINC code, must be passed).
    - The format for this field requires both the code and system to be passed with the separator '^^'.
    - For example: category=34133-9^^2.16.840.1.113883.6.1

  • The date range within which the encounter occurs.
    Note:
    - The Time component is not supported.
    - Only the ge and le prefixes are supported.
    - This value can be provided in the following conditions:
      - Once with an appropriate prefix representing the earliest date.
      For example, date=ge2023-01-01.
      - Or, twice with appropriate prefixes to indicate a specific range.
      For example, date=ge2023-01-01&date=le2024-01-01.

  • The encounter context.
    The format includes the assigning authority and the value separated by a vertical bar (|).
    For example, aa|value.
    The assigning authority is required.

  • The DocumentEntry format code (that is, the format and content rules for the document).
    - The format for this field requires both the code and system to be passed with the separator '^^'.
    - For example: format=urn:hl7-org:sdwg:ccda-nonXMLBody:2.1^^1.3.6.1.4.1.19376.1.2.3

  • The patient that is the subject of the documents.
    - The patient is required if patient.identifier is not used.

  • The patient identifier that is the subject of the documents.
    - The patient identifier is required if patient is not used.
    - The patient's MRN is supported. The format includes the assigning authority and the value separated by a vertical bar (|).
    For example, aa|value.

  • The DocumentEntry confidentiality code (that is, the document security-tags).
    - The format for this field requires both the code and system to be passed with the separator '^^'.
    - For example: security-label=N^^2.16.840.1.113883.5.25

  • The DocumentEntry practice setting code (that is, additional details about where the content was created, for example, the clinical specialty).
    - The format for this field requires both the code and system to be passed with the separator '^^'.
    - For example: setting=394802001-9^^2.16.840.1.113883.6.96

  • The current and previous status in current status | superseded status format.

  • DocumentEntry type code (the LOINC code, must be passed).
    - The format for this field requires both the code and system to be passed with the separator '^^'.
    - For example: type=34133-9^^2.16.840.1.113883.6.1

Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Success
- The response would include all the documents reference matched.

Headers
Body ()
Root Schema : DocumentReference
Type: object
The DocumentReference FHIR resource.
Show Source
Example:
{
  "fullUrl": "https://cell1.query.stage.cdexhub.us-ashburn-1.oci.oraclecloud.com/fhir/r4/e48ebcb3-4027-5c58-ac57-e866afc7be0c/DocumentReference/urn:uuid:cca32c1d-8301-4ed7-ac8e-671cb11ff968",
  "resource": {
      "resourceType": "DocumentReference",
      "id": "urn:uuid:cca32c1d-8301-4ed7-ac8e-671cb11ff968",
      "masterIdentifier": {
          "system": "urn:ietf:rfc:3986",
          "value": "1.3.6.1.4.1.21367.2010.4381289"
      },
      "identifier": [
          {
              "use": "official",
              "system": "urn:ietf:rfc:3986",
              "value": "urn:uuid:cca32c1d-8301-4ed7-ac8e-671cb11ff968"
          }
      ],
      "status": "current",
      "docStatus": "final",
      "type": {
          "coding": [
              {
                  "system": "http://loinc.org",
                  "code": "34133-9",
                  "display": "Summary of Episode Note"
              }
          ]
      },
      "category": [
          {
              "coding": [
                  {
                      "system": "http://loinc.org",
                      "code": "34133-9",
                      "display": "Summary of Episode Note"
                  }
              ]
          }
      ],
      "subject": {
          "reference": "https://cell1.query.stage.cdexhub.us-ashburn-1.oci.oraclecloud.com/fhir/r4/e48ebcb3-4027-5c58-ac57-e866afc7be0c/Patient/2586450001",
          "display": "PEREZ JUAN"
      },
      "date": "2024-09-26",
      "author": [
          {
              "type": "Practitioner",
              "identifier": {
                  "use": "official",
                  "type": {
                      "coding": [
                          {
                              "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                              "code": "NPI",
                              "display": "National provider identifier"
                          }
                      ]
                  },
                  "system": "urn:ietf:rfc:3986",
                  "value": "Cerner HIE"
              },
              "display": "Cerner HIE"
          }
      ],
      "authenticator": {
          "type": "Practitioner",
          "identifier": {
              "use": "official",
              "type": {
                  "coding": [
                      {
                          "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                          "code": "NPI",
                          "display": "National provider identifier"
                      }
                  ]
              },
              "value": "Cerner HIE"
          },
          "display": "Cerner HIE"
      },
      "custodian": {
          "type": "Organization",
          "identifier": {
              "use": "official",
              "type": {
                  "coding": [
                      {
                          "system": "urn:ietf:rfc:3986",
                          "code": "urn:oid",
                          "display": "OID"
                      }
                  ]
              },
              "value": ""
          },
          "display": "Model Clinic 2"
      },
      "description": "CCD for Encounter: 18103-2.16.840.1.113883.3.995.10.2.1",
      "securityLabel": [
          {
              "coding": [
                  {
                      "system": "2.16.840.1.113883.5.25",
                      "code": "N",
                      "display": "Normal"
                  }
              ]
          }
      ],
      "content": [
          {
              "attachment": {
                  "contentType": "text/xml",
                  "language": "en-us",
                  "url": "https://cell1.query.stage.cdexhub.us-ashburn-1.oci.oraclecloud.com/fhir/r4/e48ebcb3-4027-5c58-ac57-e866afc7be0c/Binary/urn:uuid:cca32c1d-8301-4ed7-ac8e-671cb11ff968",
                  "size": 108842,
                  "hash": "f49999cd60913a68f8b89d7f431ee1ef24853b73",
                  "creation": "2024-09-26"
              },
              "format": {
                  "system": "1.3.6.1.4.1.19376.1.2.3",
                  "code": "urn:ihe:pcc:xphr:2007",
                  "display": "HL7 CCD Document"
              }
          }
      ],
      "context": {
          "encounter": [
              {
                  "identifier": {
                      "system": "891c71549f4a4bb439b4de8a532f155c_2.16.840.1.113883.3.995.10.2.1",
                      "value": "18103"
                  }
              }
          ],
          "period": {
              "end": "2024-05-13"
          },
          "practiceSetting": {
              "coding": [
                  {
                      "system": "2.16.840.1.113883.6.96",
                      "code": "394802001",
                      "display": "General Medicine"
                  }
              ]
          },
          "sourcePatientInfo": {
              "identifier": {
                  "system": "891c71549f4a4bb439b4de8a532f155c_2.16.840.1.113883.3.995.10.1.1",
                  "value": "8133"
              },
              "display": "PEREZ JUAN"
          }
      }
  }
}
Nested Schema : Reference
Match All
Show Source
Nested Schema : author
Type: array
The Practitioner who authored the document.
Show Source
Nested Schema : category
Type: array
The document category, displayed as Summary of Episode Note in the generated C-CDA documents. Preferred valueset https://hl7.org/fhir/R4/valueset-document-classcodes.html
Show Source
Nested Schema : content
Type: object
The document referenced.
Show Source
Nested Schema : context
Type: object
Show Source
Nested Schema : identifier
Type: array
Other identifiers for the document.
Show Source
Nested Schema : Identifier
Match All
Show Source
Nested Schema : securityLabel
Type: array
The security tag hard-coded as Normal is displayed on the generated C-CDA documents.
Show Source
Nested Schema : subject
Type: object
Show Source
Nested Schema : type
Type: array
The type of document, displayed as Summary of Episode Note in the generated C-CDA documents. Preferred valueset https://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html
Show Source
Nested Schema : Element
Type: object
Show Source
Nested Schema : Reference-allOf[1]
Type: object
Show Source
Nested Schema : extension
Type: array
Show Source
Nested Schema : Extension
Type: object
Show Source
Nested Schema : CodeableConcept
Match All
Show Source
Nested Schema : CodeableConcept-allOf[1]
Type: object
Show Source
Nested Schema : coding
Type: array
A reference to a code defined by a terminology system
Show Source
Nested Schema : Coding
Match All
Show Source
Nested Schema : Coding-allOf[1]
Type: object
Show Source
Nested Schema : attachment
Type: object
The location where you can access the document.
Show Source
Nested Schema : Period
Match All
Show Source
Nested Schema : Period-allOf[1]
Type: object
Show Source
Nested Schema : Identifier-allOf[1]
Type: object
Show Source

400 Response

Bad Request.

401 Response

Authorization information is missing or invalid.

403 Response

The user does not have sufficient access to perform this action.

500 Response

Internal Server error
Back to Top