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
-
id(required): string
The logical resource ID.
Header Parameters
-
authorization(required): string
This string contains the credentials to authenticate a consumer to the service. This value should be the OAuth 2.0 bearer token.
Response
Supported Media Types
- application/fhir+json
200 Response
Success
Headers
-
X-Request-Id: string
Oracle troubleshooting identifier.
-
opc-request-id: string
Oracle troubleshooting identifier.
Root Schema : DocumentReference
Type:
objectThe DocumentReference FHIR resource.
Show Source
-
authenticator:
Reference
-
author:
array author
The practitioner who authored the document.
-
category:
array category
The document category, displayed as Summary of Episode Note in the generated C-CDA documents.
The preferred valueset is https://hl7.org/fhir/R4/valueset-document-classcodes.html.
-
content:
object content
The document referenced.
-
context:
object context
-
custodian:
Reference
-
date:
string(instant)
The data and time that this document was created.
-
description:
string
The description of the document.
-
docStatus:
string
preliminaryfinalamendedentered-in-error
-
id:
string
The logical ID of this artifact.
-
identifier:
array identifier
Other identifiers for the document.
-
masterIdentifier:
Identifier
-
resourceType:
string
The resource type is DocumentReference.
-
securityLabel:
array securityLabel
The security tag hard-coded as Normal is displayed on the generated C-CDA documents.
-
status:
string
currentsupersededentered-in-error
-
subject:
object subject
-
type:
array type
The type of document, displayed as Summary of Episode Note in the generated C-CDA documents.
The preferred valueset is https://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html.
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 : category
Type:
arrayThe document category, displayed as Summary of Episode Note in the generated C-CDA documents.
The preferred valueset is https://hl7.org/fhir/R4/valueset-document-classcodes.html.
Nested Schema : content
Type:
objectThe document referenced.
Show Source
-
attachment:
object attachment
The location where you can access the document.
-
format:
Coding
Nested Schema : securityLabel
Type:
arrayThe security tag hard-coded as Normal is displayed on the generated C-CDA documents.
Show Source
Nested Schema : subject
Type:
Show Source
object-
reference:
string
The reference to the Oracle Health Clinical Data Exchange patient ID.
Nested Schema : type
Type:
arrayThe type of document, displayed as Summary of Episode Note in the generated C-CDA documents.
The preferred valueset is https://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html.
Nested Schema : Element
Type:
Show Source
object-
extension:
array extension
-
id:
string
The unique ID for inter-element referencing.
Nested Schema : Reference-allOf[1]
Type:
Show Source
object-
display:
string
The text alternative for the resource.
-
identifier:
Identifier
-
reference:
string
The literal reference, relative, internal or absolute URL.
-
type:
string
The type the reference refers to (for example, Patient).
Nested Schema : Extension
Type:
Show Source
object-
url:
string
Minimum Length:
1Identifies the meaning of the extension. -
value:
string
Minimum Length:
1The value of the extension.
Nested Schema : CodeableConcept-allOf[1]
Type:
Show Source
object-
coding:
array coding
A reference to a code defined by a terminology system.
-
text:
string
The plain text representation of the concept.
Nested Schema : coding
Type:
arrayA reference to a code defined by a terminology system.
Show Source
Nested Schema : Coding-allOf[1]
Type:
Show Source
object-
code:
string
Minimum Length:
1The symbol in syntax defined by the system. -
display:
string
Minimum Length:
1The representation defined by the system. -
system:
string
Minimum Length:
1The identity of the terminology system. -
userSelected:
boolean
If this coding was chosen directly by the user.
-
version:
string
Minimum Length:
1The version of the system, if relevant.
Nested Schema : attachment
Type:
objectThe location where you can access the document.
Show Source
-
contentType:
string
The mime type of the content, including the character set and other information.
-
creation:
string(date-time)
The date that the attachment was initially created.
-
hash:
string
The hash of the data (for example, sha-1, base64ed).
-
language:
string
The human language of the content.
-
size:
number
The number of bytes of content (if the URL is provided).
-
title:
string
The label that is displayed in place of the data.
-
url:
string
The URI where the data is available.
Nested Schema : Period-allOf[1]
Type:
Show Source
object-
end:
string(date-time)
The end time with an inclusive boundary.
-
start:
string(date-time)
The starting time with an inclusive boundary.
Nested Schema : Identifier-allOf[1]
Type:
Show Source
object-
period:
Period
-
system:
string
The namespace for the identifier value (URI).
-
type:
CodeableConcept
-
use:
string
usualofficialtempsecondaryold(if known)
-
value:
string
The value that is unique.
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.