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.

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