PointClickCare FHIR API

Connecting with PointClickCare using USCDI Connector FHIR applications

USCDI Connector is PointClickCare’s solution for customers and 3rd party vendors, interested in building ONC compliant FHIR API based integrations with PointClickCare.

PointClickCare’s FHIR API documentation for USCDI Connector lists the details of the FHIR APIs supported (in line with the USCDI v1 data set). For further API details please refer to the FHIR US Core 3.1.1 Implementation Guide.

There are 3 types of USCDI Connector applications that can be registered with PointClickCare – Patient facing, Provider facing & Bulk data. Before Apps can access patient data from PointClickCare, please go through the process below to register your application.

Please note, Users (Patient or Provider) will only have access to patient records that their accounts are authorized to access in PointClickCare.

Registering a SMART on FHIR Application to access Patient data

  1. Prior to accessing patient data, you will need to register your application. To start the process, please contact our Partnership team through the ‘Apply for Partnership’ form at: Become a Partner (pointclickcare.com) .
    Once the right Developer program (USCDI Connector or Marketplace) has been determined for your business, you will receive a link via email to apply for your Developer Portal account.
  2. When creating your Developer Portal account please select 'USCDI Connector'.
  3. Please fill out the form using the same details you have previously shared with the PointClickCare Partner Manager. After you fill out the form, your account will need to be approved by PointClickCare. You will receive an email verification after which you can access the tabs under your user profile.
    To register an App you will also need to set up 2-Factor Authentication. Instructions are listed under the Documentation tab in the Developer Portal.
  4. Once approved, click your user profile button in the top right corner, to get access to the 'My Apps' tab to create your App.
    1. Please enter your App name, as you would like it to be displayed to your Users.
    2. The first App you create has to be 'Development'. This will allow you to test with the PCC Sandbox.
    3. Select one of the 3 'App Type' options:
      1. Patient - These are Apps intended for use by patients and will be launched from the Connected Care Center (PointClickCare's Patient Portal product) or directly from a mobile device.
      2. Provider - These are Apps intended for use by medical providers (i.e. having a PointClickCare user account) and will be launched from the Core PointClickCare application or directly from a mobile device.
      3. Bulk - These are Apps intended for system to system bulk data queries using the bulk FHIR API standard. They are not visible to Users to launch out of PointClickCare E.H.R or Connected Care Center.
    4. Describe your Apps functionality with as much detail as possible.
    5. Select the authentication method used by your App and provide any required details.
    6. Provide the requested URLs.
    7. Provide the FHIR scopes (as defined by the SMART on FHIR protocol) that your App will require. If you do not use the correct format (example is provided in the tool tip) your App will not be able to access data. Please note PointClickCare only supports scopes related to the supported FHIR API resources.
    8. Provide the Common Name for the Certificate in use by your App. Please ensure the certificate is supported by PointClickCare. For a list of supported certificates, please refer to the 'Documentation' tab. If the Common Name is not provided, your application will not be approved.
    9. If this is your first App being registered with PointClickCare, ignore the Serial Number field. Only provide the Serial Number of the Certificate if it needs to be revoked due to the application being compromised.
    10. Provide the 'Communication Email' that notifications can be sent to.
    11. Indicate the platform you are developing for.
      1. If you are registering a Web App, please provide your Launch URL.
    12. Please Accept PointClickCare’s Terms & Conditions.
  5. Development Apps will be auto-approved and enabled in the PointClickCare FHIR Sandbox.
  6. Production Apps will need PointClickCare approval.
  7. Your App Client ID & Secret (for Development and Production Apps) will be available through your App listing under 'My Apps'.

Enablement process for USCDI Connector integrations

  1. Once an app has been registered with PCC, the enablement is driven by PCC customers, by Facility
  2. PCC customers will need to speak with their PCC Sales Representative about the process to enable a USCDI Connector integration
  3. The integration enablement will take a minimum of 2 weeks, depending on the number of Facilities where the enablement is requested and the complexity of their patient records
    1. Note: If you are registering a ‘Patient’ facing App, the customer will have to be enabled with PointClickCare’s Connected Care Center for your Users to access patient data.

Sandbox usage

  1. PointClickCare provides a shared Sandbox for FHIR Apps to be tested against.
  2. The Sandbox details are available through 'My Sandboxes' under the user profile button in the top right corner.
    1. Patient Apps - Please use the credentials beginning with 'ConnecterCareCenterUser'.
    2. Provider Apps - Please use the credentials beginning with 'vendortest'.

Making your first FHIR API call

  1. PCCs implementation of SMART on FHIR follows the public standard. Please use the documentation listed here as the guide: https://hl7.org/fhir/smart-app-launch/2021May/
    1. Note: The base FHIR URL https://connect2.pointclickcare.com/fhir/R4 will need to have the Tenant ID appended to it before the FHIR resource is called
      1. Sample URL: https://connect2.pointclickcare.com/fhir/R4/{tenantId}/CareTeam
      2. Service Base URLs are available here: https://fhir.pointclickcare.com/R4endpoints.json

Retrieving a CCD (g9)

  1. You will need to register a patient/provider App to access CCD’s via API. 
  2. To access CCDs you will need to use the FHIR DocumentReference API. The API details to make the successful call can be found on the API Specification page.
    1. Requesting a current CCD:
      1. Make DocumentReference call using patient, type set to CCD Loinc code (listed in period element in the API specification). 
      2. Receive 1 Document Reference in the response, with 1 attachment that contains the URL to generate the current CCD.
        1. API response element that contains the URL: DocumentReference.content.attachment.url
      3. Traverse the URL to obtain the CCD, which is immediately resolved as XML
    2. Requesting a CCD for a date/date range
      1. Make DocumentReference call using the patient, type set to CCD Loinc code and the period (all described in the API specification). 
      2. Receive 1 Document Reference in the response, with a list of CCDs as attachments. Each attachment has a URL for the specific document
        1. API response element that contains the URL: DocumentReference.content.attachment.url
      3. Traverse the URL to obtain the CCD, which is immediately resolved as XML
      4. If the response comes back with 0 results, the current version of the CCD is generated on the fly and immediately resolved as XML

Pricing

USCDI Connector FHIR API pricing uses the following model:

  1. Customers under PCC’s current pricing model will be charged a flat fee of $65 per App per Facility per Month. This price will be subject to annual revision, in line with costs incurred by PointClickCare.