Approve

POST

/api/requests/{request_id}/approve

curl --request POST \
  --url https://example.com/api/requests/example/approve

Parameters

Path Parameters

request_id

required

Request Id

string

Responses

200

Successful Response

Media typeapplication/json

RequestItem

object

id

required

Id

string

trigger_id

required

Trigger Id

string

trigger_date

required

Trigger Date

string format: date

patient_id

required

Patient Id

string

candidate_id

required

Candidate Id

string

prior_modality

required

Prior Modality

string

prior_date

required

Any of:

string

string

null

null

prior_description

required

Prior Description

string

place

required

Any of:

string

string

null

null

organization_id

required

Any of:

string

string

null

null

channel

required

Channel

string

Allowed values: email phone fhir

state

required

State

string

Allowed values: draft sent requested not_delivered received not_found

contact

required

Any of:

Contact

Contact

object

organization_id

required

Organization Id

string

organization_name

required

Organization Name

string

email

required

Any of:

string

string

null

null

phone

required

Any of:

string

string

null

null

source_url

required

Any of:

string

string

null

null

verified_at

required

Any of:

string

string format: date

null

null

needs_reverify

required

Needs Reverify

boolean

fhir_endpoint

Any of:

string

string

null

null

null

null

email_draft

required

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

sent_at

required

Any of:

string

string format: date-time

null

null

study_id

Any of:

string

string

null

null

fhir_task

Any of:

object

object

key

additional properties

any

null

null

Example

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