OSCAR EMR

OSCAR REST Web Services API

OSCAR's REST web-services layer, served under the /ws/services base path of a deployed OSCAR instance, covering most of the clinical record - scheduling/appointments, demographics, billing, prescriptions, documents, labs, ticklers, eForms and providers. Applications register as REST clients through the OSCAR Administration interface and authenticate provider users with 3-legged OAuth 1.0a (/ws/oauth/initiate, /ws/oauth/authorize, /ws/oauth/token). As self-hosted software the host and web context are deployment-specific (documented example: http://localhost:8080/oscar_15/ws/services), so no single public base URL exists. The API is documented on the OSCAR EMR developer wiki; runtime documentation is generated with RAML (RAML for JAX-RS) rather than OpenAPI/Swagger, and there is no downloadable static spec published.

GitHub

Documentation

📖
Documentation
https://oscaremr.atlassian.net/wiki/spaces/OS/overview
📖
APIReference
https://oscaremr.atlassian.net/wiki/spaces/OS/pages/85396074/Documenting+the+REST+API
📖
GettingStarted
https://oscaremr.atlassian.net/wiki/spaces/OS/pages/79855638/Connecting+to+OSCAR's+REST+API
📖
Authentication
https://oscaremr.atlassian.net/wiki/spaces/OS/pages/79855638/Connecting+to+OSCAR's+REST+API

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/oscar-emr/refs/heads/main/apis.yml

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/oscar-rest-web-services-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

API entry from apis.yml

apis.yml Raw ↑ 
aid: oscar-emr:oscar-rest-web-services-api
name: OSCAR REST Web Services API
description: 'OSCAR''s REST web-services layer, served under the /ws/services base path of a deployed
  OSCAR instance, covering most of the clinical record - scheduling/appointments, demographics, billing,
  prescriptions, documents, labs, ticklers, eForms and providers. Applications register as REST clients
  through the OSCAR Administration interface and authenticate provider users with 3-legged OAuth 1.0a
  (/ws/oauth/initiate, /ws/oauth/authorize, /ws/oauth/token). As self-hosted software the host and web
  context are deployment-specific (documented example: http://localhost:8080/oscar_15/ws/services), so
  no single public base URL exists. The API is documented on the OSCAR EMR developer wiki; runtime documentation
  is generated with RAML (RAML for JAX-RS) rather than OpenAPI/Swagger, and there is no downloadable static
  spec published.'
humanURL: https://oscaremr.atlassian.net/wiki/spaces/OS/pages/79855638/Connecting+to+OSCAR's+REST+API
tags:
- EHR
- EMR
- REST
- Primary Care
- Canada
properties:
- type: Documentation
  url: https://oscaremr.atlassian.net/wiki/spaces/OS/overview
- type: APIReference
  url: https://oscaremr.atlassian.net/wiki/spaces/OS/pages/85396074/Documenting+the+REST+API
- type: GettingStarted
  url: https://oscaremr.atlassian.net/wiki/spaces/OS/pages/79855638/Connecting+to+OSCAR's+REST+API
- type: Authentication
  url: https://oscaremr.atlassian.net/wiki/spaces/OS/pages/79855638/Connecting+to+OSCAR's+REST+API