API Guide

Introduction

• Introduction to the PainChek API
• Getting Started
• Authentication and Tokens
• Accessing the Swagger Documentation
• Data Model
• Common Fields

Best Practice Guide for Integrating with a Resident Care System

• Introduction
• Best Practice Guide - Initial Resident Data Synchronisation (Migration)
• Best Practice Guide - Event-Based Resident Synchronisation
• Best Practice Guide - Update Stamp Based Resident Synchronisation
• Best Practice Guide - The "process resident" function

Integration Endpoints

• Introduction
• Integration Endpoints - Ending an Admission
• Integration Endpoints - Archiving and Restoring a Resident
• Integration Endpoints - Updating Avatars
• Integration Endpoints - Soft Matching

Managing PainChek Assessments

• "Body Domain" Assessment Object
• "Activity Domain" Assessment Object
• "Behaviour Domain" Assessment Object
• "Movement Domain" Assessment Object
• "Voice Domain" Assessment Object
• "Face Domain" Assessment Object

See all 9 articles

Managing NRS Assessments

• Managing NRS Assessments
• "NRS Assessment" Assessment object
• "NRS Device" Assessment Object

Managing Patients

• Finding Existing Patients
• Managing Patients
• Archive a Patient
• Managing Admissions
• Patient Avatars

Analytics API

• Introduction
• Analytics Reporting Partition Generation Algorithm
• Analytics Endpoint 'general' Metric Pool
• Analytics Endpoint 'followup' Metric Pool
• Analytics Endpoint 'descriptor' Metric Pool
• Analytics Endpoint 'residents assessed' Metric Pool

See all 13 articles

Managing Others

• Managing Devices
• Managing Licenses
• Managing Users
• Managing Sites
• Managing Access to Sites for a User
• Finding Existing Sites

See all 7 articles

Other

• Sample Integration Code
• Success and Failure Return Data
• Using External Ids
• Syncing Data with the API
• Pagination
• Filtering Lists