API Reference

RESTful API for medical imaging streaming and records management. Version 2.4.1

Authentication

All API requests require a Bearer token in the Authorization header. API keys are available in your dashboard.

Authorization: Bearer pm_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ

Base URL

https://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

NameTypeDescription
Authorization REQUIREDstringBearer token for authentication
Content-Type REQUIREDstringapplication/dicom+stream or application/octet-stream
X-Request-IdstringUnique request identifier (UUID v4). Auto-generated if omitted.
X-Stream-IdstringSession identifier for multi-part streaming. Required for resumable uploads.
X-Chunk-SeqintegerChunk sequence number for ordered reassembly (0-indexed).

Request Body

Binary DICOM data or multipart stream. Maximum 4 GB per request. For larger studies, use chunked streaming with X-Stream-Id and X-Chunk-Seq headers.

Response

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

Records API

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 real-time event streaming via Server-Sent Events.

Headers

NameTypeDescription
Authorization REQUIREDstringBearer token for authentication
X-Record-IdstringUnique record request identifier (UUID v4)
X-Record-StreamstringSession identifier for persistent record streaming
X-Record-SeqintegerSequence number for ordered record chunks

Request Body

{
  "patient_id": "MRN-00421",
  "type": "imaging_history",
  "date_range": {
    "from": "2024-01-01",
    "to": "2024-12-31"
  },
  "include_thumbnails": true,
  "format": "fhir_r4"
}

Response (SSE Stream)

event: record
data: {"study_uid":"1.2.840...","modality":"CT","date":"2024-03-15",...}

event: record
data: {"study_uid":"1.2.840...","modality":"MR","date":"2024-06-22",...}

event: done
data: {"total_records":47,"stream_duration_ms":890}
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, and storage location.

DELETE /api/v2/studies/{study_uid}

Permanently delete a study and all associated series/instances. This action is irreversible and triggers an audit log entry. Requires admin-level API key.

Rate Limits

PlanRequests/minStreaming bandwidthMax study size
Developer6010 Mbps500 MB
Professional600100 Mbps4 GB
EnterpriseUnlimitedUnlimitedUnlimited

SDKs & Libraries

Python

pip install prizmed

Node.js

npm install @prizmed/sdk

Java

com.prizmed:imaging-sdk:2.4.1