The ATL COM module careCreditRequest is capable of
generating electronic & printed nursing care credit requests
generating electronic & printed nursing care credit requests
API browser of CareCreditRequest450 COM module
 ICareCreditResult::GetPlanningRecords method |
 |
||
|---|---|---|---|
|
This method has a Restful Webservice representation only! Method for collecting all planning record data covered by the ICareCreditResult interface and returned as JSON array. Please note that ICareCreditResult::GetPlanningRecords takes over the functionality of the iterator pair ICareCreditResult::GetFirstPlanningRecord / ICareCreditResult::GetNextPlanningRecord with a single call, making the latter superfluous. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/ICareCreditResult/GetPlanningRecords | ||
| [JSON input data] | pICareCreditResult: | longValue, //interface address |
|
| [JSON result array] | { pbstrPlanningType: pbstrPlanningCode: pbstrPlanningText: pdQuantity: pbstrMultiplierSymbol: pdMultiplier: pdBaseUnit: peIsTraining: pdCorrUnit: pdTotalUnit: pbstrRemark: pbstrTariffType: pbstrTariffCode: pbstrTariffText: pdTariffQuantity: pdTP: pdTPV: pdExternalFactor: pdAmount: pbStatus: |
"utf8StringValue", "utf8StringValue", "utf8StringValue", doubleValue, "utf8StringValue", doubleValue, doubleValue, longValue, doubleValue, doubleValue, "utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", doubleValue, doubleValue, doubleValue, doubleValue, doubleValue, booleanValue }, |
|
| [HTTP result status] | 200 | Return status 200 signals a successful method call | |
| 204 | Return status 204 (noContent) signals that the end of an iteration is reached | ||
| >= 400 | Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do. | ||
| |||
| Calling argument description |
|||
| [out] BSTR | *pbstrPlanningType | The official planning type designator, e.g. "RAI-NC", "BESA 5", "KLV7" and the like | |
| [out] BSTR | *pbstrPlanningCode | The planning code as defined by the used planning catalog | |
| [out] BSTR | *pbstrPlanningText | The name of the planning record as defined by the used planning catalog | |
| [out] double | *pdQuantity | The quantity aka the frequency per day of the planning record
Note, that the quantity is defined as double, spanning zero and positive fractional values!
|
|
| [out] BSTR | *pbstrMultiplierSymbol | The Multiplier Symbol corresponds to a temporal multiplication function that distributes a singular object over the whole treatment interval. The functional behavior is supplied by a set of (language-dependent) symbols like "t3", "w", "m" etc.
Please note that -since the symbols are language sensitive and unstandardized<7b>- these tokens are supplied for documentation/display purposes only but not used in any calculation. It is the dMultiplier factor that is used for the calculation! |
|
| [out] double | *pdMultiplier | The dMultiplier number is the numerical representation of the bstrMultiplierSymbol and defines the multiplication factor that a singular planning object is distributed over the whole treatment interval.
Please note, that the magnitude of the multiplier might be fractional since an instruction like "t3" might not be transformed to an integer dependent on the given treatment interval. |
|
| [out] double | *pdBaseUnit | The base unit of a singular planning object as defined in the planning catalog - this is the planning equivalent of the tax point for tariff services. | |
| [out] YesNoType | *peIsTraining | eIsTraining is a Boolean value indicating whether the planning record is performed in training mode.
Note, that this Boolean is mostly enNo outside a home care situation. |
|
| [out] double | *pdCorrUnit | dCorrUnit is used to optionally correct the total unit dTotalUnit of the planning record.
Please note, that the sign is significant, i.e. a downscale correction corresponds to a negative value. Furthermore, "dCorrUnit" is an absolute value and is not modulated by "dQuantity" and "dMultiplier" (cf. the defined equation under "dTotalUnit"). The necessity of a correction depends on the used catalog and is justified by the non-orthogonality of the catalog planning records. |
|
| [out] double | *pdTotalUnit | dTotalUnit defines the calculated units over the full treatment interval as given by the equation:
The equation is calculated in full precision and the result rounded to 2 significant decimal places. |
|
| [out] BSTR | *pbstrRemark | An optional remark for the given planning record and tariff record | |
| [out] BSTR | *pbstrTariffType | The official tariff type as defined by Forum Datenaustausch.
If there is no coupling of the planning set to a corresponding incurred cost record than the tariff type is empty. |
|
| [out] BSTR | *pbstrTariffCode | The tariff code as defined by the used tariff
If there is no coupling of the planning set to a corresponding incurred cost record than the tariff code is empty. |
|
| [out] BSTR | *pbstrTariffText | The name of the tariff record as defined by the used tariff | |
| [out] double | *pdTariffQuantity | The quantity of the defined service.
Note, that the quantity is defined as double, spanning zero and positive fractional values!
|
|
| [out] double | *pdTP | The tax points (TP) of the defined tariff record | |
| [out] double | *pdTPV | The tax point value (TPV) of the defined tariff record | |
| [out] double | *pdExternalFactor | The external scaling factor used to scale the tariff record e.g. to give a discount or surcharge or to use the factor as a measure of splitting costs. | |
| [out] double | *pdAmount | dAmount is the caused incurred cost given by the tariff record and calculated as follows:
The equation is calculated in full precision and the result rounded to 2 significant decimal places. |
|
| [out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |
|
|||