AlayaCare · Schema
AlayaCare Careplan API Schemas
Home CareCommunity CareHealthcareSchedulingClinicalBillingClient ManagementCare ManagementAged CareWorkforce Management
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AlayaCare Careplan API Schemas",
"definitions": {
"VisitGoalList": {
"description": "A list of visit goals",
"type": "array",
"items": {
"$ref": "#/definitions/VisitGoalDetails"
}
},
"VisitGoalDetails": {
"description": "The visit goal details. The visit goal will be uniquely identified using the `visit_id` and the `goal_id`.",
"type": "object",
"required": [
"completed",
"created_at",
"created_by",
"goal",
"visit_id",
"updated_at",
"updated_by"
],
"properties": {
"completed": {
"description": "Whether the goal was completed during the course of the visit",
"type": "boolean",
"example": true
},
"progress_percentage": {
"description": "Completion percentage of the goal at the end of the visit",
"type": "integer",
"example": 40
},
"progress_type": {
"description": "none, percentage, per_visit",
"type": "string",
"example": "per_visit"
},
"comment": {
"description": "Comment related to goal progress in the visit",
"type": "string",
"example": "He walks better now"
},
"created_at": {
"description": "Entity created date-time.",
"type": "string",
"example": "2018-01-01T23:56:13+00:00"
},
"created_by": {
"$ref": "#/definitions/User"
},
"goal": {
"$ref": "#/definitions/CarePlanGoal"
},
"visit_id": {
"description": "Visit ID",
"type": "integer",
"example": 100
},
"work_session_uuid": {
"description": "Work session UUID",
"type": "string",
"example": "81de946c-45d2-11e9-b210-d663bd873d93"
},
"updated_at": {
"description": "Entity last updated date-time.",
"type": "string",
"format": "date-time",
"example": "2018-01-23T23:56:13+00:00"
},
"updated_by": {
"$ref": "#/definitions/User"
}
}
},
"VisitGoalUpdate": {
"description": "Update a visit goal.",
"type": "object",
"required": [
"goal_id",
"visit_id"
],
"properties": {
"goal_id": {
"description": "Care Plan Goal ID",
"type": "integer",
"example": 100
},
"visit_id": {
"description": "Visit ID",
"type": "integer",
"example": 100
},
"comment": {
"description": "A comment to be provided if the goal was not completed.",
"type": "string",
"example": "Unable to complete the goal today"
},
"completed": {
"description": "Whether the goal was completed.",
"type": "boolean",
"example": true,
"default": false
},
"progress_percentage": {
"description": "Goal progress if the tracking method is `percentage`, between 0 and 100.",
"type": "integer",
"example": 50
}
}
},
"ItemSummaryList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Some name"
}
}
}
},
"CareplanItemSummaryList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "diagnosis"
},
"name": {
"type": "string",
"example": "Some name"
}
}
}
},
"DepartmentChangeList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"revision": {
"type": "integer",
"example": 2
},
"changes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Department of Justice"
}
}
}
}
}
},
"ServiceChangeList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"revision": {
"type": "integer",
"example": 2
},
"changes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "bath"
}
}
}
}
}
},
"CarePlanList": {
"allOf": [
{
"$ref": "#/definitions/PaginatedList"
}
],
"description": "A list of Care Plans",
"type": "object",
"properties": {
"total_pages": {
"description": "Totalnumber of pages available",
"type": "integer",
"example": 10
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/CarePlanSummary"
}
}
}
},
"CarePlanSummary": {
"description": "Describe care plan without inner objects (diagnoses, goals, etc)",
"type": "object",
"properties": {
"id": {
"description": "Care PlanID",
"type": "integer",
"example": 100
},
"created_at": {
"description": "Care plan creation date (ISO date format)",
"type": "string",
"example": "2018-01-01T23:56:13+00:00"
},
"updated_at": {
"description": "Last Careplan updated date (ISO date format)",
"type": "string",
"example": "2018-01-23T23:56:13+00:00"
},
"status": {
"$ref": "#/definitions/CareplanStatus"
},
"name": {
"description": "The title of care plan",
"type": "string",
"example": "Test care plan"
},
"start_date": {
"description": "The start date of the care plan",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "The end date of the care plan",
"type": "string",
"example": "2018-01-10"
},
"client": {
"description": "The client details",
"$ref": "#/definitions/ClientDetails"
},
"created_by": {
"description": "Alayacare user that created the care plan",
"$ref": "#/definitions/User"
},
"updated_by": {
"description": "Alayacare user that last modified the care plan",
"$ref": "#/definitions/User"
},
"completed_at": {
"description": "Careplan completion datetime (ISO date format)",
"type": "string",
"example": "2017-12-20T23:56:13+00:00",
"x-nullable": true
},
"completed_by": {
"description": "Alayacare user that completed the care plan",
"$ref": "#/definitions/User",
"x-nullable": true
}
}
},
"CarePlanCreate": {
"description": "Create a Care Plan",
"type": "object",
"required": [
"name",
"start_date"
],
"properties": {
"name": {
"description": "The title of the care plan",
"type": "string",
"example": "Test care plan"
},
"start_date": {
"description": "The start date of the care plan",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "The end date of the care plan",
"type": "string",
"example": "2018-01-10"
}
}
},
"CarePlanUpdate": {
"description": "Create a Care Plan",
"type": "object",
"properties": {
"name": {
"description": "The title of care plan",
"type": "string",
"example": "Test care plan"
},
"start_date": {
"description": "A start date of care plan",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "A end date of care plan",
"type": "string",
"example": "2018-01-10"
}
}
},
"CarePlanDetails": {
"description": "Care plan including all root items (`diagnoses`, `goals`, `interventions`)",
"type": "object",
"properties": {
"id": {
"description": "Care Plan ID",
"type": "integer",
"example": 100
},
"created_at": {
"description": "Date of care plan creation (ISO Date format)",
"type": "string",
"example": "2018-01-01T23:56:13+00:00"
},
"updated_at": {
"description": "Date of the last update thi care plan (ISO Date format)",
"type": "string",
"example": "2018-01-23T23:56:13+00:00"
},
"status": {
"$ref": "#/definitions/CareplanStatus"
},
"name": {
"description": "The title of care plan",
"type": "string",
"example": "Test care plan"
},
"start_date": {
"description": "A start date of care plan",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "A end date of care plan",
"type": "string",
"example": "2018-01-10"
},
"client": {
"description": "The client details",
"$ref": "#/definitions/ClientDetails"
},
"diagnoses": {
"description": "The list of diagnoses in the care plan",
"type": "array",
"items": {
"$ref": "#/definitions/CarePlanDiagnosis"
}
},
"goals": {
"description": "The list of goals in the care plan",
"type": "array",
"items": {
"$ref": "#/definitions/CarePlanGoal"
}
},
"interventions": {
"description": "the list of interventions in the care plan",
"type": "array",
"items": {
"$ref": "#/definitions/Intervention"
}
},
"created_by": {
"description": "User that create this plan",
"$ref": "#/definitions/User"
},
"updated_by": {
"description": "User that modified this plan",
"$ref": "#/definitions/User"
},
"completed_at": {
"description": "Datetime when the diagnosis was completed",
"type": "string",
"example": "2017-12-20T23:56:13+00:00",
"x-nullable": true
},
"completed_by": {
"$ref": "#/definitions/User",
"x-nullable": true
}
}
},
"CarePlanTags": {
"allOf": [
{
"$ref": "#/definitions/PaginatedList"
}
],
"description": "Paginated list of care plan tags",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/CarePlanTagList"
}
}
}
},
"CarePlanTagList": {
"description": "List of care plan tags",
"type": "object",
"properties": {
"id": {
"description": "Tag ID",
"type": "integer",
"example": 2
},
"name": {
"description": "Tag name",
"type": "string",
"example": "Review care plan"
}
}
},
"CarePlanDiagnosis": {
"description": "Care plan diagnosis",
"type": "object",
"properties": {
"id": {
"description": "Care Plan Diagnosis ID",
"type": "integer",
"example": 100
},
"plan_id": {
"description": "Care Plan ID",
"type": "integer",
"example": 345
},
"plan_name": {
"description": "Care plan name",
"type": "string",
"example": "Episode #4"
},
"name": {
"description": "A title of care plan diagnosis",
"type": "string",
"example": "Title example"
},
"start_date": {
"description": "A start date of diagnosis",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "A end date of diagnosis",
"type": "string",
"example": "2018-01-10"
},
"description": {
"description": "A description of care plan diagnosis",
"type": "string",
"example": "Description of diagnosis"
},
"is_primary": {
"description": "Define that this diagnosis is primary",
"type": "boolean",
"example": true
},
"rank": {
"description": "Used for ordering of diagnoses in list. The smaller, the higher ranked will the diagnosis be returned",
"type": "integer",
"example": 0
},
"status": {
"$ref": "#/definitions/CareplanItemStatus"
},
"department": {
"$ref": "#/definitions/EntitySummary"
},
"updated_at": {
"description": "Datetime for the last update of the diagnosis",
"type": "string",
"example": "2018-01-23T23:56:13+00:00"
},
"updated_by": {
"$ref": "#/definitions/User"
},
"created_at": {
"description": "Datetime of the creation of the diagnosis",
"type": "string",
"example": "2017-12-20T23:56:13+00:00"
},
"created_by": {
"$ref": "#/definitions/User"
},
"completed_at": {
"description": "Datetime when the diagnosis was completed",
"type": "string",
"example": "2017-12-20T23:56:13+00:00",
"x-nullable": true
},
"completed_by": {
"$ref": "#/definitions/User",
"x-nullable": true
},
"completion_note": {
"description": "Completion note of the diagnosis",
"type": "string",
"x-nullable": true
},
"service": {
"description": "The list of services that are linked to a diagnosis",
"$ref": "#/definitions/ServiceList"
},
"tag": {
"description": "The list of tags that are linked to a diagnosis",
"$ref": "#/definitions/EntitySummaryList"
}
}
},
"ClientDiagnosis": {
"description": "Care plan diagnosis",
"type": "object",
"properties": {
"id": {
"description": "Care Plan Diagnosis ID",
"type": "integer",
"example": 100
},
"name": {
"description": "A title of care plan diagnosis",
"type": "string",
"example": "Diabetes"
},
"plan_id": {
"description": "Care Plan ID",
"type": "integer",
"example": 345
},
"plan_name": {
"description": "Care plan name",
"type": "string",
"example": "Episode #4"
},
"start_date": {
"description": "A start date of diagnosis",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "A end date of diagnosis",
"type": "string",
"example": "2018-01-10"
},
"description": {
"description": "A description of care plan diagnosis",
"type": "string",
"example": "Description of diagnosis"
},
"is_primary": {
"description": "Define that this diagnosis is primary",
"type": "boolean",
"example": true
},
"rank": {
"description": "Used for ordering of diagnoses in list. The smaller, the higher ranked will the diagnosis be returned",
"type": "integer",
"example": 0
},
"status": {
"$ref": "#/definitions/CareplanItemStatus"
},
"department": {
"$ref": "#/definitions/EntitySummary"
},
"updated_at": {
"description": "Datetime for the last update for this diagnosis",
"type": "string",
"example": "2018-01-23T23:56:13+00:00"
},
"updated_by": {
"$ref": "#/definitions/User"
},
"created_at": {
"description": "Datetime for the creation of this diagnosis",
"type": "string",
"example": "2017-12-20T23:56:13+00:00"
},
"created_by": {
"$ref": "#/definitions/User"
},
"completed_at": {
"description": "Datetime when the diagnosis was completed",
"type": "string",
"example": "2017-12-20T23:56:13+00:00",
"x-nullable": true
},
"completed_by": {
"$ref": "#/definitions/User",
"x-nullable": true
},
"completion_note": {
"description": "Completion note of the diagnosis",
"type": "string",
"x-nullable": true
},
"services": {
"description": "The list of services that are linked to created diagnosis",
"$ref": "#/definitions/EntitySummaryList"
},
"tags": {
"description": "The list of tags that are linked to created diagnosis",
"$ref": "#/definitions/EntitySummaryList"
}
}
},
"CreateCarePlanDiagnosis": {
"description": "JSON schema for creating care plan diagnosis.",
"type": "object",
"required": [
"name",
"start_date",
"is_primary"
],
"properties": {
"name": {
"description": "A title of care plan diagnosis",
"type": "string",
"example": "Title example"
},
"start_date": {
"description": "A start date of diagnosis",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "A end date of diagnosis",
"type": "string",
"example": "2018-01-10"
},
"description": {
"description": "A description of care plan diagnosis",
"type": "string",
"example": "Description of diagnose"
},
"is_primary": {
"description": "Define that this diagnosis is primary",
"type": "boolean",
"example": true
},
"department_id": {
"description": "The ID of selected department",
"type": "integer",
"example": 1
},
"service_ids": {
"description": "The list of service ID's that is linked to created diagnosis.Only services assigned to the client can be linked to the diagnosis.",
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
4,
6
]
},
"external_service_ids": {
"description": "The list of external service external ID's that is linked to a diagnosis. Only services assigned to the client can be linked to the diagnosis.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"sor_service_id_1",
"sor_service_id_2",
"sor_service_id_3"
]
},
"tag_ids": {
"description": "The list of tag ID's that is linked to created diagnosis",
"type": "array",
"items": {
"type": "integer"
},
"example": [
2,
4,
8
]
}
}
},
"UpdateCarePlanDiagnosis": {
"description": "JSON schema for creating care plan diagnosis",
"type": "object",
"properties": {
"name": {
"description": "Title of the care plan diagnosis",
"type": "string",
"example": "Title example"
},
"start_date": {
"description": "Start date of the diagnosis",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "End date of the diagnosis",
"type": "string",
"example": "2018-01-10"
},
"description": {
"description": "Description of the care plan diagnosis",
"type": "string",
"example": "Description of diagnosis"
},
"is_primary": {
"description": "Define that this diagnosis is primary",
"type": "boolean",
"example": true
},
"department_id": {
"description": "The ID of selected department",
"type": "integer",
"example": 1,
"x-nullable": true
},
"service_ids": {
"description": "The list of service ID's that is linked to created diagnosis.Only services assigned to the client can be linked to the diagnosis.",
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
4,
6
]
},
"external_service_ids": {
"description": "The list of external service external ID's that is linked to a diagnosis. Only services assigned to the client can be linked to the diagnosis.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"sor_service_id_1",
"sor_service_id_2",
"sor_service_id_3"
]
},
"tag_ids": {
"description": "The list of tag ID's that is linked to created diagnosis",
"type": "array",
"items": {
"type": "integer"
},
"example": [
2,
4,
8
]
}
}
},
"CarePlanGoal": {
"description": "Care plan goal",
"type": "object",
"properties": {
"id": {
"description": "Care Plan Goal ID",
"type": "integer",
"example": 100
},
"plan_id": {
"description": "Care Plan ID",
"type": "integer",
"example": 345
},
"plan_name": {
"description": "Care plan name",
"type": "string",
"example": "Episode #4"
},
"name": {
"description": "A title of care plan goal",
"type": "string",
"example": "Title example"
},
"start_date": {
"description": "A start date of goal",
"type": "string",
"example": "2018-01-10"
},
"target_end_date": {
"description": "A end date of goal",
"type": "string",
"example": "2018-01-10"
},
"description": {
"description": "A description of care plan goal",
"type": "string",
"example": "Description of goal"
},
"is_primary": {
"description": "Define that this goal is primary",
"type": "boolean",
"example": true
},
"rank": {
"description": "Used for ordering of goals in the list. The smaller, the higher ranked will the diagnosis be returned.",
"type": "integer",
"example": 0
},
"department": {
"$ref": "#/definitions/EntitySummary"
},
"type": {
"type": "string",
"description": "Goal Type",
"example": "Desires/Motivations"
},
"progress_type": {
"$ref": "#/definitions/GoalMethod"
},
"last_updated_progress": {
"$ref": "#/definitions/GoalProgress"
},
"status": {
"$ref": "#/definitions/CareplanItemStatus"
},
"services": {
"description": "The list of services that are linked to the goal",
"$ref": "#/definitions/ServiceList"
},
"tags": {
"description": "The list of tags that are linked to the goal",
"$ref": "#/definitions/EntitySummaryList"
},
"diagnoses": {
"description": "The list of diagnoses that are linked to the goal",
"$ref": "#/definitions/EntitySummaryList"
},
"updated_at": {
"description": "Datetime for the last update for this goal",
"type": "string",
"example": "2018-01-23T23:56:13+00:00"
},
"updated_by": {
"$ref": "#/definitions/User"
},
"created_at": {
"description": "Datetime for the creation of this goal",
"type": "string",
"example": "2017-12-20T23:56:13+00:00"
},
"created_by": {
"$ref": "#/definitions/User"
},
"completed_at": {
"description": "Datetime when the goal was completed",
"type": "string",
"example": "2017-12-20T23:56:13+00:00",
"x-nullable": true
},
"completed_by": {
"$ref": "#/definitions/User",
"x-nullable": true
},
"completion_note": {
"description": "Completion note of the goal",
"type": "string",
"x-nullable": true
}
}
},
"CreateCarePlanGoal": {
"description": "JSON schema for creating care plan goal",
"type": "object",
"required": [
"name",
"start_date",
"type",
"progress_type",
"department_id",
"is_primary"
],
"properties": {
"name": {
"description": "Title of the care plan goal",
"type": "string",
"example": "Example goal"
},
"start_date": {
"description": "Start date of the goal",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "End date of the goal",
"type": "string",
"example": "2018-01-10"
},
"description": {
"description": "Description of the care plan goal",
"type": "string",
"example": "Description of goal"
},
"is_primary": {
"description": "Define that this goal is primary",
"type": "boolean",
"example": true
},
"type": {
"type": "string",
"description": "Goal Type",
"example": "Desires/Motivations"
},
"progress_type": {
"$ref": "#/definitions/GoalMethod"
},
"department_id": {
"description": "The ID of selected department",
"type": "integer",
"example": 1,
"x-nullable": true
},
"service_ids": {
"description": "The list of service ID's that is linked to created diagnosis.Only services assigned to the client can be linked to the diagnosis.",
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
4,
6
]
},
"external_service_ids": {
"description": "The list of service external ID's that is linked to a diagnosis. Only services assigned to the client can be linked to the diagnosis.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"sor_service_id_1",
"sor_service_id_2",
"sor_service_id_3"
]
},
"tag_ids": {
"description": "The list of tag ID's that is linked to created diagnosis",
"type": "array",
"items": {
"type": "integer"
},
"example": [
2,
4,
8
]
},
"diagnosis_ids": {
"description": "The list of diagnosis ID that is linked to created goal. Only giagnoses available in the careplan can be assigned to the goal.",
"type": "array",
"items": {
"type": "integer"
},
"example": [
2,
4,
8
]
}
}
},
"UpdateCarePlanGoal": {
"description": "JSON schema for creating care plan diagnosis",
"type": "object",
"properties": {
"name": {
"description": "A title of care plan goal",
"type": "string",
"example": "Example goal"
},
"start_date": {
"description": "A start date of goal",
"type": "string",
"example": "2018-01-10"
},
"end_date": {
"description": "A end date of goal",
"type": "string",
"example": "2018-01-10"
},
"description": {
"description": "A description of care plan goal",
"type": "string",
"example": "Description of goal"
},
"is_primary": {
"description": "Define that this goal is primary",
"type": "boolean",
"example": true
},
"rank": {
"description": "Used for ordering of goals in list. The smaller, the higher. Can be the number of place in the list of goals in care plan",
"type": "integer",
"example": 0
},
"type": {
"$ref": "#/definitions/GoalType"
},
"progress_type": {
"$ref": "#/definitions/GoalMethod"
},
"department_id": {
"description": "The ID of selected department",
"type": "integer",
"example": 1,
"x-nullable": true
},
"service_ids": {
"description": "The list of service ID's that is linked to created diagnosis.Only services assigned to the client can be linked to the diagnosis.",
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
4,
6
]
},
"tag_ids": {
"description": "The list of tag ID's that is linked to created diagnosis",
"type": "array",
"items": {
"type": "integer"
},
"example": [
2,
4,
8
]
},
"diagnosis_ids": {
"description": "The list of diagnosis IDs that is linked to created goal. ",
"type": "array",
"items": {
"type": "integer"
},
"example": [
2,
4,
8
]
}
}
},
"User": {
"description": "User id, first and last names",
"type": "object",
"properties": {
"id": {
"description": "The id of user",
"type": "integer",
"example": 5
},
"external_id": {
"description": "The id of user",
"type": "string",
"example": "sor_external_id_1"
}
}
},
"Service": {
"description": "Service for Care Plan items",
"type": "object",
"properties": {
"id": {
"description": "The ID of service",
"type": "integer",
"example": 1
},
"name": {
"description": "The title of service",
"type": "string",
"example": "Service 1"
}
}
},
"Tag": {
"description": "Tag for Care Plan items",
"type": "object",
"properties": {
"id": {
"description": "The ID of tag",
"type": "integer",
"example": 1
},
"name": {
"description": "The tag of service",
"type": "string",
"example": "Tag 1"
}
}
},
"GoalTypeList": {
"description": "List of goal types",
"type": "object",
"properties": {
"items": {
"type
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/api-evangelist-alayacare/refs/heads/main/json-schema/alayacare-careplan-schema.json