List a patient's consultations

The patient’s consultations, newest first, with the professional’s notes, the measurements and lab results taken, and the pre-consultation form. Page size is fixed at 50.

Requires the clinical:read permission.

GET/patients/{patient_id}/consultations

Autorización

AuthorizationToken Bearer (API Key) · headerobligatorio

Almendra API key, bound to one professional account. Send it as Authorization: Bearer YOUR_API_KEY.

Ámbitos:clinical:read

Parámetros de ruta

patient_idstringobligatorio

Patient ID

coincide con ^[0-9a-fA-F]{24}$

Parámetros de consulta

pageinteger

Page number (starts at 1)

mín. 0 · predeterminado: 1

Respuestas

200

Consultations

consultationsConsultation[]obligatorio

Mostrar propiedades

Array de Consultation

_idstringobligatorio

Appointment ID

statusstringobligatorio

Valores permitidos:scheduledin_progresscompleted

datestring<date-time>

When it started (or is scheduled to start)

durationMinutesnumber

reasonstring

notesstring

Consultation / progress notes written by the professional

measurementsobjectobligatorio

Measurements and lab results taken in this consultation, keyed by name: anthropometry (weight kg, height cm, waistGirth, skinfolds…), body composition (bodyFatPercentage, muscleMass…), vitals and blood tests (fastingBloodSugar, totalCholesterol, hemoglobin, vitaminD…).

formobject

Form the patient was asked to fill before this consultation. Its answers are saved into the patient's clinical history.

Mostrar propiedades

_idstringobligatorio

namestring

completedbooleanobligatorio

mealPlansstring[]obligatorio

Meal plans created in this consultation

pageintegerobligatorio

mín. 0

pageSizeintegerobligatorio

mín. 0

totalCountintegerobligatorio

totalPagesintegerobligatorio

400

Invalid path parameter, query parameter or request body

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

Valores permitidos:bad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictpayload_too_largeunsupported_media_typeunprocessable_entityrate_limitedinternal_errornot_implementedbad_gatewayservice_unavailablegateway_timeout

messagestringobligatorio

Human-readable explanation of what went wrong.

401

Missing or invalid API key

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

403

The account behind the API key has no active paid plan, or the key lacks the permission this operation needs

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

404

Patient not found

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

429

Rate limit exceeded (600 requests per 60 seconds); retry after Retry-After seconds

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

500

Unexpected server error

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

Pruébalo

Servidor

URL baseURL base personalizadaSi se define, sustituye al servidor seleccionado.

Autorización

Token Bearer (API Key)Recordar en este dispositivoIncluir mis valores en los ejemplos

Parámetros

patient_idpath*Patient IDpagequeryPage number (starts at 1)

Solicitud

curl -X GET 'https://api.almendra.io/openapi/v1/patients/507f1f77bcf86cd799439011/consultations' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response: Response = await fetch("https://api.almendra.io/openapi/v1/patients/507f1f77bcf86cd799439011/consultations", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import axios from "axios";

const response = await axios.request({
  method: "GET",
  url: "https://api.almendra.io/openapi/v1/patients/507f1f77bcf86cd799439011/consultations",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.almendra.io/openapi/v1/patients/507f1f77bcf86cd799439011/consultations",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Respuesta

{
  "consultations": [
    {
      "_id": "string",
      "status": "scheduled",
      "date": "2019-08-24T14:15:22Z",
      "durationMinutes": 0,
      "reason": "string",
      "notes": "string",
      "measurements": {
        "weight": 72.4,
        "waistGirth": 84,
        "fastingBloodSugar": 92
      },
      "form": {
        "_id": "string",
        "name": "string",
        "completed": true
      },
      "mealPlans": [
        "string"
      ]
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalCount": 150,
  "totalPages": 3
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

List a patient's consultations

¿No encuentras lo que buscas?