Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
version: 1.0.2
title: Care Plan 2.0 Tags API
description: "External Clinical API\n\n**Internal IDs**\nThe following terms are used to reference IDs that identify resources in AlayaCare:\n- id\n- created_by\n- client_id\n- employee_id\n- plan_id\n- diagnosis_id\n- goal_id\n- intervention_id\n\n\n**External IDs**\nThe following terms are used to reference IDs that identify resources systems external to AlayaCare:\n- external_employee_id\n- external_client_id\n- external_service_id\n\nExternal IDs are required to be unique.\nNo other assumptions are made regarding their format they are treated as strings.\n\n**Remarks**\n- All dates must be in ISO 8601 format.\n- Required fields marked with `*` cannot be null.\n \n"
servers:
- url: https://homecare.alayacare.ca/ext/api/v2/clinical
tags:
- name: Tags
paths:
/careplans/tags:
get:
tags:
- Tags
summary: Get a list of all care plan tags
description: "- Care plan tags are configured \n"
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/count'
responses:
'200':
description: The list of care plan tags
content:
application/json:
schema:
$ref: '#/components/schemas/CarePlanTags'
'401':
$ref: '#/components/responses/AuthChallenge'
'403':
$ref: '#/components/responses/ErrorInsufficientAccess'
'404':
$ref: '#/components/responses/ErrorResponseInvalidTagId'
components:
schemas:
ErrorResponse:
description: Error response
type: object
properties:
status_code:
type: integer
description: Response code
message:
type: string
description: Detailed error message
required:
- code
- message
CarePlanTags:
allOf:
- $ref: '#/components/schemas/PaginatedList'
description: Paginated list of care plan tags
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/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
PaginatedList:
description: Base model of all paginated lists
type: object
properties:
count:
type: integer
description: Number of items in the response
example: 1
page:
type: integer
description: Current page number
example: 1
total_pages:
type: integer
description: Total number of pages availbale
example: 1
required:
- count
- page
- total_pages
- items
responses:
ErrorResponseInvalidTagId:
description: Field 'tag_id' is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
status_code: 404
message: Field 'tag_id' is invalid
AuthChallenge:
description: Authentication required.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
status_code: 401
message: Please verify your access level for this url.
ErrorInsufficientAccess:
description: You do not have the required permissions to perform this action
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
status_code: 403
message: Access required
parameters:
page:
description: Filter by page number.
name: page
in: query
required: false
schema:
type: integer
default: 1
count:
description: Number of items per page.
name: count
in: query
required: false
schema:
type: integer
default: 100
securitySchemes:
basic_auth:
type: http
scheme: basic
description: Basic HTTP auth over https