MPPS integration
Modality Performed Procedure Step session ingest over HTTPS.
Xenrad accepts MPPS session updates over HTTPS so modalities and PACS bridges can report procedure-step state for a site. Authentication uses the same site-scoped Xenrad API key as FHIR and HL7 HTTP.
MPPS HTTP host — https://mpps.dev.xenrad.io (POST https://mpps.dev.xenrad.io/ingest with X-API-Key).
Request
- Method:
POST /ingeston the MPPS HTTP host. - Header:
X-API-Key: <api_key> - Body: JSON (
Content-Type: application/json)
| Field | Required | Description |
|---|---|---|
sop_instance_uid | Yes | SOP Instance UID for the MPPS object. |
study_uid | Yes | Study Instance UID the session belongs to. |
status | Yes | Procedure-step status (for example IN PROGRESS, COMPLETED). |
attributes | No | Additional attributes as a JSON object (default empty object). |
Do not send site_id in the body; the service resolves the site from the API key.
Example
curl -sS -X POST "https://mpps.dev.xenrad.io/ingest" \
-H "X-API-Key: YOUR_XENRAD_API_KEY" \
-H "Content-Type: application/json" \
-d '{"sop_instance_uid":"1.2.3.4.5","study_uid":"1.2.3.4.5.6","status":"IN PROGRESS"}'On success the service returns JSON with success: true and a session_id UUID. On validation or persistence failure you receive success: false and an error string.
Interactive reference
When enabled for your environment, open /api/documentation on the MPPS host (OpenAPI at /api/documentation/openapi.json).
Related
- API keys
- Endpoints reference
- FHIR — read patient and study context after ingest
- HL7 — demographics and clinical events on a separate host