JAjane
CarePlans

Create a care plan

Changed on

Create a care plan

post/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:create

Request body

Response

The care plan was created

idstring uuid

UUIDv7 identifier for the care plan

patient_idstring uuid required

Reference to the patient

practitioner_idstring uuid

Reference to the practitioner who performed/recorded the observation

encounter_idstring uuid

Reference to the encounter where the care plan was made

category'treatment_plan' required

The classification of the type of care plan

titlestring

The title of the care plan

descriptionstring

The description of the care plan

status'draft' | 'active' | 'on-hold' | 'revoked' | 'completed' | 'entered-in-error' | 'unknown'

The status of the care plan

created_atstring date-time

When the care plan record was created

updated_atstring date-time

When the care plan record was updated

document_idsstring[]

Array of document upload IDs to attach to the care plan. All documents must exist and be verified.

Changes

  • 01798f613a5eRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      the request optional property / became write-only

    • info

      added the non-success response with the status

    • info

      added the non-success 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