Change Updates

Do not miss any eKare - Public API changes, ever again

Subscribe to the eKare - Public API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
2 structure changes including:
2 Additions
Added 2
GET /api/v1/general-assessments
GET /api/v1/treatments
2 structure changes including:
2 Breaking changes
2 Removals
Removed 2 Breaking
GET /api/v1/general-assessments
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/v1/treatments
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
1 structure change including:
1 Modification
Modified 1
GET /api/v1/treatments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • consultation_type, is_referral_in, date_of_referral properties Added
1 structure change including:
1 Modification
Modified 1
GET /api/v1/assessments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • values property Modified
1 structure change including:
1 Modification
Modified 1
GET /api/v1/assessments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • values property Modified
1 structure change including:
1 Modification
Modified 1
GET /api/v1/assessments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • values property Modified
3 structure changes including:
2 Additions
1 Modification
Modified 1 Breaking
GET /api/v1/assessments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • values property Modified
          • Type went from array[object] to object
            Breaking
Added 2
GET /api/v1/general-assessments
GET /api/v1/treatments
1 structure change including:
1 Addition
Added 1
GET /api/v1/assessments
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /api/v1/measurements
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /api/v1/patients
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /api/v1/sites
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /api/v1/wounds
  • Authentication
  • Bearer auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
3 structure changes including:
3 Breaking changes
3 Modifications
Modified 3 Breaking
GET /api/v1/measurements
  • Path went from /api/v1/wounds/{wound_id}/measurements to /api/v1/measurements (same operationId)
    Breaking
  • Query
  • filter query parameter Modified
    • type query parameter Modified
      • Type went from number to string
        Breaking
    • id, date, avg_depth, max_depth, max_width, max_length, perimeter, area, volume, granulation, slough, eschar, is_locked, created_at, updated_at query parameters Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • images property Modified
GET /api/v1/patients
  • Path went from /api/v1/sites/{site_id}/patients to /api/v1/patients (same operationId)
    Breaking
  • Query
  • filter query parameter Modified
    • clinic_id query parameter Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • id, first_name, last_name, mrn, dob, gender, phone, address, zip, created_at query parameters Added
  • site_id query parameter Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • site_id property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
  • 404 response Added
GET /api/v1/wounds
  • Path went from /api/v1/patients/{patient_id}/wounds to /api/v1/wounds (same operationId)
    Breaking
  • Query
  • filter query parameter Modified
    • is_locked query parameter Modified
      • Type went from string to boolean
        Breaking
    • id, onset_date, type, secondary_type, primary_location, secondary_location, is_front, created_at, updated_at query parameters Added
  • patient_id query parameter Added
  • Path
  • patient_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
1 structure change including:
1 Modification
Modified 1 Breaking
GET /api/v1/sites
  • Query
  • filter query parameter Modified
    • attribute query parameter Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • created_at, id, name, address, country, province query parameters Added
5 structure changes including:
2 Breaking changes
1 Addition
3 Modifications
1 Removal
Modified 3 Breaking
GET /api/v1/patients/{patient_id}/wounds
  • Query
  • filter query parameter Modified
    • attribute query parameter Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • is_locked, status query parameters Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • onset, is_active properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • onset_date, is_locked properties Added
GET /api/v1/sites
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • website property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • web property Added
GET /api/v1/sites/{site_id}/patients
  • Path went from /api/v1/patients to /api/v1/sites/{site_id}/patients (same operationId)
    Breaking
  • Query
  • filter query parameter Modified
    • is_frozen query parameter Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • initials, is_enabled, clinic_id, nationality, race, religion, country_code, insurance_number, insurer_code properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • is_frozen, site_id properties Added
Removed 1 Breaking
GET /api/v1/measurements/{patient_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /api/v1/wounds/{wound_id}/measurements
1 structure change including:
1 Addition
Added 1
GET /api/v1/sites
1 structure change including:
1 Modification
Modified 1
GET /api/v1/patients/{patient_id}/wounds
  • Path
  • patient_id path parameter Added
3 structure changes including:
1 Breaking change
2 Additions
1 Removal
Removed 1 Breaking
GET /api/v1/patients
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
GET /api/v1/patients
GET /api/v1/patients/{patient_id}/wounds
1 structure change including:
1 Modification
Modified 1 Breaking
GET /api/v1/patients
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data, metadata properties Added
  • 401 response Modified
    • application/json content type Modified
      • error, error_code properties Added
  • 403 response Modified
    • application/json content type Modified
      • error, error_code properties Added
  • 400 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 422 response Added