Internal API for PointClickCare access

Internal API for PointClickCare access

Objectives

1. Manually fetch full patient lists from an existing PointClickCare community to import into FullCount.

Prerequisites

  • Ability to make an HTTP request. Instructions will use Curl, but other options include PostMan or other online tools.
  • Access to Integrations keepass.
  • Microsoft Excel installed.

Instructions

 

Obtain PointClickCare patient list for a FullCount Community.

  1. The FullCount integration-pcc application has an endpoint open to basic header authentication located at ../internal/patients/{orgId}
  2. The endpoint is designed to get all Patients for a provided Point Click Care orgUuid and facId.

 

HTTP Request

 

Authorization

Header value:  "Authorization: Basic  <Base64 encoded username:password>"

note: username and password values as well as the base64 value can be found in Integration keepass under 'PCC Integration - Internal' entry.

 

Parameters

Path Parameter : 'orgUuid' - Point Click Care designated Organization UUId

Query Parameter : 'facId' (required) - Point Click Care designated Facility Id

Query Parameter : 'status' (optional, available={'Current', 'Discharged', 'New'}, default='Current') - desired patientStatus to fetch

Query Parameter : 'withAllergies' (optional, available = true/false, default = false) - true if allergy information should also be gathered for each patient. (Note: this is a separate api call, and will add significant time to the request). If false no allergy information will be included.

Query Parameter : 'withFacility' (optional, available = true/false, default = true) - true if facility information should also be gathered for each patient. (Note: this is a separate api call). If false no facility information will be included. 

Query Parameter :'withNutritionOrders' (optional, available = true/false, default = false) - true if nutrition order information should also be gathered for each patient. (Note: this is a separate api call, and will add significant time to the request). If false no nutrition information will be included.

 

Response

Successful response Http Status Code 200 with Response Body similar to below example:

{

    "paging": {

        "hasMore": false,

        "page": 1,

        "pageSize": 107

    },

    "data": [{

        "orgId": 1504955675,

        "facId": 22,

        "patientId": 7792,

        "roomId": 2083,

        "floorId": 243,

        "unitDesc": "44C8D75E-",

        "patientStatus": "Current",

        "bedDesc": "A",

        "bedId": 3910,

        "roomDesc": "24",

        "floorDesc": "Main",

        "unitId": 494,

        "firstName": "Louie",

        "lastName": "Abbott",

        "birthDate": "1948-09-11",

        "admissionDate": "2015-11-29",

        "deceased": false,

        "gender": "FEMALE",

        "hasPhoto": true

    },

 

...

 

]}

Paging -  PageSize will be total records found.

Data - List containing JSON entries representing individual Point Click Care Patients.

 

The Json response body should be placed into a file that we can then access from excel.

example Curl:

 

 

 

Generate a valid Excel file for upload

  1. Open Microsoft Excel
  2. Navigate to 'Data' ribbon, then 'Get Data -> From File -> From JSON'
    •     
  3. Select recently created patient .json file.
  4. Right Click on 'List', then 'Into Table', accept blank delimeter.
  5. Click on expand columns (Make sure 'Use original column name as previx' is NOT checked)
  6. This should expand all Patient data into separate columns. Now click 'Close & Load'
  7. Save the document.

 

Synchronize PointClickCare patient list for a FullCount Community

  1. The FullCount integration-pcc application has an endpoint open to basic header authentication located at ../internal/patients/{orgUuid}/synchronize
  2. The endpoint is designed to get all Patients for a provided Point Click Care orgUuid and facId.

HTTP Request

Authorization

Header value:  "Authorization: Basic  <Base64 encoded username:password>"

Note: username and password values as well as the base64 value can be found in Integration keepass under 'PCC Integration - Internal' entry.

Parameters

Path Parameter : 'orgUuid' - Point Click Care designated Organization Id

Query Parameter : 'facId' (required) - Point Click Care designated Facility Id

Query Parameter : 'communityId' (required) – FullCount Community Id

Query Parameter : 'status' (optional, available={'Current', 'Discharged', 'New'}, default='Current') - desired patientStatus to fetch

Query Parameter : 'withAllergies' (optional, available = true/false, default = false) - true if allergy information should also be gathered for each patient. (Note: this is a separate api call, and will add significant time to the request). If false no allergy information will be included.

Query Parameter : 'withPhoto' (optional, available = true/false, default = true) - true if photos should also be gathered for each patient. (Note: this is a separate api call, and will add significant time to the request). If false no photos will be included.

Query Parameter : ‘withFacility’ (optional, available = true/false, default = true) - true if facility information should also be gathered for each patient. (Note: this is a separate api call, and will add significant time to the request). If false no facility information will be included.

Query Parameter : ‘withNutritionOrders’ (optional, available = true/false, default = false) - true if nutrition order information should also be gathered for each patient. (Note: this is a separate api call, and will add significant time to the request). If false no nutrition order information will be included.

Response

Successful response Http Status Code 200 with Response Body similar to below example:

100 rows created.

example Curl:

 

 


    • Related Articles

    • FullCount Development Projects

      Project Technology Description at-fullcount-model Java model project for FC_OBJ_OWNER schema at-fullcount Java, dojo, dwr front end touchscreen project. Also referred to as POSWebApplication. at-payment-processing Java credit card processing for Axia ...

    • myUnity Integration API Documentation

      myUnity Integration API Documentation Overview This process allows Netsmart myUnity to send HL7 records to FullCount for ADT integration and for FullCount to process these records internally. This service is located on FullCount integration server. ...

    • API Connect - Resident Portal Implementation

      Assumptions: 3rd party vendor has been validated. Implementation steps: Signed contract/agreement from the mutual customer(s). Contract/agreement provides license and permission to share customer data with the 3rd party. Identify and populate 3rd ...

    • Set up Postman for Model API

      Set up Postman for Model API Create new Collection in Postman for model-api Set Authorization for the collection to be Bearer Token. Assign token to be a global variable called {{model-api-token}} Set up localhost environment On left hand menu, ...

    • API Connect - Resident Portal Employee FAQ

      What is API Connect - Resident Portal? API Connect - Resident Portal is a gateway for 3rd party vendor partners to access FullCount's resident information displayed on Resident Portal Our partners will be able to pull resident account balances and ...