Patients

Manage patient records with the Jump EHR Patients API. Create, read, update, and search patient data.

The Patients API allows you to manage patient records in Jump EHR. Patients are the core resource that other clinical data (episodes, appointments, questionnaires) relates to.

Deleting patients is not permitted (clinical data protection). Use PATCH to archive instead.

Status filters are case-sensitive and must match exact values. See individual collection docs below for valid values.

consultation_context is not a substitute for consultation endpoints. To reconstruct what happened in a specific consultation, use GET /consultations/{id}.

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100

Default20

offset?integer

Number of records to skip (default 0)

Range0 <= value

Default0

status?string

Value in

"active"
"inactive"
"archived"
"merged"

patient_type?string

Value in

"active"
"temporary"
"dummy"
"archived"
"merged"

status_in?string

Comma-separated list of statuses

created_at_gte?string

Formatdate-time

created_at_lte?string

Formatdate-time

search?string

Case-insensitive search across first_name, last_name, email, nhs_number

Response Body

`application/json`

curl -X GET "https://example.com/patients"

{  "data": [    {      "id": "123e4567-e89b-12d3-a456-426614174000",      "first_name": "Sarah",      "last_name": "Johnson",      "middle_name": "Anne",      "preferred_name": "Sally",      "title": "Ms",      "date_of_birth": "1985-03-15",      "biological_sex": "female",      "gender": "woman",      "ethnicity": "Example ethnicity",      "nhs_number": "9990000018",      "email": "sarah.johnson@example.com",      "phone": "+44 7700 900123",      "mobile_phone": "+44 7700 900123",      "home_phone": "+44 7700 900456",      "address_line_1": "123 Example Street",      "address_line_2": "Flat 4",      "address_line_3": null,      "town_city": "London",      "postcode": "SW1A 1AA",      "country": "United Kingdom",      "preferred_contact_method": "email",      "status": "active",      "patient_type": "active",      "is_deceased": false,      "date_of_death": null,      "requires_review": false,      "review_reason": "Example review reason",      "accessibility_needs": {        "requiresInterpreter": true,        "interpreterLanguage": {          "code": "pl",          "display": "Polish"        },        "requiresBSL": false,        "accessNeeds": [          "wheelchair_access_required"        ]      },      "accessibility_notes": "Example accessibility notes",      "occupation": "Teacher",      "pronouns": "she/her",      "named_clinician_id": "123e4567-e89b-12d3-a456-426614174001",      "patient_id": "P-100428",      "external_id": "crm-4821",      "patient_notes": "Example patient notes",      "consent_sms": false,      "consent_email": false,      "consent_marketing": false,      "consent_electronic_communication": false,      "archived_at": "2026-01-15T10:30:00Z",      "archived_by": "123e4567-e89b-12d3-a456-426614174002",      "archive_reason": "Example archive reason",      "archive_notes": "Example archive notes",      "created_at": "2026-01-15T10:30:00Z",      "updated_at": "2026-01-15T10:30:00Z"    }  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}

Try-it is disabled for POST /patients

This operation writes data. Running it from these docs would target the production API and change a real record. Copy the request sample and run it against staging first.

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Optional UUID for request deduplication. Same key + same body returns the cached response. Same key + different body returns 409 CONFLICT. Keys are scoped to your organisation and endpoint, and expire after 24 hours.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

first_name*string

last_name*string

date_of_birth*string

Formatdate

middle_name?string

preferred_name?string

title?string

biological_sex?string

Value in

"male"
"female"
"unknown"
"indeterminate"

gender?string

Value in

"man"
"woman"
"non_binary"
"other"
"prefer_not_to_say"

ethnicity?string

nhs_number?string

Format: 123-123-1234 or 1231231234

email?string

Formatemail

phone?string

mobile_phone?string

home_phone?string

address_line_1?string

address_line_2?string

address_line_3?string

town_city?string

postcode?string

country?string

status?string

Value in

"active"
"inactive"
"archived"
"merged"

patient_type?string

Value in

"active"
"temporary"
"dummy"
"archived"
"merged"

pronouns?string

Free-text pronouns, e.g. "she/her".

named_clinician_id?string

The patient's named clinician. Must reference a clinician in the caller's organisation, otherwise the request is rejected with 422.

Formatuuid

patient_id?string

Human-facing patient identifier. Must be unique across all patients; auto-generated if omitted. A collision is rejected with 422.

external_id?string

Your own reference for this patient. Must be unique within your organisation; a collision is rejected with 422.

accessibility_needs?|array<string>

Patient accessibility needs. Accepts either the modern object form (recommended — carries interpreter-language and BSL flags) or the legacy array form (a plain list of access-need codes). Stored as JSON.

gp_registration?

The patient's GP registration. Stored in a child table, not on the patient row. On create it seeds the current registration; on update it merges into the current (is_current) registration, field by field — only the keys you send are changed. Written atomically with the patient (a partial failure rolls the whole request back). confirmed_source is always stamped api.

emergency_contact?

The patient's emergency contact. Stored in a child table, not on the patient row. On create it inserts the emergency contact; on update it merges into the existing emergency contact, field by field. Written atomically with the patient. A single emergency contact is supported; next-of-kin / carer contacts are not exposed here yet.

Response Body

`application/json`

curl -X POST "https://example.com/patients" \  -H "Content-Type: application/json" \  -d '{    "first_name": "string",    "last_name": "string",    "date_of_birth": "2019-08-24"  }'

{  "data": {    "id": "123e4567-e89b-12d3-a456-426614174000",    "first_name": "Sarah",    "last_name": "Johnson",    "middle_name": "Anne",    "preferred_name": "Sally",    "title": "Ms",    "date_of_birth": "1985-03-15",    "biological_sex": "female",    "gender": "woman",    "ethnicity": "Example ethnicity",    "nhs_number": "9990000018",    "email": "sarah.johnson@example.com",    "phone": "+44 7700 900123",    "mobile_phone": "+44 7700 900123",    "home_phone": "+44 7700 900456",    "address_line_1": "123 Example Street",    "address_line_2": "Flat 4",    "address_line_3": null,    "town_city": "London",    "postcode": "SW1A 1AA",    "country": "United Kingdom",    "preferred_contact_method": "email",    "status": "active",    "patient_type": "active",    "is_deceased": false,    "date_of_death": null,    "requires_review": false,    "review_reason": "Example review reason",    "accessibility_needs": {      "requiresInterpreter": true,      "interpreterLanguage": {        "code": "pl",        "display": "Polish"      },      "requiresBSL": false,      "accessNeeds": [        "wheelchair_access_required"      ]    },    "accessibility_notes": "Example accessibility notes",    "occupation": "Teacher",    "pronouns": "she/her",    "named_clinician_id": "123e4567-e89b-12d3-a456-426614174001",    "patient_id": "P-100428",    "external_id": "crm-4821",    "patient_notes": "Example patient notes",    "consent_sms": false,    "consent_email": false,    "consent_marketing": false,    "consent_electronic_communication": false,    "archived_at": "2026-01-15T10:30:00Z",    "archived_by": "123e4567-e89b-12d3-a456-426614174002",    "archive_reason": "Example archive reason",    "archive_notes": "Example archive notes",    "created_at": "2026-01-15T10:30:00Z",    "updated_at": "2026-01-15T10:30:00Z"  },  "meta": {    "request_id": "req_abc123"  }}

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/patients/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": {    "id": "123e4567-e89b-12d3-a456-426614174000",    "first_name": "Sarah",    "last_name": "Johnson",    "middle_name": "Anne",    "preferred_name": "Sally",    "title": "Ms",    "date_of_birth": "1985-03-15",    "biological_sex": "female",    "gender": "woman",    "ethnicity": "Example ethnicity",    "nhs_number": "9990000018",    "email": "sarah.johnson@example.com",    "phone": "+44 7700 900123",    "mobile_phone": "+44 7700 900123",    "home_phone": "+44 7700 900456",    "address_line_1": "123 Example Street",    "address_line_2": "Flat 4",    "address_line_3": null,    "town_city": "London",    "postcode": "SW1A 1AA",    "country": "United Kingdom",    "preferred_contact_method": "email",    "status": "active",    "patient_type": "active",    "is_deceased": false,    "date_of_death": null,    "requires_review": false,    "review_reason": "Example review reason",    "accessibility_needs": {      "requiresInterpreter": true,      "interpreterLanguage": {        "code": "pl",        "display": "Polish"      },      "requiresBSL": false,      "accessNeeds": [        "wheelchair_access_required"      ]    },    "accessibility_notes": "Example accessibility notes",    "occupation": "Teacher",    "pronouns": "she/her",    "named_clinician_id": "123e4567-e89b-12d3-a456-426614174001",    "patient_id": "P-100428",    "external_id": "crm-4821",    "patient_notes": "Example patient notes",    "consent_sms": false,    "consent_email": false,    "consent_marketing": false,    "consent_electronic_communication": false,    "archived_at": "2026-01-15T10:30:00Z",    "archived_by": "123e4567-e89b-12d3-a456-426614174002",    "archive_reason": "Example archive reason",    "archive_notes": "Example archive notes",    "created_at": "2026-01-15T10:30:00Z",    "updated_at": "2026-01-15T10:30:00Z"  },  "meta": {    "request_id": "req_abc123"  }}

Try-it is disabled for PATCH /patients/{id}

This operation writes data. Running it from these docs would target the production API and change a real record. Copy the request sample and run it against staging first.

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Partial update — only supplied fields are changed.

first_name?string

last_name?string

date_of_birth?string

Formatdate

middle_name?string

preferred_name?string

title?string

biological_sex?string

Value in

"male"
"female"
"unknown"
"indeterminate"

gender?string

Value in

"man"
"woman"
"non_binary"
"other"
"prefer_not_to_say"

ethnicity?string

nhs_number?string

email?string

Formatemail

phone?string

mobile_phone?string

home_phone?string

address_line_1?string

address_line_2?string

address_line_3?string

town_city?string

postcode?string

country?string

preferred_contact_method?string

Value in

"email"
"mobile"
"home_phone"
"letter"

status?string

Value in

"active"
"inactive"
"archived"
"merged"

patient_type?string

Value in

"active"
"temporary"
"dummy"
"archived"
"merged"

is_deceased?boolean

date_of_death?string

Formatdate

requires_review?boolean

review_reason?string

accessibility_needs?|array<string>

accessibility_notes?string

occupation?string

pronouns?string

Free-text pronouns, e.g. "she/her".

named_clinician_id?string

The patient's named clinician. Must reference a clinician in the caller's organisation, otherwise the request is rejected with 422.

Formatuuid

patient_id?string

Human-facing patient identifier. Must be unique across all patients; a collision is rejected with 422.

external_id?string

Your own reference for this patient. Must be unique within your organisation; a collision is rejected with 422.

patient_notes?string

consent_sms?boolean

consent_email?boolean

consent_marketing?boolean

consent_electronic_communication?boolean

gp_registration?

emergency_contact?

Response Body

`application/json`

curl -X PATCH "https://example.com/patients/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "123e4567-e89b-12d3-a456-426614174000",    "first_name": "Sarah",    "last_name": "Johnson",    "middle_name": "Anne",    "preferred_name": "Sally",    "title": "Ms",    "date_of_birth": "1985-03-15",    "biological_sex": "female",    "gender": "woman",    "ethnicity": "Example ethnicity",    "nhs_number": "9990000018",    "email": "sarah.johnson@example.com",    "phone": "+44 7700 900123",    "mobile_phone": "+44 7700 900123",    "home_phone": "+44 7700 900456",    "address_line_1": "123 Example Street",    "address_line_2": "Flat 4",    "address_line_3": null,    "town_city": "London",    "postcode": "SW1A 1AA",    "country": "United Kingdom",    "preferred_contact_method": "email",    "status": "active",    "patient_type": "active",    "is_deceased": false,    "date_of_death": null,    "requires_review": false,    "review_reason": "Example review reason",    "accessibility_needs": {      "requiresInterpreter": true,      "interpreterLanguage": {        "code": "pl",        "display": "Polish"      },      "requiresBSL": false,      "accessNeeds": [        "wheelchair_access_required"      ]    },    "accessibility_notes": "Example accessibility notes",    "occupation": "Teacher",    "pronouns": "she/her",    "named_clinician_id": "123e4567-e89b-12d3-a456-426614174001",    "patient_id": "P-100428",    "external_id": "crm-4821",    "patient_notes": "Example patient notes",    "consent_sms": false,    "consent_email": false,    "consent_marketing": false,    "consent_electronic_communication": false,    "archived_at": "2026-01-15T10:30:00Z",    "archived_by": "123e4567-e89b-12d3-a456-426614174002",    "archive_reason": "Example archive reason",    "archive_notes": "Example archive notes",    "created_at": "2026-01-15T10:30:00Z",    "updated_at": "2026-01-15T10:30:00Z"  },  "meta": {    "request_id": "req_abc123"  }}

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string

Formatuuid

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100

Default20

offset?integer

Number of records to skip (default 0)

Range0 <= value

Default0

code?string

Filter by SNOMED/observation code

status?string

effective_datetime_gte?string

Formatdate-time

effective_datetime_lte?string

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/patients/497f6eca-6276-4993-bfeb-53cbbbba6f08/observations"

{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string

Formatuuid

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100

Default20

offset?integer

Number of records to skip (default 0)

Range0 <= value

Default0

status?string

status_in?string

Comma-separated status values

Response Body

`application/json`

curl -X GET "https://example.com/patients/497f6eca-6276-4993-bfeb-53cbbbba6f08/medications"

{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string

Formatuuid

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100

Default20

offset?integer

Number of records to skip (default 0)

Range0 <= value

Default0

status?string

status_in?string

Comma-separated status values

significance?string

Response Body

`application/json`

curl -X GET "https://example.com/patients/497f6eca-6276-4993-bfeb-53cbbbba6f08/problems"

{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string

Formatuuid

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100

Default20

offset?integer

Number of records to skip (default 0)

Range0 <= value

Default0

status?string

priority?string

authored_on_gte?string

Formatdate

authored_on_lte?string

Formatdate

Response Body

`application/json`

curl -X GET "https://example.com/patients/497f6eca-6276-4993-bfeb-53cbbbba6f08/referrals"

{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string

Formatuuid

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100

Default20

offset?integer

Number of records to skip (default 0)

Range0 <= value

Default0

clinical_status?string

criticality?string

Response Body

`application/json`

curl -X GET "https://example.com/patients/497f6eca-6276-4993-bfeb-53cbbbba6f08/allergies"

{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}

Authorization

BearerApiKey

AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string

Formatuuid

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100

Default20

offset?integer

Number of records to skip (default 0)

Range0 <= value

Default0

status?string

Response Body

`application/json`

curl -X GET "https://example.com/patients/497f6eca-6276-4993-bfeb-53cbbbba6f08/immunisations"

{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}

200application/json

401application/json

500application/json

201application/json

401application/json

409application/json

422application/json

500application/json

200application/json

401application/json

404application/json

500application/json

200application/json

401application/json

404application/json

422application/json

500application/json

200application/json

404application/json

200application/json

404application/json

200application/json

404application/json

200application/json

404application/json

200application/json

404application/json

200application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`