Get a list of assessments

GET /api/v1/assessments

Api key auth

Retrieve a list of assessments 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. Only 'id', 'date', 'created_at', and 'values' columns are allowed.
filter object

Filter criteria to narrow down the list of assessments. 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. '/assessments?wound_id=3089&filter[date]=>=2021-01-01')
Hide filter attributes Show filter attributes object
- id string
  
  Filter by ID with operators '>', '<', '>=', or '<='.
- date string
  
  Filter by assessment date with operators '>', '<', '>=', or '<='.
- created_at string
  
  Filter by creation date with operators '>', '<', '>=', or '<='.
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
  
  created_at string(date-time)
  
  Date and time the site was created (UTC time)
  
  values object
  
  Collection of assessment values
  
  Hide values attributes Show values attributes object
  
  wound_edge array[string] Required
  
  Assessment values for the wound edge sub-group
  
  Values are ATTACHED, NOT_ATTACHED, ROLLED, EPITHELIALIZED, or OTHER-FREE-TEXT.
  
  peri_wound_skin array[string] Required
  
  Assessment values for the peri-wound skin sub-group
  
  Values are ABNORMAL, BLISTERING_ERUPTION, BRUISING, CALLOUSED, DRY, EDEMA, ERYTHEMA, EXCORIATION, FRAGILE, HYPERKERTOSIS, INDURATED, MACERATION, NORMAL, SCALY, SITE_SPECIFIC_ECZEMA, or OTHER_FREE_TEXT.
  
  pain object Required
  
  Assessment values for the pain sub-group
  
  Hide pain attributes Show pain attributes object
  
  at_rest_scale integer
  
  Pain level at rest on a scale of 0 to 10
  
  Minimum value is 0, maximum value is 10.
  
  with_movement_scale integer
  
  Pain level with movement on a scale of 0 to 10
  
  Minimum value is 0, maximum value is 10.
  
  at_night_scale integer
  
  Pain level at night on a scale of 0 to 10
  
  Minimum value is 0, maximum value is 10.
  
  exudate object Required
  
  Assessment values for the exudate sub-group
  
  Hide exudate attributes Show exudate attributes object
  
  amount string
  
  Amount of exudate present
  
  Values are NONE, MINIMUM, MODERATE, or LARGE.
  
  comment string
  
  Additional comments on the exudate
  
  type string
  
  Type of exudate present
  
  Values are SEROUS, PURULENT, SANGUINEOUS, SERO-SANGUINEOUS, HEAMOPURULENT, or OTHER.
  
  odor string Required
  
  Assessment values for odor sub-group
  
  Values are NO or MALODOROUS.
  
  infection object
  
  Assessment values for the infection sub-group
  
  One of:
  object-1 object object-2 object
  
  Hide attributes Show attributes
  
  infected string Required
  
  Indicates the wound is infected.
  
  Value is YES.
  
  signs_of_local_infection array[string] Required
  
  Signs of local infection.
  
  Values are BLEEDING__FRIABLE_GRANULATION_TISSUE, CELLULITIS, DELAYED_WOUND_HEALING, ERYTHEMA, INCREASED_EXUDATE, INCREASED_PAIN, LOCAL_WARMTH, MALODOUR, OEDEMA, POCKETING_TUNNELLING, RAPID_EXTENSION_OF_AREA_ULCERATION, or UNDERMINING.
  
  wound_swab string Required
  
  Indicates whether a wound swab has been taken.
  
  Values are YES or NO.
  
  wound_swab_date string(date) | null
  
  Date of wound swab collection.
  
  tunneling object
  
  Assessment values for the tunneling sub-group
  
  Hide tunneling attributes Show tunneling attributes object
  
  direction array[integer]
  
  Horloge-based direction(s) of tunneling
  
  Minimum value of each is 1, maximum value of each is 12. Values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, or 12.
  
  length integer
  
  Length of tunneling in centimeters
  
  undermining object
  
  Assessment values for the undermining sub-group
  
  Hide undermining attributes Show undermining attributes object
  
  direction array[integer]
  
  Horloge-based direction(s) of undermining
  
  Minimum value of each is 1, maximum value of each is 12. Values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, or 12.
  
  length integer
  
  Length of undermining in centimeters
  
  miscellaneous object
  
  Assessment values for the miscellaneous sub-group
  
  Hide miscellaneous attributes Show miscellaneous attributes object
  
  unable_to_capture string Required
  
  Indicates the user was unable to capture image/measurement.
  
  Values are YES or NO.
  
  unable_to_capture_reason string | null
  
  Reason image/measurement was not captured.
  
  qol_assessment_performed string Required
  
  Indicates whether a QoL assessment was performed.
  
  Values are YES, NO, or N/A.
  
  qol_details string | null
  
  Details of the QoL assessment.
  
  notes string
  
  Additional notes on the assessment
- 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/assessments

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

Response examples (200)

{
  "data": [
    {
      "id": 1168,
      "date": "2021-01-01",
      "created_at": "2021-01-01 00:00:00",
      "values": {
        "wound_edge": [
          "ATTACHED",
          "ROLLED",
          "The wound edge is attached and rolled"
        ],
        "peri_wound_skin": [
          "ABNORMAL",
          "BLISTERING_ERUPTION",
          "BRUISING",
          "The peri-wound skin is bruised"
        ],
        "pain": {
          "at_rest_scale": 3,
          "with_movement_scale": 5,
          "at_night_scale": 2
        },
        "exudate": {
          "amount": "MINIMUM",
          "comment": "Exudate is minimal and serous",
          "type": "SEROUS"
        },
        "odor": "MALODOROUS",
        "infection": {
          "infected": "YES",
          "signs_of_local_infection": [
            "BLEEDING__FRIABLE_GRANULATION_TISSUE"
          ],
          "wound_swab": "YES",
          "wound_swab_date": "2021-01-01"
        },
        "tunneling": {
          "direction": [
            12,
            3
          ],
          "length": 2
        },
        "undermining": {
          "direction": [
            2,
            3
          ],
          "length": 2
        },
        "miscellaneous": {
          "unable_to_capture": "YES",
          "unable_to_capture_reason": "Patient refused to have image taken",
          "qol_assessment_performed": "YES",
          "qol_details": "Patient reported a QoL of 5"
        },
        "notes": "Patient reported increased pain and exudate"
      }
    }
  ],
  "metadata": {
    "current_page": 1,
    "last_page": 55,
    "per_page": 2,
    "total": 110,
    "next_page_url": "https://publicapi.ekareinc.com/api/v1/assessments?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"
}

Get a list of assessments

Path parameters

Query parameters

Responses

infection object