Add Candidate

POST

/api/triggers/{trigger_id}/candidates

curl --request POST \
  --url https://example.com/api/triggers/example/candidates \
  --header 'Content-Type: application/json' \
  --data '{ "modality": "example", "date": "example", "description": "example", "place": "example", "organization_id": "example" }'

Parameters

Path Parameters

trigger_id

required

Trigger Id

string

Request Body^required

Media typeapplication/json

CandidateCreate

object

modality

required

Modality

string

date

Any of:

string

string

null

null

description

required

Description

string

place

Any of:

string

string

null

null

organization_id

Any of:

string

string

null

null

Example ^generated

{
  "modality": "example",
  "date": "example",
  "description": "example",
  "place": "example",
  "organization_id": "example"
}

Responses

200

Successful Response

Media typeapplication/json

Case

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

candidates

required

Candidates

Array<object>

Candidate

object

id

required

Id

string

source

required

Source

string

Allowed values: nis_record report_text insurer collector

modality

required

Modality

string

date

required

Any of:

string

string

null

null

description

required

Description

string

place

required

Any of:

string

string

null

null

organization_id

required

Any of:

string

string

null

null

study_id

required

Any of:

string

string

null

null

report_id

required

Any of:

string

string

null

null

status

required

Status

string

Allowed values: available missing_report missing place_unknown

is_baseline

required

Is Baseline

boolean

verdict

required

Verdict

object

label

required

Label

string

Allowed values: relevant not_relevant uncertain

reason

required

Reason

string

source_sentence

Any of:

string

string

null

null

guideline

Any of:

GuidelineCitation

GuidelineCitation

object

page

required

Page

1-based PDF page of Modrá kniha ČOS (26th edition).

integer

quote

required

Quote

string

null

null

kroky

Kroky

Array<string>

default:

decision

required

Any of:

string

string

Allowed values: relevant not_relevant removed

null

null

decision_reason

required

Any of:

string

string

null

null

request_id

required

Any of:

string

string

null

null

request_state

required

Any of:

string

string

Allowed values: draft sent requested not_delivered received not_found

null

null

pacs_source

Any of:

string

string

null

null

duplicate_alert

required

Any of:

DuplicateAlert

DuplicateAlert

object

candidate_id

required

Candidate Id

string

modality

required

Modality

string

date

required

Date

string format: date

days_apart

required

Days Apart

integer

null

null

insurer_request

Any of:

InsurerRequest

InsurerRequest

object

task_id

required

Task Id

string

recipient

required

Recipient

string

since

required

Any of:

string

string format: date

null

null

task

required

Task

The stored FHIR Task. Not sent.

object

key

additional properties

any

null

null

Example

{
  "trigger": {
    "kind": "exam",
    "modality": "CT"
  },
  "patient": {
    "sex": "male"
  },
  "candidates": [
    {
      "source": "nis_record",
      "status": "available",
      "verdict": {
        "label": "relevant",
        "kroky": []
      },
      "decision": "relevant",
      "request_state": "draft"
    }
  ]
}

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": {}
    }
  ]
}