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

Canvas Medical Practitioner API

Healthcare provider information

Canvas Medical Practitioner API is one of 30 APIs that Canvas Medical publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Practitioner. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.0.3, at version 4.0.

Requests are made against a single base URL, https://fumage-{canvas-instance}.canvasmedical.com.

2 operations 2 paths 13 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.0
Base URL
https://{canvas-instance}/api/
Authentication
OAuth 2.0, OAuth 2.0, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 3

Canvas Medical Practitioner API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 8 scopes. It supports OAuth 2.0 (OAuth2AuthCode) using the authorizationCode flow, exposing 3 scopes. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • OAuth2ClientCredentials — Machine-to-machine authentication using client credentials grant. Obtain clientid and clientsecret from Canvas admin panel.
  • OAuth2AuthCode — User-delegated access using Authorization Code flow with SMART on FHIR scopes.

Paths & Operations 2

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

Practitioner 2

Healthcare provider information

GET
/Practitioner
Search Practitioners
searchPractitioner 4 params → 200401
GET
/Practitioner/{id}
Read Practitioner
readPractitioner 1 param → 200401404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Address (9 properties), HumanName (6 properties), Bundle (6 properties), Coding (5 properties). Each schema is shown below with its type and property counts.

Practitioner
FHIRResource
object
Base FHIR R4 resource properties
4 properties
CodeableConcept
object
2 properties
Bundle
object
6 properties
Address
object
9 properties
Period
object
2 properties
ContactPoint
object
3 properties
Narrative
object
2 properties
OperationOutcome
object
2 properties
Meta
object
5 properties
Identifier
object
5 properties
Coding
object
5 properties
HumanName
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canvas-medical-practitioner-api-openapi.yml Raw ↑

Other APIs Canvas Medical publishes across the network.

Canvas Medical FHIR API
Canvas Medical SDK
Canvas Medical AllergyIntolerance API
Canvas Medical Appointment API
Canvas Medical CarePlan API
Canvas Medical CareTeam API
Canvas Medical Claim API
Canvas Medical Communication API
Canvas Medical Condition API
Canvas Medical Consent API
Canvas Medical Coverage API
Canvas Medical DiagnosticReport API