Skip to main content

HealthShare Personal Community Patient Entered Data Setup Guide



1. Introduction

This guide is intended to be a resource for understanding the setup of Patient Entered Data features of Personal Community in HealthShare

2. Overview

The Patient Entered Data functionality provides patients with the ability to digitally capture and send information about themselves to their providers.

If there is information that an organization wants to collect from the patient prior to service, patients can receive a notification that they have a task to complete, and then complete it within Personal Community. 

Patients with tasks to complete will see these tasks in their To Do box on the Home page. This box will list any pre-service tasks items such as documents, and any outstanding HealthShare Care Community care plans.  Patients can access their pre-service tasks, or care plans as requested, and submit them back to their care team.

3. Patient Contributions to HealthShare Care Community

With the combination of Personal Community   and HealthShare Care Community patients can be active participants in their Care Community care plans, including the ability to answer and complete plans sent to them by members of their care team.  Personal Community Care Plans section   integrates with HealthShare Care Community to allow patients to enter data into a care plan. Patients will now have the ability to  be active participants in their Care Community care plans, including the ability to answer and complete plans sent to them by members of their care team.

3.1. Configuring HealthShare Care Community for Patient Contributions

Care Community 2023.1 introduces the capability for patients to be active contributors to their own care plans. This feature allows patients to play a key role in achieving the goals of their care plans. In order to integrate with HealthShare Care Community, certain Installation prerequisites must be followed.

Please use the following link for detailed guidelines: Configuring HealthShare Care Community for Patient Contributions

3.2. Configuring Personal Community for Patient Contributions

Note

Use of this feature requires that viewing care plans are enabled

3.2.1.  Creating the Service Registry on Unified Care Record for Care Community Care Plan

To create a Service Registry entry for the Care Community web service:
  1. Logon to the Management Portal as a user with the  %HS_Administrator  role.
  2. Select  HealthShare  from the main menu.
  3. Select the Unified Care Record Registry.
  4. Navigate to  Registry Management > Service Registry .
  5. Restrict the available services to HTTP endpoints by select HTTP from the  Service Type  drop down menu.
  6. Enter the following values for the fields:
    • Name  - Enter the name - has to be "CareCommunity"
    • Service Type  - Select HTTP.
    • Host  - Enter the host name for the Care Community web service. Should be secure (ie. "<vm-name>. iscinternal.com ")
    • Port - Enter the HTTPs port for the Care Community web service. 
    • SSL Configuration   - Enter your SSL configuration for secure communications
    • URL - Enter the full path to the Care Community web service, which should be "/api/healthshare-rest/<Care Community namespace>
    • HTTPCredentialsConfig - Enter the name of the credentials object you created for this entry. 
  7. Select  Save .



3.2.2. Enabling Care Plans in the Workbench

To enable the   Records   page in the Workbench:
  1. Log into the Workbench as a user with the  Configuration Manager  role.
  2. Go to the  Configuration Application   page ( Setup  >  Configuration Application ) and select the  Feature Control  tab. 
  3. Select  Edit Mode  to make edits to the fields described in the following steps.
  4. In the  Records   box, select the  Enable   checkbox.
  5. Select the following tabs:
      • Enable Care Team
      • Enable Care Plan Tab   -   Select this checkbox and proceed to fill out the two following required fields:
        • Care Community Assigning Authority -   the Assigning Authority name defined for Care Community in the Unified Care Record
        • Care Community Service Registry Name -    t he name of the service registry entry created in the Unified Care Record.
  6. After you have finished, select  Submit  at the bottom of the page to save your changes.

4. Event Based Tasks

Personal Community supports tasks which can contain multiple task items. Documents sent as task items are intended to be used to send patients educational materials to be read prior to upcoming events, and will appear in a patient's   To Do   box within Personal Community.

4.1. Using the Task API

4.1.1.  API Documentation

You can use an external system to call the Personal Community API with task information and associated task items to be returned. Swagger documentation for the task API is available here .

4.1.2.  Creating an Intersystems IRIS User Account for API Access

In order for a system to use the Invitation to Enroll API, they must have a corresponding IRIS User Account with the HSPortal_Role_API_Services role.

4.2.  Document Task Items

Personal Community supports three types of documents:

  1. Link - links to fully qualified URL to external content, such as educational materials, websites, or videos
  2. OnDemand - documents and reports that can be generated on demand
  3. Stream - physical documentation

You must use the taskItem "type"="Document"

  1. To use the Link task type, you must use the taskItem "documentType"="Link". Please note:
    1. a documentLink is required.
  2. To use the OnDemand task type, you must use the taskItem "documentType"="Stream". Please note
    1. a documentLink is required
  3. To use the Stream document type, you must use taskItem "documentType" = "Stream". Please note
    1. documentFileType is required
    2. documentStream is required, base64 encoded, and `maxLength` is constrained by maximum length of IRIS string (3161144 bytes) and 33% expansion from base64 conversion.


4.2.1.  Configuring On-Demand Document Retrieval

To use the OnDemand document type, it is required to have a document retrieval class defined and registered.   A document retrieval class is required for every external system that wishes to leverage the OnDemand document type. Document retrieval classes are stored against each external user's IRIS user account.

4.2.2.  Retrieving Documents from an External System

4.2.2.1. Creating your Custom Document Retrieval Class

To create a new document retrieval class, follow the steps:

  1. Create a new class that extends HS.Portal.EHR.AbstractDocumentURLRetriever
  2. Override the following methods:
    • %GetFilename - Given the document URL, return the file name. This is applied to the Content-Disposition header of the HTTP response.
    • %GetContentType - Given the document URL, return the MIME type. This impacts how the browser displays the data.
    • %OutputDocumentToDevice - Within this method, implement the logic to write the data to the device.
  3. Compile the class

4.2.2.2.  Create and Add Supporting Production Components [Optional] 

To support your custom document retrieval processor, you may need to create an additional business service and business operation to interact with your external document provider

4.2.3. Registering your On-Demand Document Class

Register your on-demand document processor by using the $insert-document-processor API.