Consultations

The Consultations API allows you to manage clinical consultation records in Jump EHR. Consultations document patient encounters with full clinical data including problems, medications, allergies, observations, and more.

Endpoints

Method	Endpoint	Description
`GET`	`/consultations`	List all consultations
`GET`	`/consultations/{id}`	Retrieve a consultation with full clinical data
`POST`	`/consultations`	Create a consultation

Required scopes: read_consultations for GET requests, write_consultations for POST requests.

The Consultation Object

The single consultation endpoint returns comprehensive clinical data:

{
  "id": "con_123e4567-e89b-12d3-a456-426614174000",
  "consultation_id": "EXT-12345",
  "patient_id": "pat_456e7890-e89b-12d3-a456-426614174111",
  "clinician_id": "cli_789a0123-e89b-12d3-a456-426614174222",
  "location_id": "loc_012b3456-e89b-12d3-a456-426614174333",
  "appointment_id": "apt_345c6789-e89b-12d3-a456-426614174444",
  "consultation_type_code": "185316007",
  "consultation_type_display": "Indirect encounter",
  "consultation_medium_code": "telephone",
  "consultation_medium_display": "Telephone",
  "consultation_setting": "GP Surgery",
  "consultation_setting_code": "22232009",
  "consultation_date": "2025-01-15",
  "consultation_time": "14:00:00",
  "status": "completed",
  "summary": "Follow-up for hypertension management",
  "chief_complaint": "Blood pressure check",
  "diagnosis": "Essential hypertension, well controlled",
  "treatment_plan": "Continue current medication",
  "follow_up_required": true,
  "follow_up_date": "2025-04-15",
  "created_at": "2025-01-15T14:30:00Z",
  "updated_at": "2025-01-15T15:00:00Z",
  "clinician_profiles": {
    "id": "cli_789a0123",
    "name": "Dr Sarah Smith",
    "role": "GP"
  },
  "locations": {
    "id": "loc_012b3456",
    "name": "Main Surgery"
  },
  "consultation_problems": [...],
  "consultation_medications": [...],
  "consultation_allergy_links": [...],
  "consultation_observation_links": [...],
  "consultation_procedure_links": [...],
  "consultation_referral_links": [...],
  "patient_documents": [...]
}

Core Attributes

Field	Type	Description
`id`	string	Unique identifier (UUID)
`consultation_id`	string	External consultation ID
`patient_id`	string	Associated patient ID
`clinician_id`	string	Clinician who conducted the consultation
`location_id`	string	Location where consultation took place
`appointment_id`	string	Associated appointment (if any)
`consultation_type_code`	string	SNOMED CT code for consultation type
`consultation_type_display`	string	Display name for consultation type
`consultation_medium_code`	string	Code for medium (face-to-face, telephone, video)
`consultation_medium_display`	string	Display name for medium
`consultation_setting`	string	Clinical setting
`consultation_date`	string	Date of consultation
`consultation_time`	string	Time of consultation
`status`	string	`in_progress`, `completed`, or `cancelled`
`summary`	string	Brief consultation summary
`chief_complaint`	string	Patient's main complaint
`diagnosis`	string	Clinical diagnosis
`treatment_plan`	string	Treatment plan
`follow_up_required`	boolean	Whether follow-up is needed
`follow_up_date`	string	Scheduled follow-up date

Nested Objects

The single consultation endpoint (GET /consultations/{id}) returns rich nested data for clinical records.

consultation_problems

Problems addressed in this consultation:

{
  "id": "cp_123",
  "patient_problem_id": "pp_456",
  "episode_type": "review",
  "consultation_notes": "BP stable on current medication",
  "patient_problems": {
    "id": "pp_456",
    "snomed_code": "38341003",
    "snomed_display": "Hypertensive disorder",
    "laterality_sct_display": null,
    "status": "active",
    "significance": "major"
  },
  "consultation_problem_headings": [
    { "heading_type": "history", "content": "Patient reports compliance with medication" },
    { "heading_type": "examination", "content": "BP 128/82" }
  ]
}

consultation_medications

Medications prescribed or reviewed:

{
  "id": "cm_123",
  "medication_id": "pm_456",
  "patient_medications": {
    "id": "pm_456",
    "snomed_code": "318475005",
    "display_name": "Amlodipine 5mg tablets",
    "dosage_amount": 1,
    "dosage_unit": "tablet",
    "frequency": "once daily",
    "route": "oral",
    "instructions": "Take in the morning",
    "brand_name": "Amlodipine",
    "strength": "5mg",
    "form_description": "tablets",
    "pack_size": "28",
    "status": "active",
    "indication_problem_id": "pp_456"
  }
}

