Canvas Medical

Canvas Medical Document Reference API

Clinical documents and attachments

GitHub OpenAPI

Operations 3

GET /DocumentReference Search DocumentReferences #
POST /DocumentReference Create DocumentReference #
GET /DocumentReference/{id} Read DocumentReference #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/canvas-medical/openapi/canvas-medical-document-reference-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/canvas-medical/json-schema/canvas-medical-allergy-intolerance-schema.json
📊
JSONSchema
https://artifacts.apis.io/canvas-medical/json-schema/canvas-medical-bundle-schema.json
📊
JSONSchema
https://artifacts.apis.io/canvas-medical/json-schema/canvas-medical-care-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/canvas-medical/json-schema/canvas-medical-document-reference-schema.json
📊
JSONSchema
https://artifacts.apis.io/canvas-medical/json-schema/canvas-medical-medication-request-schema.json

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canvas-medical:canvas-medical-document-reference-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canvas-medical-document-reference-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canvas Medical FHIR Document Reference API
  description: A FHIR R4-compliant REST API providing secure access to electronic health record data. Canvas Medical supports 41 FHIR resources (21 with write capabilities) covering clinical, administrative, financial, and care coordination domains. The API follows the HL7 FHIR R4 specification and supports OAuth 2.0 Client Credentials and Authorization Code flows with SMART on FHIR scopes for machine-to-machine and user-delegated access.
  version: '4.0'
  contact:
    name: Canvas Medical Support
    url: https://help.canvasmedical.com/
  termsOfService: https://www.canvasmedical.com/
  license:
    name: HL7 FHIR R4
    url: https://hl7.org/fhir/R4/
servers:
- url: https://fumage-{canvas-instance}.canvasmedical.com
  description: FHIR R4 base URL (fumage subdomain)
  variables:
    canvas-instance:
      default: yoursandbox
      description: Your Canvas Medical instance name
security:
- OAuth2ClientCredentials: []
- OAuth2AuthCode: []
- BearerAuth: []
tags:
- name: Document Reference
  description: Clinical documents and attachments
