Skip to content
dicom-standard-kb documentation logodicom-standard-kb documentation

Query DICOMweb transactions and media types

The local knowledge base exposes structured DICOMweb and media-type facts. The project itself does not run a DICOMweb endpoint or general HTTP API.

Look up a transaction by name

Section titled “Look up a transaction by name”
Terminal window
EDITION=2025e  # Replace with your concrete edition.
uv run dicom-kb lookup dicomweb RetrieveStudy \
  --edition "$EDITION"

A resolved transaction can include:

  • transaction name;
  • resource category;
  • HTTP method;
  • route template;
  • request constraints;
  • response constraints;
  • status codes;
  • referenced media types;
  • official source references.

Look up a route

Section titled “Look up a route”

Pass a route template when that is the identifier available in your implementation review:

Terminal window
EDITION=2025e  # Replace with your concrete edition.
ROUTE_TEMPLATE='replace-with-route-template'
uv run dicom-kb lookup dicomweb "$ROUTE_TEMPLATE" \
  --edition "$EDITION"

Route matching is deterministic. When more than one transaction remains plausible, the resolver returns candidates instead of selecting by fuzzy similarity.

Look up a media type

Section titled “Look up a media type”
Terminal window
EDITION=2025e  # Replace with your concrete edition.
uv run dicom-kb lookup media-type application/dicom \
  --edition "$EDITION"

A media-type result can include:

  • the media type;
  • service context;
  • transfer-syntax constraints;
  • request or response directions;
  • source references.

Media rows can derive from parsed PS3.10 or PS3.18 contexts. Preserve the service context when the same media type appears in more than one workflow.

Follow references between results

Section titled “Follow references between results”

A useful sequence is:

  1. resolve the DICOMweb transaction;
  2. inspect media_type_refs;
  3. query each relevant media type;
  4. retain transaction and media references together;
  5. retrieve cited prose only for constraints that remain explanatory.

Use the result safely

Section titled “Use the result safely”

These tools summarize parsed standard structures. They do not:

  • validate a live HTTP request;
  • prove that an implementation is conformant;
  • perform content negotiation;
  • execute a DICOMweb transaction;
  • replace implementation-specific security or deployment requirements.

Agent-routing example

Section titled “Agent-routing example”
Resolve the transaction by exact name or route. For every referenced media
type, call dicom_lookup_media_type. Report candidates and warnings explicitly.
Do not claim that a server is conformant based only on the lookup.