DevelopersReturn to site
API Reference

Consultations

Access clinical consultation data via the Jump EHR API. Read-only access to POMR-structured encounters with problems, medications, observations, and more.

The Consultations API provides read-only access to clinical encounter data — the full picture of what happened during a patient visit. Consultations follow the POMR (Problem-Oriented Medical Record) structure, with observations, medications, procedures, and other clinical data scoped to specific problems.

Consultations are read-only via the API. Create and manage consultations through the Jump dashboard.

core is a stable alias — it will always resolve to problems, observations, medications, and prescriptions in API v1.

The base consultation represents the original finalized record. Amendments are an overlay — corrections, addenda, or clarifications applied after finalization. Partners must apply amendments to reconstruct the current clinical state.

GET
/consultations

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
patient_id?string
Formatuuid
clinician_id?string
Formatuuid
appointment_id?string
Formatuuid
episode_id?string
Formatuuid
status?string

Value in

  • "draft"
  • "in_progress"
  • "completed"
  • "scheduled"
  • "imported"
status_in?string

Comma-separated

consultation_date_gte?string
Formatdate
consultation_date_lte?string
Formatdate
has_amendments?string

Response Body

application/json

curl -X GET "https://example.com/consultations"
{  "data": [    {      "id": "string",      "consultation_id": "string",      "patient_id": "string",      "clinician_id": "string",      "location_id": "string",      "appointment_id": "string",      "episode_id": "string",      "consultation_date": "string",      "consultation_time": "string",      "status": "draft",      "consultation_type_code": "string",      "consultation_type_display": "string",      "consultation_medium_code": "string",      "consultation_medium_display": "string",      "consultation_setting": "string",      "consultation_setting_code": "string",      "template_id": "string",      "template_version": 0,      "finalized_at": "string",      "finalized_by": "string",      "has_amendments": true,      "notes": "string",      "created_at": "string",      "updated_at": "string"    }  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
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

Path Parameters

id*string
Formatuuid

Query Parameters

include?string

Comma-separated sections to include. Default: all. Use 'core' for problems+observations+medications+prescriptions.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": null,  "meta": null}
GET
/consultations/{id}/problems

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/problems"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/medications

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/medications"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/observations

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/observations"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/procedures

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/procedures"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/referrals

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/referrals"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/lab-orders

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/lab-orders"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/prescriptions

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/prescriptions"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/allergies

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/allergies"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/immunisations

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/immunisations"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/documents

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/family-history

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/family-history"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/social-history

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/social-history"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/invoices

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invoices"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/consultations/{id}/amendments

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

Response Body

application/json

application/json

curl -X GET "https://example.com/consultations/497f6eca-6276-4993-bfeb-53cbbbba6f08/amendments"
{  "data": [    {}  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}