HealthFeeScheduleDataService:getBaseFees

Class: HealthFeeScheduleDataService

Method: getBaseFees

Important This service is retired from Vlocity Health and Insurance Spring '22 release and onward.

How It Works

1. Service uses the feeSchedId to determine the currently active version of the FeeSchedule__c for a given date. If more than one version satisfies the given date, data from the most recent version is returned.

2. Service uses the executionDateTimet option as the given date. If executionDateTime has no value, service uses the current date.

Remote Options

Option	Description
feeSchedId	Required. Id of the fee schedule.
executionDateTime	Optional. Date specified determines which enabled version of the schedule is selected. Format: DD/MM/YYYY
retrieveOptions	Optional. Key value pair. offset: <value> where value = fee schedule column that has the procedure code column mapping type applied to it. Used to determine where the returned rows of procedure codes will start. With no value, service returns the first 2,000 values from the base fee schedule. If a value is provided, the next 2,000 rows after the procedure code value (that is to say, below it) are returned. The rows before/above the value are not returned. In any case, only 2,000 rows are returned. Important Returned data sorting order is presently based on ascending procedure code hash values, not by procedure code. For example, procedure code ABC with hash value 789 would come after procedure code DEF with hash value 456.

Input JSON

This following JSON example shows the inputs the service uses:

{ 
   "feeSchedId":"a444P000001H44GQAS",
   "executionDateTime":11/25/2019,
   "retrieveOptions":{ 
      "offset":"99215"
   }
}

Output JSON

The service returns an output JSON of base fee schedule data, based on the feeSchedId and options provided:

{ 
   "baseFees":[ 
      { 
         "Description":"99215",
         "Facility Price":1,
         "Non-Facility Price":1,
         "Procedure Code":"99215",
         "deleted":false,
         "versionEnabled":true,
         "versionId":"a1I6F00000nM7LxUAK",
         "Name":"9952ac9010c8edba8ee0f2b4e80793e0",
         "vLineItemId":"a1H6F000006SvT8UAK"
      },
      { 
         "Description":"99214",
         "Facility Price":1,
         "Non-Facility Price":1,
         "Procedure Code":"99214",
         "deleted":false,
         "versionEnabled":true,
         "versionId":"a1I6F00000nM7LxUAK",
         "Name":"f88f1140bdd063cfc2ce8652abb6f581",
         "vLineItemId":"a1H6F000006SvT9UAK"
      }
   ],
   "error":"OK"
}