How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AlayaCare Care plan API

The Care plan API from AlayaCare — 10 operation(s) for care plan.

AlayaCare Care plan API is one of 113 APIs that AlayaCare publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CarePlan. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 10 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.2.

Requests are made against a single base URL, https://homecare.alayacare.ca/ext/api/v2/clinical.

13 operations 10 paths 23 schemas 7 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.2
Base URL
https://[tenant].[environment].alayacare.[domain]/ext/api/v2/patients/
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

AlayaCare Care plan API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth).

  • basic_auth — Basic HTTP auth over https

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 7 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Care plan 13
GET
/client/{client_id}/careplans
Get a list of care plan base information using the client Alayacare ID
11 params → 200401403404
POST
/client/{client_id}/careplans
Create a care plan using the client Alayacare ID
1 param body → 201400401403404
GET
/client/by_id/{external_client_id}/careplans
Get a list of care plan base information using the client external ID
11 params → 200401403404
POST
/client/by_id/{external_client_id}/careplans
Create a care plan using the client external ID
1 param body → 201400401403404
GET
/client/{client_id}/careplans/activedeprecated
Get the detailed information of the active care plan using Alayacare client ID
9 params → 200401403404
GET
/client/{client_id}/careplans/currently-active
Get the detailed information of the active care plan using Alayacare client ID
9 params → 200204401403
GET
/client/by_id/{external_client_id}/careplans/activedeprecated
Get the detailed information of the active care plan using client external ID
9 params → 200401403404
GET
/client/by_id/{external_client_id}/careplans/currently-active
Get the detailed information of the active care plan using client external ID
9 params → 200204401403
GET
/careplans/{plan_id}
Get detailed information about a care plan using the care plan ID
9 params → 200401403404
PUT
/careplans/{plan_id}
Update care plan base information using the care plan ID
1 param body → 204400401403404
PUT
/careplans/{plan_id}/status/active
Change status of care plan to active using the care plan ID
1 param → 204400401403404
PUT
/careplans/{plan_id}/status/archived
Change status of care plan to archived using the care plan ID
1 param → 204400401403404
PUT
/careplans/{plan_id}/status/completed
Change status of care plan to completed using the care plan ID
1 param body → 204400401403404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Intervention (28 properties), CarePlanGoal (24 properties), CarePlanDiagnosis (20 properties), CarePlanDetails (15 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error response
2 properties 2 required
CarePlanList
object
A list of Care Plans
2 properties
InterventionModule
object
Alayacare module attached to care plan intervention. If not set no alayacare module will be linked to the intervention.
2 properties
EntitySummaryList
array
GoalProgress
object
Goal progress information
3 properties
CarePlanCreate
object
Create a Care Plan
3 properties 2 required
ExternalLink
object
2 properties 2 required
EntitySummary
object
2 properties 2 required
CarePlanDiagnosis
object
Care plan diagnosis
20 properties
ServiceList
array
CarePlanUpdate
object
Create a Care Plan
3 properties
ServiceDetails
objectnull
Service details
2 properties
CarePlanGoal
object
Care plan goal
24 properties
CarePlanDetails
object
Care plan including all root items (diagnoses, goals, interventions)
15 properties
PaginatedList
object
Base model of all paginated lists
3 properties 4 required
ClientDetails
objectnull
Careplan client details
3 properties
User
object
User id, first and last names
2 properties
GoalMethod
string
Progress tracking method of goal
Intervention
object
Careplan intervention
28 properties 17 required
CareplanItemStatus
string
CarePlanSummary
object
Describe care plan without inner objects (diagnoses, goals, etc)
12 properties
CareplanStatus
string
DeconstructedFrequency
object
Definition of the intervention frequency. - Is only required if recurrencetype is set to custom - availablefrom and availableto allow to define the Time of day…
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-care-plan-api-openapi.yml Raw ↑

Other APIs AlayaCare publishes across the network.

AlayaCare Employee API
AlayaCare Scheduler API
AlayaCare Clinical API
AlayaCare Tasks API
AlayaCare Forms API
AlayaCare Accounting API
AlayaCare Medication API
AlayaMarket Marketplace API
AlayaCare Residential (Resi) API
AlayaCare Accounts API
AlayaCare Activities of Daily Living (ADL) API
AlayaCare Activity Codes API
Where this information came from

This is an independent, third-party profile of AlayaCare Care plan API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.