Get a list of treatments

GET /api/v1/treatments

Api key auth

Retrieve a list of treatments associated with a specific wound, with optional sorting, pagination, and filtering.

Path parameters

wound_id integer Required

ID of the wound

Query parameters

per_page integer

Number of items per page.
fields string(csv)

Comma-separated list of fields to be returned in the response. Fields list will be available soon.
filter object

Filter criteria to narrow down the list of treatments. The filter parameter is an object with key-value pairs where the key is the field to filter by and the value is '{operator}{value}'. The operator is optional and defaults to '='. (e.g. '/treatments?wound_id=3089&filter[date]=>=2021-01-01')
sort string

Field to sort the results by. Only 'id' and 'created_at' columns are allowed, prefixed with a minus sign (-) for descending order and without for ascending order.

Values are id, -id, created_at, or -created_at.

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id integer
  
  date string(date)
  
  Date the Assessment was performed
  
  consultation_type string
  
  Type of consultation
  
  Values are REMOTE_DIGITAL, TELEHEALTH, or FACE_TO_FACE.
  
  is_referral_in boolean
  
  Indicates if the patient was referred to the wound care clinic
  
  date_of_referral string(date)
  
  Date the patient was referred to the wound care clinic
  
  debridement string
  
  Type of debridement performed
  
  Values are NONE, AUTOLYTIC, BIOLOGICAL, HYDRO_SURGICAL, MECHANICAL, SHARP, SURGICAL, ULTRASONIC, MAGGOT, or OTHER.
  
  dressing_change string
  
  Indicates if a dressing change was performed
  
  Values are NONE, YES, NO, or OTHER.
  
  pressure_restribution string
  
  Indicates if pressure redistribution was used
  
  Values are NONE, YES, or NO.
  
  comment string
  
  Additional comments on the treatment
  
  created_at string(date-time)
  
  Date and time the treatment was created in the system (UTC time)
  
  wound_care_protocol object
  
  Wound care protocol used for the treatment
  
  Hide wound_care_protocol attributes Show wound_care_protocol attributes object
  
  id integer
  
  timestamp string(date-time)
  
  Date and time the protocol was created (UTC time)
  
  values object
  
  Collection of protocol values
- metadata object
  
  Hide metadata attributes Show metadata attributes object
  
  current_page integer
  
  last_page integer
  
  per_page integer
  
  total integer
  
  next_page_url string
  
  prev_page_url string
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- error string
- message string
- error_code number
404 application/json

Not Found
Hide response attributes Show response attributes object
- error string
- message string
- error_code number
403 application/json

Forbidden
Hide response attributes Show response attributes object
- error string
- message string
- error_code number
422 application/json

Bad Request
Hide response attributes Show response attributes object
- error string
- message string
- error_code number

GET /api/v1/treatments

curl \
 --request GET 'https://publicapi.ekareinc.com/api/v1/treatments' \
 --header "X-API-KEY: $API_KEY"

Response examples (200)

{
  "data": [
    {
      "id": 1168,
      "date": "2021-01-01",
      "consultation_type": "FACE_TO_FACE",
      "is_referral_in": true,
      "date_of_referral": "2021-01-01",
      "debridement": "SHARP",
      "dressing_change": "YES",
      "pressure_restribution": "YES",
      "comment": "Patient tolerated the treatment well",
      "created_at": "2021-01-01 00:00:00",
      "wound_care_protocol": {
        "id": 1168,
        "timestamp": "2021-01-01 00:00:00",
        "values": {}
      }
    }
  ],
  "metadata": {
    "current_page": 1,
    "last_page": 55,
    "per_page": 2,
    "total": 110,
    "next_page_url": "https://publicapi.ekareinc.com/api/v1/treatments?wound_id=3089&page=2",
    "prev_page_url": "string"
  }
}

Response examples (401)

{
  "error": "Invalid API token",
  "message": "Unauthorized. Please provide a valid API token.",
  "error_code": "100"
}

Response examples (404)

{
  "error": "Wound Not Found",
  "message": "The wound with the specified ID was not found.",
  "error_code": "111"
}

Response examples (403)

{
  "error": "Access denied",
  "message": "Forbidden. You do not have permission to access this resource.",
  "error_code": "101"
}

Response examples (422)

{
  "error": "Bad Request",
  "message": "The given data was invalid.",
  "error_code": "102"
}