API Reference — PrizMed Imaging

Authentication

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer pm_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ

Base URL

https://finland.prizmed.com/api/v2

Imaging API

POST/api/v2/imaging/stream

Stream DICOM imaging data to the PrizMed processing pipeline. Supports real-time bi-directional streaming for large studies. Uses chunked transfer encoding for optimal throughput.

Headers

Name	Type	Description
`Authorization` REQUIRED	string	Bearer token
`Content-Type` REQUIRED	string	`application/dicom+stream` or `application/octet-stream`
`X-Request-Id`	string	Unique request identifier (UUID v4)
`X-Stream-Id`	string	Session identifier for multi-part streaming
`X-Chunk-Seq`	integer	Chunk sequence number (0-indexed)

Response

{
  "status": "accepted",
  "stream_id": "img_2fK9xL4mN7pQ",
  "bytes_received": 104857600,
  "processing_eta_ms": 2340
}

POST/api/v2/records/stream

Stream patient records and imaging history. Returns structured data in FHIR R4 format with embedded references to DICOM studies. Supports Server-Sent Events.

Headers

Name	Type	Description
`Authorization` REQUIRED	string	Bearer token
`X-Record-Id`	string	Unique record request identifier (UUID v4)
`X-Record-Stream`	string	Session identifier for persistent streaming

Request Body

{
  "patient_id": "MRN-00421",
  "type": "imaging_history",
  "format": "fhir_r4"
}

GET/api/v2/studies/{study_uid}

Retrieve metadata for a specific imaging study by its DICOM Study Instance UID.

GET/api/v2/studies/{study_uid}/series

List all series within a study. Returns modality, series description, number of instances.

DELETE/api/v2/studies/{study_uid}

Permanently delete a study and all associated data. Requires admin-level API key.

Rate Limits

Plan	Requests/min	Bandwidth	Max study
Developer	60	10 Mbps	500 MB
Professional	600	100 Mbps	4 GB
Enterprise	Unlimited	Unlimited	Unlimited

SDKs

Python

pip install prizmed

Node.js

npm install @prizmed/sdk

Java

com.prizmed:imaging-sdk:2.4.1