JAjane
CarePlans

List care plans

Changed on

List medical record care plans for the current user's accessible patients.

get/api/2026-01-01/medical-record/care-plans

Request

  • Base URL
    https://jdpdocsdemo.jane.qa
  • URL
    https://jdpdocsdemo.jane.qa/api/2026-01-01/medical-record/care-plans
  • Auth
    OAuth 2
    Authorization code: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/auth?response_type=code&resource=https://jdpdocsdemo.jane.qa&prompt=consent
    Token URL: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/token scopes: care_plans:read

Query parameters

page[limit]integer

The number of records to return

page[cursor]string
Example:eyJwYWdlIjoyLCJzaXplIjo1fQ==

The Base64 encoded cursor to start the list from. Contains page and size information for pagination.

sortstring
Example:-created_at

Comma-separated sort fields. Prefix with - for descending order (e.g. -created_at). Allowed: created_at, updated_at

patient_id[eq]string uuid

Filter by patient public ID

category[eq]'treatment_plan'

Filter by category. Allowed values: treatment_plan

encounter_id[eq]string uuid

Filter by encounter public ID

Response

List of care plans

cursorstring nullable

Cursor for fetching the next page of results

limitinteger required

Maximum number of items returned

hasNextPageboolean required

Whether there are more items available

Changes

  • 01798f613a5eRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response optional property // became write-only for the status