FoRSE Configuration

Last updated
Save as PDF

Use the FoRSE Configuration form in myAvatar to configure facility-specific information required for the connection to the FoRSE API. After your organization registers for FoRSE and receives their participation information, enter that information in the FoRSE Configuration form. This includes the FoRSE membership information, including a myAvatar EHR Facility ID and Secret Key.

The ForSE Configuration form has sections for setting up myAvatar for FoRSE and monitoring communication with FoRSE. All fields must be completed in the FoRSE Configuration form to submit data to FoRSE.

Note: myAvatar initially supports version 2 of the FoRSE API. FoRSE API documentation is available at https://naatpdata.com/v2/docs/APIdoc.php

Prerequisite:

In User Definition, give the user access to the FoRSE Configuration form.

This table describes the fields in the FoRSE Configuration section of theFoRSE Configuration form. All fields are required upon enabling the FoRSE functionality.

Field	SQL Columns	Description
Enabled	enabled_code enabled_value	Enables/disables the functionality. Data is sent when this field is enabled.
Facility ID	FacilityID	This is a FacilityID provided to Netsmart by NAATP. If this field is blank, please enter: KFJ3XN4C
Secret Key	SecretKey	This is a key provided to Netsmart by NAATP. If this field is blank, please enter: RQAHDZAZTKDZATDKECLNHAHDVVJTFAKD7ENW9J3QA5TUX6GQ5BGMW7VHAFDQHSFZ
Register New Company URL	RegisterNewCompanyURL	The URL endpoint used to register new facilities. https://naatpdata.com/v2/api/register_new_company.php
Registration Status URL	RegistrationStatusURL	The URL endpoint used to check facility status. https://naatpdata.com/v2/api/registration_status.php
Surveys URL	SurveysURL	The URL endpoint used to send surveys. https://naatpdata.com/v2/api/surveys.php
Timeout	Timeout	The time, in seconds, to be used when making the call. Select a value. Netsmart used 30 during testing.
Number Of Days To Keep Log Entries	DaysForLogEntries	The number of days to keep logs before removing them. Netsmart used 99 days during testing, but this is an organization decision to ensure that logs are accessible as needed, but removed when no longer required.

► Additional sections

► See also

About FoRSE API Communication

► SQL table

SYSTEM.FoRSEConfiguration