Retrieve a patient's imaging data

You can use this API action to access a patient’s imaging and related metadata from a Picture Archiving and Communications System (PACS) server. Typically, you can use this for: 

  • accessing the original imaging for a patient (e.g., MRI, CT scan, X-ray);
  • finding the related metadata for a particular image (e.g., study date, study description, size, dimensions, modality); or
  • completing AI learning or processing. 

If you’re looking for a provider’s interpretation of imaging instead, retrieve a patient’s diagnostic results instead.

Supported systems

You can use this API action with the Redox FHIR® API.

Your connection's system can return results with their own FHIR® or query-based API.

Things you need to know

Action steps

Retrieve the storage location for a patient's imaging

You can search for the storage location, i.e., endpoint URL, for a patient’s imaging. Generally speaking, this is the translated FHIR® equivalent of QIDO-RS. Refer to the ImagingStudy resource schema for more details. 

Query Response
curl 'https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ImagingStudy/_search' \
--request POST \
--header 'Authorization: Bearer ${API_TOKEN}' \
--header 'redox-source-id: 6fbe85af-a83d-47f9-8330-18cb44d0557f,' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'patient=kyHGADnvX3xbkU4V9ayaqh' \
--data-urlencode 'started=2022-11-30T18:42:59.888Z' \
--data-urlencode 'modality=CT'
{
"type": "searchset",
"entry": [
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ImagingStudy?identifier=1.2.840.113619.2.243.6074146108103184.41976.4343.2084088",
"resource": {
"note": {
"text": "XR Wrist 3+ Views"
},
"series": [
{
"uid": "1.2.826.0.1.3680043.8.1055.1.20111103112244831.29109107.29203688",
"number": 10,
"started": "2015-01-14T13:30:00.000Z",
"bodySite": {
"code": "T-15460",
"system": "http://snomed.info/sct"
},
"endpoint": [
{
"reference": "#1.2.826.0.1.3680043.8.1055.1.20111103112244831.29109107.29203688"
}
],
"instance": [
{
"uid": "1.2.826.0.1.3680043.8.1055.1.20111103112244831.30826609.78057758",
"number": 1,
"sopClass": "1.2.840.10008.5.1.4.1.1.7"
}
],
"modality": {
"code": "OT",
"system": "http://dicom.nema.org/resources/ontology/DCM"
},
"performer": [
{
"actor": {
"type": "Practioner",
"display": "OCTAVIUS^OTTO",
"identifier": {
"value": "12345678902",
"system": "urn:oid:2.16.528.1.1007.3.1"
}
},
"function": {
"coding": [
{
"code": "PRF",
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType"
}
]
}
}
],
"laterality": {
"code": "419161000",
"system": "http://snomed.info/sct"
},
"description": "XR Wrist 3+ Views",
"numberOfInstances": 1
}
],
"status": "available",
"started": "2015-01-14T13:22:42.000Z",
"subject": {
"type": "Patient",
"display": "GREEN^KEVA",
"identifier": {
"value": "RJN7270450X"
}
},
"endpoint": [
{
"reference": "#1.2.840.113619.2.243.6074146108103184.41976.4343.2084088"
}
],
"modality": [
{
"coding": [
{
"code": "MR",
"system": "http://dicom.nema.org/resources/ontology/DCM"
}
]
}
],
"identifier": [
{
"use": "official",
"value": "urn:oid:1.2.840.113619.2.243.6074146108103184.41976.4343.2084088",
"system": "urn:dicom:uid"
}
],
"reasonCode": [
{
"text": "Closed fracture of trapezoidal bone of wrist",
"coding": [
{
"code": "357009",
"system": "http://snomed.info/sct",
"display": "Closed fracture of trapezoidal bone of wrist"
}
]
}
],
"description": "XR Wrist 3+ Views",
"resourceType": "ImagingStudy",
"procedureCode": [
{
"text": "XR Wrist 3+ Views",
"coding": [
{
"code": "RPID2589",
"system": "http://www.radlex.org",
"display": "XR Wrist 3+ Views"
}
]
}
],
"numberOfSeries": 1,
"numberOfInstances": 5
}
}
],
"contained": [
{
"id": "1.2.840.113619.2.243.6074146108103184.41976.4343.2084088",
"status": "active",
"address": "https://testapi.redoxengine.com/dicom-web/{{destination-slug}}/Production/studies/1.2.840.113619.2.243.6074146108103184.41976.4343.2084088",
"payloadType": [
{
"text": "DICOM WADO-RS"
}
],
"resourceType": "Endpoint",
"connectionType": {
"code": "dicom-wado-rs",
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type"
},
"payloadMimeType": [
"application/dicom"
]
},
{
"id": "1.2.826.0.1.3680043.8.1055.1.20111103112244831.29109107.29203688",
"status": "active",
"address": "https://testapi.redoxengine.com/dicom-web/{{destination-slug}}/Production/studies/1.2.840.113619.2.243.6074146108103184.41976.4343.2084088/series/1.2.826.0.1.3680043.8.1055.1.20111103112244831.29109107.29203688",
"payloadType": [
{
"text": "DICOM WADO-RS"
}
],
"resourceType": "Endpoint",
"connectionType": {
"code": "dicom-wado-rs",
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type"
},
"payloadMimeType": [
"application/dicom"
]
}
],
"timestamp": "2022-11-04T19:38:57.609Z",
"resourceType": "Bundle"
}

