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

Get a document reference by ID

get

/fhir/r4/{query_endpoint_alias}/DocumentReference/{id}

This path retrieves an individual document using the document ID. This path retrieves the document ID from the cache in Oracle Health Clinical Data Exchange, rather than from the source electronic health record (EHR).

The document is cached for 24 hours, after which time you would be unable to retrieve the document. You would need to generate the document again from the DocumentReference Search resource.

Request

Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Success
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

401 Response

Authorization information is missing or invalid.

403 Response

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

404 Response

The requested resource was not found. This occurs when the resource is tried to retrieve after cached time (24 hours).

500 Response

Internal Server error
Back to Top