List Patients

GET

/api/patients

curl --request GET \
  --url 'https://example.com/api/patients?q='

Parameters

Query Parameters

q

Q

string

""

Responses

200

Successful Response

Media typeapplication/json

Response List Patients Api Patients Get

Array<object>

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

Example

[
  {
    "sex": "male"
  }
]

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