Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CareAcademy Practitioners API

The Practitioners API from CareAcademy — 2 operation(s) for practitioners.

CareAcademy Practitioners API is one of 5 APIs that CareAcademy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 1.0.10.

Requests are made against a single base URL, https://staging.careacademy.com/api/v1.

2 operations 2 paths 5 schemas 1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.10
Base URL
https://go.careacademy.com/api/v1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

CareAcademy Practitioners API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Practitioners 2
POST
/practitioners
Creates a practitioner. If a practitioner already exists within CareAcademy but has not been linked yet to the integration, this will do so by setting integrationId for the first time with this call.
body → 201400401403
PUT
/practitioners/{integrationId}
Updates a practitioner.
1 param body → 200400401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are PractitionerResponse (15 properties), Practitioner (12 properties), HumanName (4 properties), ContactPoint (2 properties). Each schema is shown below with its type and property counts.

Practitioner
object
12 properties
PractitionerResponse
object
15 properties
HumanName
object
The name of the practitioner. Further documentation here: https://www.hl7.org/fhir/datatypes.htmlhumanname
4 properties 3 required
ContactPoint
object
The mobile phone number and email address of the practitioner. Further documentation here: https://www.hl7.org/fhir/datatypes.htmlContactPoint
2 properties 2 required
PractitionerWithRequiredFields
object
1 property 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

careacademy-practitioners-api-openapi.yml Raw ↑

Other APIs CareAcademy publishes across the network.

CareAcademy Compliance Report API
CareAcademy Locations API
CareAcademy Organizations API
CareAcademy Sign In Url API