paths:
  /DocumentReference:
    get:
      operationId: searchDocumentReference
      summary: Search DocumentReferences
      tags:
      - Document Reference
      parameters:
      - $ref: '#/components/parameters/patient'
      - $ref: '#/components/parameters/status'
      - name: type
        in: query
        schema:
          type: string
      - $ref: '#/components/parameters/count'
      - $ref: '#/components/parameters/pageToken'
      responses:
        '200':
          description: Bundle of matching document references
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/Bundle'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createDocumentReference
      summary: Create DocumentReference
      tags:
      - Document Reference
      requestBody:
        required: true
        content:
          application/fhir+json:
            schema:
              $ref: '#/components/schemas/DocumentReference'
      responses:
        '201':
          description: DocumentReference created
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/DocumentReference'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /DocumentReference/{id}:
    get:
      operationId: readDocumentReference
      summary: Read DocumentReference
      tags:
      - Document Reference
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: DocumentReference resource
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/DocumentReference'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
components:
  parameters:
    pageToken:
      name: _page_token
      in: query
      schema:
        type: string
      description: Pagination token for next page
    patient:
      name: patient
      in: query
      schema:
        type: string
      description: Filter by patient ID or reference
    status:
      name: status
      in: query
      schema:
        type: string
      description: Filter by resource status
    resourceId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: Logical ID of the FHIR resource
    count:
      name: _count
      in: query
      schema:
        type: integer
        default: 20
      description: Maximum number of results per page
  schemas:
    DocumentReference:
      allOf:
      - $ref: '#/components/schemas/FHIRResource'
      - type: object
        required:
        - resourceType
        - status
        - content
        properties:
          resourceType:
            type: string
            default: DocumentReference
          status:
            type: string
            enum:
            - current
            - superseded
            - entered-in-error
          type:
            $ref: '#/components/schemas/CodeableConcept'
          category:
            type: array
            items:
              $ref: '#/components/schemas/CodeableConcept'
          subject:
            $ref: '#/components/schemas/Reference'
          date:
            type: string
            format: date-time
          content:
            type: array
            items:
              type: object
              properties:
                attachment:
                  type: object
                  properties:
                    contentType:
                      type: string
                    data:
                      type: string
                      format: byte
                    url:
                      type: string
                    title:
                      type: string
    Narrative:
      type: object
      properties:
        status:
          type: string
          enum:
          - generated
          - extensions
          - additional
          - empty
        div:
          type: string
    Coding:
      type: object
      properties:
        system:
          type: string
        version:
          type: string
        code:
          type: string
        display:
          type: string
        userSelected:
          type: boolean
    Bundle:
      type: object
      properties:
        resourceType:
          type: string
          default: Bundle
        id:
          type: string
        type:
          type: string
          enum:
          - document
          - message
          - transaction
          - transaction-response
          - batch
          - batch-response
          - history
          - searchset
          - collection
          - subscription-notification
        total:
          type: integer
        link:
          type: array
          items:
            type: object
            properties:
              relation:
                type: string
              url:
                type: string
        entry:
          type: array
          items:
            type: object
            properties:
              fullUrl:
                type: string
              resource:
                $ref: '#/components/schemas/FHIRResource'
              search:
                type: object
                properties:
                  mode:
                    type: string
                    enum:
                    - match
                    - include
                    - outcome
    Reference:
      type: object
      properties:
        reference:
          type: string
        type:
          type: string
        display:
          type: string
    OperationOutcome:
      type: object
      properties:
        resourceType:
          type: string
          default: OperationOutcome
        issue:
          type: array
          items:
            type: object
            properties:
              severity:
                type: string
                enum:
                - fatal
                - error
                - warning
                - information
              code:
                type: string
              details:
                $ref: '#/components/schemas/CodeableConcept'
              diagnostics:
                type: string
              location:
                type: array
                items:
                  type: string
    FHIRResource:
      type: object
      description: Base FHIR R4 resource properties
      properties:
        resourceType:
          type: string
          description: FHIR resource type name
        id:
          type: string
          description: Logical id of this artifact
        meta:
          $ref: '#/components/schemas/Meta'
        text:
          $ref: '#/components/schemas/Narrative'
    Meta:
      type: object
      properties:
        versionId:
          type: string
        lastUpdated:
          type: string
          format: date-time
        source:
          type: string
        profile:
          type: array
          items:
            type: string
        tag:
          type: array
          items:
            $ref: '#/components/schemas/Coding'
    CodeableConcept:
      type: object
      properties:
        coding:
          type: array
          items:
            $ref: '#/components/schemas/Coding'
        text:
          type: string
  responses:
    UnprocessableEntity:
      description: Validation error
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
    Unauthorized:
      description: Authentication required
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
    ResourceNotFound:
      description: Resource not found
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
  securitySchemes:
    OAuth2ClientCredentials:
      type: oauth2
      description: 'Machine-to-machine authentication using client credentials grant. Obtain client_id and client_secret from Canvas admin panel.

        '
      flows:
        clientCredentials:
          tokenUrl: https://{canvas-instance}.canvasmedical.com/auth/token/
          scopes:
            system/*.read: Read all FHIR resources
            system/*.write: Write all FHIR resources
            system/Patient.read: Read Patient resources
            system/Patient.write: Write Patient resources
            system/Appointment.read: Read Appointment resources
            system/Appointment.write: Write Appointment resources
            system/Observation.read: Read Observation resources
            system/Observation.write: Write Observation resources
    OAuth2AuthCode:
      type: oauth2
      description: 'User-delegated access using Authorization Code flow with SMART on FHIR scopes.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://{canvas-instance}.canvasmedical.com/auth/authorize/
          tokenUrl: https://{canvas-instance}.canvasmedical.com/auth/token/
          scopes:
            patient/*.read: Read patient-context FHIR resources
            user/*.read: Read user-context FHIR resources
            user/*.write: Write user-context FHIR resources
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Canvas Medical FHIR API Documentation
  url: https://docs.canvasmedical.com/api/