Retrieve a patient's imaging data

Once you have the endpoint URL for the image you’re looking for, you can query the endpoint directly for the given imaging. Generally speaking, this is the translated FHIR® equivalent of WADO-RS. Refer to the ImagingStudy resource schema for more details. 

Query Response
curl 'https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ImagingStudy/1.2.840.113619.2.243.6074146108103184.41976.4343.2084088' \
--request GET \
--header 'Authorization: Bearer ${API_TOKEN}'
{
"note": {
"text": "XR Wrist 3+ Views"
},
"series": [
{
"uid": "1.2.826.0.1.3680043.8.1055.1.20111103112244831.29109107.29203688",
"number": 10,
"started": "2015-01-14T13:30:00.000Z",
"bodySite": {
"code": "T-15460",
"system": "http://snomed.info/sct"
},
"endpoint": [
{
"reference": "#1.2.826.0.1.3680043.8.1055.1.20111103112244831.29109107.29203688"
}
],
"instance": [
{
"uid": "1.2.826.0.1.3680043.8.1055.1.20111103112244831.30826609.78057758",
"number": 1,
"sopClass": "1.2.840.10008.5.1.4.1.1.7"
}
],
"modality": {
"code": "OT",
"system": "http://dicom.nema.org/resources/ontology/DCM"
},
"performer": [
{
"actor": {
"type": "Practioner",
"display": "OCTAVIUS^OTTO",
"identifier": {
"value": "12345678902",
"system": "urn:oid:2.16.528.1.1007.3.1"
}
},
"function": {
"coding": [
{
"code": "PRF",
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType"
}
]
}
}
],
"laterality": {
"code": "419161000",
"system": "http://snomed.info/sct"
},
"description": "XR Wrist 3+ Views",
"numberOfInstances": 1
}
],
"status": "available",
"started": "2015-01-14T13:22:42.000Z",
"subject": {
"type": "Patient",
"display": "GREEN^KEVA",
"identifier": {
"value": "RJN7270450X"
}
},
"endpoint": [
{
"reference": "#1.2.840.113619.2.243.6074146108103184.41976.4343.2084088"
}
],
"modality": [
{
"coding": [
{
"code": "MR",
"system": "http://dicom.nema.org/resources/ontology/DCM"
}
]
}
],
"contained": [
{
"id": "1.2.840.113619.2.243.6074146108103184.41976.4343.2084088",
"status": "active",
"address": "https://testapi.redoxengine.com/dicom-web/tanner-test-13-dicom/Production/studies/1.2.840.113619.2.243.6074146108103184.41976.4343.2084088",
"payloadType": [
{
"text": "DICOM WADO-RS"
}
],
"resourceType": "Endpoint",
"connectionType": {
"code": "dicom-wado-rs",
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type"
},
"payloadMimeType": [
"application/dicom"
]
},
{
"id": "1.2.826.0.1.3680043.8.1055.1.20111103112244831.29109107.29203688",
"status": "active",
"address": "https://testapi.redoxengine.com/dicom-web/tanner-test-13-dicom/Production/studies/1.2.840.113619.2.243.6074146108103184.41976.4343.2084088/series/1.2.826.0.1.3680043.8.1055.1.20111103112244831.29109107.29203688",
"payloadType": [
{
"text": "DICOM WADO-RS"
}
],
"resourceType": "Endpoint",
"connectionType": {
"code": "dicom-wado-rs",
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type"
},
"payloadMimeType": [
"application/dicom"
]
}
],
"identifier": [
{
"use": "official",
"value": "urn:oid:1.2.840.113619.2.243.6074146108103184.41976.4343.2084088",
"system": "urn:dicom:uid"
}
],
"reasonCode": [
{
"text": "Closed fracture of trapezoidal bone of wrist",
"coding": [
{
"code": "357009",
"system": "http://snomed.info/sct",
"display": "Closed fracture of trapezoidal bone of wrist"
}
]
}
],
"description": "XR Wrist 3+ Views",
"resourceType": "ImagingStudy",
"procedureCode": [
{
"text": "XR Wrist 3+ Views",
"coding": [
{
"code": "RPID2589",
"system": "http://www.radlex.org",
"display": "XR Wrist 3+ Views"
}
]
}
],
"numberOfSeries": 1,
"numberOfInstances": 5
}