AlayaCare Vital Metadata API
The Vital Metadata API from AlayaCare — 2 operation(s) for vital metadata.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/alayacare-vital-metadata-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 1.0.4
title: External Clinical Vital Metadata API
description: 'External Clinical API
**Internal IDs**
The following terms are used to reference IDs that identify resources in AlayaCare:
- id
- created_by
- client_id
- risk_id
- medication_id
- admin_id
- vital_id
**External IDs**
The following terms are used to reference IDs that identify resources systems external to AlayaCare:
- external_id
- external_client_id
External IDs are required to be unique.'
servers:
- url: https://homecare.alayacare.ca/ext/api/v2/clinical
tags:
- name: Vital Metadata
paths:
/vitals/client/{client_id}/metadata:
parameters:
- description: Client ID
name: client_id
in: path
required: true
schema:
type: integer
get:
tags:
- Vital Metadata
summary: Get a list of the metadata for a client's vitals by the client's AlayaCare ID
responses:
200:
description: Metadata details
content:
application/json:
schema:
$ref: '#/components/schemas/VitalMetadataList'
401:
$ref: '#/components/responses/AuthChallenge'
404:
$ref: '#/components/responses/NotFound'
operationId: getVitalsClientByClientIdMetadata
x-operation-id-source: derived
/vitals/client/by_id/{external_client_id}/metadata:
parameters:
- description: External client ID
name: external_client_id
in: path
required: true
schema:
type: string
get:
tags:
- Vital Metadata
summary: Get a list of the metadata for a client's vitals by the client's external ID
responses:
200:
description: Metadata details
content:
application/json:
schema:
$ref: '#/components/schemas/VitalMetadataList'
401:
$ref: '#/components/responses/AuthChallenge'
404:
$ref: '#/components/responses/NotFound'
operationId: getVitalsClientByIdByExternalClientIdMetadata
x-operation-id-source: derived
components:
responses:
NotFound:
description: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: 404
message: Progress note not found
AuthChallenge:
description: Authentication required.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: 401
message: Please verify your access level for this url.
schemas:
ErrorResponse:
description: Error response
type: object
properties:
code:
type: integer
description: Response code
message:
type: string
description: Detailed error message
required:
- code
- message
VitalMetadataList:
type: object
description: A list of vital metadata
required:
- metadata
properties:
metadata:
type: array
items:
$ref: '#/components/schemas/VitalMetadata'
VitalName:
type: string
description: The name identifying the vital type.
enum:
- blood_glucose
- bmi
- height
- pulse
- pressure_min
- pressure_max
- weight
- respiratory_rate
- spo2
- temperature
example: pressure_max
VitalMetadataOptions:
type: object
description: The metadata options available for the vital.
required:
- units
properties:
type:
type: string
description: The options type.
example: object
properties:
type: object
properties:
position:
type: object
properties:
enum:
type: array
description: The list of available options for the position.
items:
type: string
example:
- lying
- sitting
- standing
type:
type: string
description: The `enum` options type.
example: string
route:
type: object
properties:
enum:
type: array
description: The list of available options for the route.
items:
type: string
example:
- axillary
- oral
- rectal
- tympanic
type:
type: string
description: The `enum` options type.
example: string
units:
type: array
description: A list of units available for the vital.
items:
type: object
properties:
label:
type: string
description: The unit label.
example: mmHg
value:
type: string
description: The unit code.
example: mmhg
VitalMetadata:
type: object
description: Vital metadata
required:
- active
- label
- groups
- max
- min
- name
- options
- unit
properties:
active:
type: boolean
description: Whether the vital is active.
example: true
groups:
type: array
description: The groups to which the vital belongs. If no groups are set, this will be set to `name`.
items:
type: string
example: blood_pressure
label:
type: string
description: The vital label.
example: Systolic Blood pressure
max:
type: number
description: The maximum threshold for the vital.
example: 120
min:
type: number
description: The minimum threshold for the vital.
example: 60
name:
$ref: '#/components/schemas/VitalName'
options:
$ref: '#/components/schemas/VitalMetadataOptions'
unit:
type: string
description: The default unit used for the vital.
example: mmhg
securitySchemes:
basic_auth:
type: http
scheme: basic
description: Basic HTTP auth over https