You can use this API action to access a patient’s imaging and related metadata from a Picture Archiving and Communications System (PACS) server.
If you’re looking for a provider’s interpretation of imaging, retrieve a patient’s diagnostic results instead.
This API action may be a good fit for your organization if you perform any of these use cases:
- Access the original imaging for a patient (e.g., MRI, CT scan, X-ray).
- Find related metadata for a particular image (e.g., study date, study description, size, dimensions, modality).
- Complete AI learning or processing.
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.
In case you need a refresher, an imaging study contains results for one patient.
There’s likely an order for a patient to complete a study. A study defines the type of imaging procedure to be performed, as well as the date, time, and location.
A study contains one or more series. A series represents each time the patient undergoes some kind of scan.
A series comprises one or more instances of the 3D image that’s captured. There are several instances to make up one 3D image.
To put it all together: Instances make up a series for a study being completed for an individual patient. Every time a patient undergoes imaging for a study, a new series is created.
The level of integration between a PACS server and an EHR system can vary widely. So, we recommend having a solid understanding of what data you need (e.g., provider interpretation, image, metadata). Then, work with your connection to understand where the data is stored or how you can access it.
Keep in mind that PACS servers may behave differently or use different message types from the DICOM standard. We recommend working with your connection to determine what message types to expect.
The message types your connection uses determine how your system interacts with a PACS server. You may need to get creative, but we may be able to abstract some of the complexity away for you by translating imaging data to FHIR®. First, define your needs and how to meet them with your connection. Then, talk with your Redox account manager to see how we can implement your unique use case.
Does this API action seem like a good fit for your unique workflow? If so, let your Redox account manager know! You can start development by downloading the relevant resource schema (noted in the related action step below) and deciding which data elements you need. Then, use our Redox Nexus Quickstart guide to dive right in.
If you're not engaged with our sales team yet, talk to a Redoxer to get started.
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.
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"}
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.
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}
FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.