Create Trigger

POST

/api/triggers

curl --request POST \
  --url https://example.com/api/triggers \
  --header 'Content-Type: application/json' \
  --data '{ "patient_id": "example", "kind": "exam", "modality": "CT", "date": "2026-04-15" }'

Request Body^required

Media typeapplication/json

TriggerCreate

object

patient_id

required

Patient Id

string

kind

required

Kind

string

Allowed values: exam mdt

modality

Any of:

string

string

Allowed values: CT MR PT

null

null

date

required

Date

string format: date

Responses

200

Successful Response

Media typeapplication/json

TriggerSummary

object

trigger

required

Trigger

object

id

required

Id

string

patient_id

required

Patient Id

string

kind

required

Kind

string

Allowed values: exam mdt

modality

required

Any of:

string

string

Allowed values: CT MR PT

null

null

body_part

Any of:

string

string

null

null

date

required

Date

string format: date

simulated

required

Simulated

boolean

patient

required

Patient

object

id

required

Id

string

sex

required

Sex

string

Allowed values: male female other unknown

birth_year

required

Any of:

integer

integer

null

null

age_band

Any of:

string

string

null

null

diagnoses

required

Diagnoses

Array<object>

Diagnosis

object

code

required

Code

string

display

required

Display

string

index_date

required

Any of:

string

string format: date

null

null

status_counts

required

StatusCounts

object

available

Available

integer

0

missing_report

Missing Report

integer

0

missing

Missing

integer

0

place_unknown

Place Unknown

integer

0

to_decide

required

To Decide

integer

open_requests

required

Open Requests

integer

duplicate

required

Duplicate

boolean

Example

{
  "trigger": {
    "kind": "exam",
    "modality": "CT"
  },
  "patient": {
    "sex": "male"
  },
  "status_counts": {
    "available": 0,
    "missing_report": 0,
    "missing": 0,
    "place_unknown": 0
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}