Saltar al contenido principal

DICOMweb

Category: Healthcare Standards
Node id: dicomweb

Standards: HIPAA, GDPR, SOC2

Unified DICOMweb node: query studies (QIDO-RS), retrieve images/metadata (WADO-RS), and store instances (STOW-RS)

What it does​

  • QIDO-RS: search studies, series, instances by patient, date, modality, UIDs
  • WADO-RS: retrieve metadata, rendered images, or bulk DICOM data
  • STOW-RS: store single or batch DICOM instances
  • Bearer token or HTTP Basic authentication
  • Per-node CA certificate for PACS behind a private CA
  • Pagination support for queries
  • Streaming bulkdata retrieval (one instance in RAM at a time)

Use cases​

  • Search a PACS for imaging studies by patient or date range
  • Retrieve DICOM metadata for clinical data pipelines
  • Download rendered images for AI model inference
  • Store DICOM images in a cloud PACS
  • Migrate imaging studies between DICOMweb archives

Runtime​

  • Performance tier: variable

Input ports​

NameTypeRequiredDescription
patient_idtextNoPatient ID to search for (query)
patient_nametextNoPatient name to search for (query)
study_datetextNoStudy date filter YYYYMMDD (query)
modalitytextNoModality filter e.g. CT, MR, US (query)
accession_numbertextNoAccession number (query)
study_instance_uidtextNoStudy Instance UID (query/retrieve)
series_instance_uidtextNoSeries Instance UID (query/retrieve)
sop_instance_uidtextNoSOP Instance UID (retrieve)
dicom_dataanyNoDICOM instance data — bytes or string (store)
dicom_instancesjsonNoArray of DICOM instances for batch upload (store)

Output ports​

NameTypeRequiredDescription
resultjsonNoOperation result — shape varies by operation
metadatajsonNoResponse metadata (retrieve only)
successbooleanNoWhether the operation succeeded

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
DICOMweb URLdicomweb_urlstringYesBase URL of the DICOMweb server
OperationoperationenumYesquery, retrieve, storeDICOMweb operation to perform

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Auth Tokenauth_tokensecretNoBearer token for DICOMweb server authentication (not with username)
UsernameusernamestringNoHTTP Basic username for the DICOMweb server (not with auth_token)
PasswordpasswordsecretNoHTTP Basic password (with username)
CA Certificateca_certtextNoCA bundle (PEM content or file path) the server certificate must chain to, for a PACS behind a private/hospital CA. Adds trust; verification stays on

Query​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Query Levelquery_levelenumNostudiesstudies, series, instancesQIDO-RS query level (query)
LimitlimitnumberNo100min 1Maximum results to return (query)
OffsetoffsetnumberNo0min 0Results to skip for pagination (query)
Include Fieldsinclude_fieldsstringNoComma-separated DICOM tag names to include (query)

Retrieve​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Retrieve Typeretrieve_typeenumNometadatametadata, rendered, bulkdataWADO-RS retrieval mode (retrieve)
Retrieve Timeout (s)retrieve_timeout_secondsnumberNo300min 1HTTP timeout for a WADO-RS bulkdata study pull. Raise for large/slow PACS studies to avoid 'context deadline exceeded'.
Media Typemedia_typestringNoimage/pngRequested media type for rendered output
QualityqualitystringNo90Rendering quality 1-100 (retrieve rendered)
ViewportviewportstringNoViewport dimensions e.g. 512,512 (retrieve rendered)

Store​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Study Instance UIDstudy_instance_uidstringNoTarget Study UID for study-level STOW-RS (store)

Errors​

CodeDescription
DICOMWEB_URL_REQUIREDdicomweb_url configuration is missing
OPERATION_REQUIREDoperation must be query, retrieve, or store
STUDY_UID_REQUIREDstudy_instance_uid is required for retrieve
DICOM_DATA_REQUIREDdicom_data input is required for store
SERVER_ERRORDICOMweb server returned an HTTP 4xx/5xx error

Runtime notes​

  • query: result has results[], result_count, query_level, http_status
  • retrieve (metadata): result has dicom_metadata[], instance_count
  • retrieve (rendered): result has image_data, content_size
  • retrieve (bulkdata): result has instances[], instance_count, total_bytes, temp_dir
  • retrieve (bulkdata, multi-study): when the input carries a LIST of studies (upstream query result.studies/result.results array, a bare array of study objects, or multiple study_instance_uid values), ALL studies are retrieved and flattened into result.instances[] (each enriched with study_instance_uid; series_instance_uid is set only when the study was fetched series by series, absent on the whole-study fallback; sop_instance_uid is never set — treat both as optional). Also: result.study_count, result.studies_ok, result.errors[] (per-study {study_instance_uid, error} for tolerated failures). Single-study input keeps the original shape.
  • store: result has status, stored_instances[], instance_count, response, http_status

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

¿Algo no está claro? Envíe sus comentarios sobre la documentación por correo electrónico..