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 Immunization API

Immunization records

Canvas Medical Immunization 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 Immunization. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 9 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.

4 operations 2 paths 9 schemas 2 GET1 POST1 PUT

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 Immunization 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 4

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

Immunization 4

Immunization records

GET
/Immunization
Search Immunizations
searchImmunization 5 params → 200401
POST
/Immunization
Create Immunization
createImmunization body → 201401422
GET
/Immunization/{id}
Read Immunization
readImmunization 1 param → 200401404
PUT
/Immunization/{id}
Update Immunization
updateImmunization 1 param body → 200401404

Schemas 9

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

FHIRResource
object
Base FHIR R4 resource properties
4 properties
CodeableConcept
object
2 properties
Bundle
object
6 properties
Immunization
Narrative
object
2 properties
OperationOutcome
object
2 properties
Meta
object
5 properties
Coding
object
5 properties
Reference
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canvas-medical-immunization-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