Clinic Conductor by PulseAI

Resources EMR and system integration

OSCAR Pro integration: the web services, explained

How third-party systems connect to OSCAR Pro and the OSCAR family: the REST and SOAP web services, how access is granted, and what hosting must enable.

The short version

  • OSCAR began as an open-source EMR at McMaster University. OSCAR Pro is the commercial edition from WELL Health; other distributions exist.
  • The OSCAR family exposes web services: a REST layer for most records and SOAP services for some, including lab uploads.
  • REST clients are registered by the clinic's OSCAR administrator and authorized by a user.
  • Which services are enabled depends on the edition, version and hosting provider, so confirm before you plan.
  • Clinic Conductor is live in production with OSCAR Pro.

The OSCAR family

OSCAR EMR started as an open-source project at McMaster University and became one of the most widely used EMRs in Canadian primary care. Several editions have grown from it. OSCAR Pro is the commercial edition supported by WELL Health; other distributions are maintained by other groups. They share a common foundation, which is why integration patterns are similar across them, and they differ in version and configuration, which is why the details have to be confirmed clinic by clinic.

The web services

OSCAR exposes its records through web services served from the EMR itself. Two families matter for integration.

OSCAR web services at a glance

DetailREST servicesSOAP services
Typical recordsPatient demographics, schedule, prescriptions, documents, labs, ticklers, formsDemographics, scheduling and booking, allergies, preventions, measurements, prescriptions, documents, lab upload
AccessOAuth client registered by the clinic's administrator, then authorized by a userService credentials issued by the EMR
Best suited toModern integrations reading and writing specific recordsEstablished interfaces, and lab results where only SOAP is offered
Exact services and paths vary by edition, version and hosting. Lab and message flows also use HL7 v2.

OSCAR also supports eForms, which many clinics use for intake and questionnaires, and receives lab results and hospital reports through the provincial feeds where the clinic is set up for them.

How access is granted

For REST integrations, the clinic's OSCAR administrator registers the integration as a client in OSCAR's REST client management screen, which issues its credentials. A user at the clinic then authorizes the connection. On hosted editions, including most OSCAR Pro clinics, the hosting provider usually has to enable the web services first. Plan for that step: it is the most common reason an OSCAR integration waits.

What to ask an OSCAR integration partner

  1. Is your integration live with my edition and version of OSCAR today?
  2. Which services do you need enabled, and have you worked with my hosting provider before?
  3. Do you write back into the chart, and where do the records appear?
  4. How are documents labelled and routed to the right provider's inbox?
  5. How do you handle a failed write or a service that is temporarily unavailable?

OSCAR and the rest of the clinic

OSCAR clinics often already run add-ons for online booking, forms or messaging. An orchestration layer complements them: it connects to OSCAR once and conducts the work between OSCAR, the phone line, the fax line, intake and assessment data, with one set of rules and one audit trail. See our EMR integration guide for the broader picture.

Questions, answered

Does OSCAR Pro have an API?

Yes. The OSCAR family exposes REST and SOAP web services. REST clients are registered by the clinic's administrator and authorized by a user. On hosted editions, the hosting provider usually has to enable the services.

Is OSCAR Pro the same as OSCAR EMR?

OSCAR Pro is a commercial edition of OSCAR, supported by WELL Health. It shares its foundation with other OSCAR distributions, which differ in version and configuration.

Is Clinic Conductor integrated with OSCAR Pro?

Yes. Clinic Conductor is live in production with OSCAR Pro.

See it running

Clinic Conductor reads, files and escalates documents into OSCAR Pro, live in production.

Keep reading

Related guides.

EMR and system integration

EMR integration for clinics: the complete guide

How a clinic connects its EMR to intake, forms, phones, faxes, labs and a CRM: the five ways to integrate, what each EMR exposes, and what to ask a vendor.

Read the guide

EMR and system integration

HL7 and FHIR, explained for clinics

The standards that move health information between systems, in plain terms: HL7 v2 messages, FHIR R4 resources, and the pan-Canadian specifications built on them.

Read the guide