DICOMweb PACS Source
Category: Healthcare Standards
Node id: dicomweb-connector
Query (QIDO-RS) and retrieve (WADO-RS) DICOM studies from a PACS. Read-only.
Input ports
| Name | Type | Required | Description |
|---|---|---|---|
records | json | No | Records to send when operation=write; ignored by read-only drivers |
service_params | json | No | Parameters for operation=service; merged over the service_params config, so a pipeline can page a sweep by feeding back a cursor |
Output ports
| Name | Type | Required | Description |
|---|---|---|---|
records | json | No | Records returned by the read operation; the record shape depends on the connector driver |
count | number | No | Number of records read (operation=read) |
cursor | string | No | Continuation cursor (operation=read) |
done | boolean | No | Whether reading has finished (operation=read); with paginate, true only when the source's last page was read |
pages | number | No | Pages read (operation=read with paginate) |
bytes | number | No | JSON-encoded size of the records returned (operation=read with paginate) |
truncated | boolean | No | A cap or a source defect stopped the walk before the last page (operation=read with paginate); the records are NOT the complete set |
truncated_reason | string | No | Why the walk stopped early: max_pages, max_items, max_page_bytes, timeout, cursor_repeated or no_cursor |
cursor_skip | number | No | Records at the start of the page cursor fetches that were already returned; skip them when resuming |
written | number | No | Number of records written (operation=write) |
errors | json | No | Per-record failures (operation=write); inspect before acknowledging completion |
service_id | string | No | Invoked service identifier (operation=service) |
result | json | No | Result of operation=service; the shape depends on the service (e.g. schema_explorer returns schemas, or a page with next_cursor when limit is set) |
Settings
Basic
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Connector | connector_id | connector-select | No | Use a saved connector for the connection + credentials. Leave empty to configure inline below. | ||
| Operation | operation | enum | Yes | read, write, service | read/write move records; service calls one of the driver's named services (e.g. schema_explorer, table_preview, sql_query). | |
| Service | service_id | string | No | Service to call when operation=service. This driver exposes no services. | ||
| Service Parameters | service_params | json | No | Parameters for the service, as JSON. May also be supplied on the service_params input port. |
Connection
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| api_key_name | api_key_name | string | No | Header name for the API key (auth_type = api_key) Ignored when connector_id is set. | ||
| api_key_value | api_key_value | secret | No | API key value (auth_type = api_key) Ignored when connector_id is set. | ||
| auth_type | auth_type | enum | No | none, bearer, basic, api_key | Authentication method Ignored when connector_id is set. | |
| base_url | base_url | string | Yes | DICOMweb base URL (e.g. https://orthanc.uclouvain.be/demo/dicom-web) Ignored when connector_id is set. | ||
| bearer_token | bearer_token | secret | No | Bearer token (auth_type = bearer) Ignored when connector_id is set. | ||
| ca_cert | ca_cert | string | No | Custom CA bundle (PEM content or file path) the server certificate must chain to, for private/self-signed TLS. Adds trust; verification stays on Ignored when connector_id is set. | ||
| last_sync_tracking | last_sync_tracking | boolean | No | Track a last-sync watermark (poller; Phase D) Ignored when connector_id is set. | ||
| password | password | secret | No | Password (auth_type = basic) Ignored when connector_id is set. | ||
| poll_interval_seconds | poll_interval_seconds | number | No | Poll interval seconds (poller; Phase D) Ignored when connector_id is set. | ||
| query_filters | query_filters | string | No | QIDO-RS query filters (e.g. {"limit":"10"}) Ignored when connector_id is set. | ||
| retrieve_mode | retrieve_mode | enum | No | full | full (bulkdata + pixels). Metadata-only retrieve is a future phase. Ignored when connector_id is set. | |
| timeout_seconds | timeout_seconds | number | No | Request timeout in seconds (default 120) Ignored when connector_id is set. | ||
| username | username | string | No | Username (auth_type = basic) Ignored when connector_id is set. | ||
| verify_tls | verify_tls | boolean | No | true | Verify the server's TLS certificate (default true) Ignored when connector_id is set. |
Advanced
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Read Operation | read_operation | string | No | |||
| Write Operation | write_operation | string | No | |||
| Allow Non-Read-Only Service | allow_write_service | boolean | No | false | Required to run a service the driver does not declare read-only. Off by default so a catalogue or discovery step cannot mutate a source system by misconfiguration. | |
| Page Size | limit | number | No | Records per page for operation=read, where the driver supports it (e.g. S3 list MaxKeys). | ||
| Cursor | cursor | string | No | Continuation cursor to start the read from (a previous run's cursor output). | ||
| Read All Pages | paginate | boolean | No | false | operation=read: follow the source's continuation cursor page after page until the last page, bounded by the caps below. Output truncated is true (with truncated_reason) when a cap stopped the walk first. | |
| Max Pages | max_pages | number | No | 100 | min 1; max 10000 | Hard cap on pages per run when paginate is on. |
| Max Items | max_items | number | No | 100000 | min 1; max 1000000 | Hard cap on records per run when paginate is on. |
| Max Page Bytes | max_page_bytes | number | No | 67108864 | min 1; max 268435456 | Hard cap on the JSON-encoded size of the records kept when paginate is on. Not the object-store max_bytes, which caps the size of a downloaded file. |
| Paging Timeout (s) | paging_timeout_seconds | number | No | 120 | min 1; max 3600 | Overall time budget for the walk; when it runs out the pages read so far are returned as truncated. Keep it below the node timeout. |
See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.
Etwas unklar? Senden Sie Feedback zur Dokumentation per E-Mail..