Skip to main content
POST
Ingest a PACS study event

Authorizations

Authorization
string
header
required

Paste a Sanctum personal access token generated by a HMIS super administrator. Use only a token with the ability required by the selected operation.

Body

application/json
message_id
string
required
Maximum string length: 128
pacs_code
string
required
Maximum string length: 64
external_study_id
string
required
Maximum string length: 128
study_instance_uid
string
required
Maximum string length: 128
accession_number
string
required
Maximum string length: 32
received_at
string<date-time>
required
modality
string | null
Maximum string length: 32
study_date
string<date> | null
metadata
object | null

Response

Processed or duplicate study event.

status
enum<string>
Available options:
processed,
duplicate,
quarantined,
conflict
message_id
string
outcome
object | null
error
string | null