Skip to Content
Endpoints

Endpoints reference

Your Xenrad environment exposes separate HTTPS origins for FHIR R4, HL7 over HTTP, and MPPS. When your team publishes them, there are also TCP listeners for HL7 MLLP and DICOM C-STORE. This page is the map of those surfaces for this environment.

What you will usually receive from ops

Your administrator or this docs site should give you a FHIR base URL, an HL7 HTTP base URL, an MPPS base URL, an MLLP host and port, and a DICOM SCP host, port, and AE title. If any of those are blank below, that surface is not published yet. Do not invent hostnames from another tenant.

FHIR R4 baseResources under /fhir/… · metadata at /fhir/metadata
https://fhir.stg.xenrad.io/fhir
HL7 HTTPPOST /v2/ingest (v2.5.1), POST /v3/ingest (v3 XML)
https://hl7.stg.xenrad.io
MPPS HTTPPOST /ingest (JSON body, X-API-Key)
https://mpps.stg.xenrad.io
HL7 MLLP (TCP)Host and port for your interface engine (not HTTPS)
hl7.stg.xenrad.io:4420
DICOM C-STORE (SCP / DIMSE)Hostname and port for modalities; AE title is set per site in Xenrad
dicom.stg.xenrad.io:11112

HTTPS surfaces

Each integration has its own public base URL. Paths are relative to that base. Do not mix hosts.

FHIR R4 lives under /fhir/… on the FHIR host. Capability metadata is at /fhir/metadata. Interactive API docs, when enabled, sit at /api/documentation on the same host, with OpenAPI at /api/documentation/openapi.json.

HL7 over HTTP accepts POST /v2/ingest with a v2.5.1 pipe-delimited body, and POST /v3/ingest for v3 XML. Interactive docs live on the HL7 host the same way as FHIR.

MPPS accepts POST /ingest with a JSON body on the MPPS host. Interactive docs follow the same pattern.

Example requests

All three examples use a site API key and the hosts configured for this environment:

# FHIR capability
curl -sS \
  -H "X-API-Key: $XENRAD_API_KEY" \
  -H "Accept: application/fhir+json" \
  "https://fhir.stg.xenrad.io/fhir/metadata"

# HL7 v2 over HTTP
curl -sS -X POST \
  -H "X-API-Key: $XENRAD_API_KEY" \
  -H "Content-Type: text/plain" \
  --data-binary @message.hl7 \
  "https://hl7.stg.xenrad.io/v2/ingest"

# MPPS session
curl -sS -X POST \
  -H "X-API-Key: $XENRAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sop_instance_uid":"...","study_uid":"...","status":"COMPLETED"}' \
  "https://mpps.stg.xenrad.io/ingest"

HL7 MLLP (TCP)

MLLP is not HTTP. Your interface engine connects to a hostname and TCP port. There is no X-API-Key on the wire. Authorization is the integration client registration plus allowed source IPs, and optional MSH sender filters.

nc -zv "hl7.stg.xenrad.io" "4420"

DICOM C-STORE (DIMSE / SCP)

Modalities send studies to a hostname and TCP port. The AE title is configured per site inside Xenrad. Imaging does not travel over the FHIR or HL7 hosts. If studies never appear on the worklist, the SCP path is the first place to verify, not the API key screen.

Fleet-wide SCP host and port (not per-site) are published by Atlas at GET /connectivity/dimse on the Atlas HTTP origin: https://dicom.stg.xenrad.io/connectivity/dimse. The JSON response includes host, port, and optional ip. Horizon and Lite site pages read this endpoint for connect cards; your site's Called AE title still comes from Xenrad site settings.

nc -zv "dicom.stg.xenrad.io" "11112"

How to read this with the other chapters

API keys explains how to mint and rotate credentials. FHIR, HL7, and MPPS chapters explain the payload contracts. This page only answers which host and which path.

MPPS