consultation_allergy_links

Allergies documented or reviewed:

{
  "id": "cal_123",
  "consultation_problem_id": "cp_123",
  "patient_allergies": {
    "id": "pa_456",
    "type": "allergy",
    "criticality": "high",
    "clinical_status": "active",
    "verification_status": "confirmed",
    "note": "Anaphylaxis risk",
    "patient_allergy_codes": [
      { "role": "finding", "code": "91936005", "display": "Allergy to penicillin" }
    ],
    "patient_allergy_reactions": [
      { "manifestation_display": "Anaphylaxis", "severity": "severe" }
    ]
  }
}

consultation_observation_links

Clinical observations (vitals, measurements):

{
  "id": "col_123",
  "consultation_problem_id": "cp_123",
  "observations": {
    "id": "obs_456",
    "code": "85354-9",
    "code_display": "Blood pressure panel",
    "effective_datetime": "2025-01-15T14:15:00Z",
    "value_kind": "composite",
    "note": "Taken after 5 minutes rest",
    "observation_component": [
      { "code": "8480-6", "code_display": "Systolic BP", "value_quantity_value": 128, "value_quantity_unit_display": "mmHg" },
      { "code": "8462-4", "code_display": "Diastolic BP", "value_quantity_value": 82, "value_quantity_unit_display": "mmHg" }
    ]
  }
}

consultation_procedure_links

Procedures performed:

{
  "id": "cpl_123",
  "consultation_problem_id": "cp_123",
  "procedures": {
    "id": "proc_456",
    "code_display": "Blood pressure measurement",
    "status": "completed",
    "performed_datetime": "2025-01-15T14:15:00Z",
    "note": "Automated measurement, left arm"
  }
}

consultation_referral_links

Referrals made:

{
  "id": "crl_123",
  "consultation_problem_id": "cp_123",
  "referrals": {
    "id": "ref_456",
    "service_sct_display": "Cardiology service",
    "priority": "routine",
    "status": "active",
    "reason_summary": "Annual cardiac review",
    "performer_free_text": "Dr Jones",
    "location_free_text": "City Hospital",
    "authored_on": "2025-01-15T14:30:00Z"
  }
}

patient_documents

Documents attached to the consultation:

{
  "id": "doc_123",
  "document_id": "DOC-2025-001",
  "document_title": "Consultation Summary Letter",
  "document_type": "letter",
  "google_docs_url": "https://docs.google.com/...",
  "problem_id": "pp_456",
  "created_at": "2025-01-15T15:00:00Z"
}

List Consultations

GET /consultations

Returns a paginated list of consultations with basic fields.

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	100	Number of records (max 100)
`offset`	integer	0	Pagination offset
`patient_id`	string	-	Filter by patient

Request

curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/consultations?patient_id=pat_456e7890" \
  -H "Authorization: Bearer pk_live_your_api_key"

Response

{
  "data": [
    {
      "id": "con_123e4567-e89b-12d3-a456-426614174000",
      "patient_id": "pat_456e7890-e89b-12d3-a456-426614174111",
      "consultation_date": "2025-01-15",
      "consultation_type": "Follow-up",
      "status": "completed",
      "patients": {
        "id": "pat_456e7890",
        "first_name": "John",
        "last_name": "Smith"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 100,
    "offset": 0,
    "has_more": false
  }
}

Retrieve a Consultation

GET /consultations/{id}

Returns full consultation details with all nested clinical data.

Request

curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/consultations/con_123e4567" \
  -H "Authorization: Bearer pk_live_your_api_key"

Response

Returns the full consultation object with all nested data as shown above.

Create a Consultation

POST /consultations

Request Body

Field	Type	Required	Description
`patient_id`	string	Yes	Patient ID
`consultation_date`	string	Yes	Date (YYYY-MM-DD)
`consultation_time`	string	No	Time (HH:MM:SS)
`appointment_id`	string	No	Associated appointment
`consultation_type_code`	string	No	SNOMED code
`consultation_type_display`	string	No	Display name
`chief_complaint`	string	No	Patient's main complaint
`summary`	string	No	Consultation summary
`notes`	string	No	Additional notes

Request

curl -X POST "https://app.usejump.co.uk/functions/v1/api-v1/consultations" \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "patient_id": "pat_456e7890-e89b-12d3-a456-426614174111",
    "consultation_date": "2025-01-20",
    "consultation_time": "10:00:00",
    "chief_complaint": "Annual checkup"
  }'

Related Resources

Patients - Patient records
Appointments - Appointment scheduling
Problems - Patient diagnoses
Prescriptions - Medications

Patients Problems