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 referral outbox API

The referral outbox API from AlayaCare — 4 operation(s) for referral outbox.

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

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

This API exposes 5 operations across 4 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.{env}.alayamarket.{region}/offers.

5 operations 4 paths 43 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

AlayaCare referral outbox API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (CognitoAuthorizer). By default, every request must be authenticated.

Paths & Operations 5

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

referral outbox 5
POST
/v1/outbox/referrals
Authorization Required role: orgadmin Description Create a Referral by the Demand organization.
body → 201
GET
/v1/outbox/referrals
Authorization Required role: orgadmin Description Get a collection of Referrals created by the Demand organization.
16 params → 200
GET
/v1/outbox/referrals/{referral_id}
Authorization Required role: orgadmin Description Get the details of a Referral created by the Demand organization.
1 param → 200
POST
/v1/outbox/referrals/{referral_id}/cancel
Authorization Required role: orgadmin Description Cancel a Referral created by the Demand Organization. A Referral can only be Cancelled if the status is assigned or processed.
1 param body → 204
POST
/v1/outbox/referrals/{referral_id}/update
Authorization Required role: orgadmin Description Update a Referral created by the Demand Organization. A Referral can only be updated if It's of type: service, and It's the latest revision, and Its…
1 param body → 201

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are AuthorizationCore (24 properties), FormTemplateCore (17 properties), CarePlanInterventionCore (15 properties), CarePlanGoalCore (12 properties). Each schema is shown below with its type and property counts.

OutboxCarePlanDiagnosisCore
CareTypeCore
string
ReferralReasonCodeCore
object
reasoncode associated to a cancelled or closed referral.
1 property
OutboxReferralClientResponse
OutboxReferralCollectionResponse
object
API response of an referral on the outbox API.
6 properties 5 required
PriceCore
object
2 properties 2 required
OutboxReferralPageResponse
CarePlanInterventionCore
object
15 properties 8 required
PageNumberCore
integer
OutboxReferralCore
OutboxReferralVisitResponse
object
6 properties 3 required
CaseManagerCore
object
4 properties
OutboxFormTemplateCore
OutboxReferralCancelRequest
AuthorizationCore
object
24 properties 4 required
OutboxReferralUpdateRequest
object
9 properties 5 required
CarePlanGoalCore
object
12 properties 5 required
OutboxCarePlanInterventionCore
PageCore
object
Root page schema for returning collections.
4 properties 4 required
CustomFieldCore
object
3 properties 2 required
AllergyCore
object
5 properties
SortOrderCore
string
OutboxReferralDetailResponse
OutboxReferralVisitRequest
object
5 properties 3 required
OutboxReferralVisitTaskRequest
object
4 properties 3 required
DemographicLeanCore
object
2 properties 2 required
ClientCore
object
8 properties 2 required
OutboxAlayaCareCore
object
3 properties
ReferralStatusCore
string
ItemsPerPageCore
integer
OutboxCarePlanGoalCore
OutboxReferralClientRequest
OutboxReferralVisitTaskResponse
object
5 properties 4 required
OutboxCarePlanCore
object
9 properties 3 required
CarePlanDiagnosisCore
object
9 properties 3 required
FormTemplateCore
object
17 properties 15 required
OutboxReferralCreateRequest
object
8 properties 4 required
RiskCore
object
4 properties
ReferralRevisionResponse
object
5 properties 3 required
ReferralTypeCore
string
FormTemplateFieldCore
object
10 properties 6 required
OrganizationLeanCore
object
2 properties 2 required
AddressCore
object
9 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-referral-outbox-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 referral outbox 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.