OSCAR: Configuring the REST API for Better Ocean Reliability

If you are experiencing troubles with Ocean (e.g. notes are not appearing patients' charts) and you have been a long-time Ocean user, you will want to switch to the REST API for a more reliable Ocean experience. You can do this by following the steps outlined below.

  • Log in to your OSCAR EMR.
  • Click on the Ocean shortcut on one of your patient's appointments to open up the Ocean eForm.
  • Click on the "Settings" button on the Ocean eForm.
  • Select "Advanced Settings".
  • Select "Configure REST API".
  • Click the checkbox to use the REST API for your Ocean custom eForm. Save your changes.

Your OSCAR-Ocean integration should now work reliably, as expected.

OSCAR: Printing or Downloading an Individual Ocean Note

You may find that you want to print or download an individual Ocean note from OSCAR. You can easily do this by following the steps outlined below.

  • Open the Encounter screen for your patient.
  • Find the note that you wish to print or download. Click on the little printer icon at the top right corner of the note.
  • The printer icon will turn green once selected. From there, you can select the main printer icon at the bottom of all the notes.
  • From the main print dialog, select "Selected" and then "Print".
  • From here, you can use the print function as usual, either sending it to your printer to print or selecting "Print to PDF" to download the note as a PDF file.

OSCAR: When Adding the Ocean Custom eForm Turns the Schedule Grey

This is caused by an obscure OSCAR bug.

To fix this issue:

  • Enter the "Preferences" window in OSCAR.
  • Find the "Length of link and form names to display on appointment screen" field.
  • This sets the number of letters shown for each eForm name on the schedule screen and blows up the screen (for some reason) when it's zero. Change the number to at least 1 (2 is usually a good number here) and the schedule should go back to normal.
  • Click "Update" when set to ensure that your changes are saved.

OSCAR: Mapping Answers from an Ocean eForm to an OSCAR Measurement

  1. Tag your measurement in your Ocean eForm.

    • When you are building your eForms, if you "tag" a caption by surrounding a single word with "@" and ":" then the value will be available for mapping using EMR field mapping.

    Ensure your tagged field also contains a $$ variable after the colon to capture the value of your form item or formula defined in the "Scripting and More" tab. The complete tagged field syntax should be structed like so: @taggedField: $$

    • An example can be found in the screenshot to the right or in the note generated by this standard CAGE questionnaire.
    • CAGE Questionnaire
    • Note: The value of the tagged field in the Ocean note is passed directly to the OSCAR measurement. In other words, if OSCAR expects "Yes" or "No" and the note contains Y or N, it won't work. Therefore, the note has to produce exactly what OSCAR expects for the measurement.
  2. Create your measurement type in your OSCAR EMR.

    • For a custom measurement to be properly mapped and tracked, you will need: a custom measurement type in OSCAR (with a type that matches the measurement's allowable values) and a custom flowsheet (with all your Ocean-provided measurements included).
      Please note: Depending on your OSP, you may need a system administrator or staff member with admin privileges to perform the following steps on your behalf.
    • Log in to your OSCAR EMR and open the Administration panel.
    • Expand the "System Management" section (in the menu on the left) and select "Customize Measurements".
    • Select "Customize Measurements", and then "Add Measurement Type". Create your new custom measurement type (if it doesn't exist already in your OSCAR EMR).
  3. Customize your Ocean flowsheet and upload it into your OSCAR EMR.

    • The flowsheet to the right contains all the standard OSCAR-installed measurement types. You will likely already be using other measurement types, such as CAGE and PHQ-9. If you are adding a new measurement type, you must add it to this flowsheet before uploading it into OSCAR. OSCAR flowsheets are XML documents, so you will need to edit the raw XML in a text editor.
    • Download the latest Ocean flowsheet
    • Please note: Some OSP configurations may not have all the standard OSCAR-installed measurement types contained in the Ocean flowsheet file. 

      If you are unable to properly load the flowsheet file in your EMR, edit the Ocean flowsheet XML file to only list entries for the measurement values you wish to track. Also ensure these measurements are properly defined in OSCAR's measurements settings, per this guide's earlier instructions.
    • For example, you can add the CAGE measurement type to the bottom of the flowsheet, before the </iheader> element, as shown below:
    • <item measurement_type="WT" display_name="WT" guideline="" graphable="no" value_name="WTOceanLabel">
    • Once you are done editing the flowsheet, upload it into OSCAR by opening the Administration panel, expanding the "System Management" section (from the menu along the left), and selecting "Manage Flowsheets".
      Note for clinics using KAI: To be compatible with KAI's requirements for flowsheet files, you'll need to add an additional attribute to your flowsheet file, dxcode_triggers. Please ensure the first line of your Ocean flowsheet XML is formatted like so:
      <flowsheet name="Ocean" display_name="Ocean Measurement Updates" dxcode_triggers="">
  4. Map your OSCAR measurement in the Ocean Portal.

    • Log in to the Ocean Portal. Click "Menu" and select "Admin".
    • Enter the "EMR Field Mapping" section (selected from the menu along the left) and add a row.
    • The "Tagged Field" should match the note that you tagged in your Ocean eForm (i.e. the caption you surrounded with "@"" and ":" in your Ocean eForm).
    • The "EMR Field" should be all capital letters and should exactly match the measurement type in OSCAR (see screenshot to the right).
    • Make sure to save your changes in the Ocean Portal before leaving that "EMR Field Mapping" page.
    • Now, if a patient completes the CAGE questionnaire, the CAGE value in the measurement will then be set in the "Measurements" section of their Encounter screen in OSCAR.