API browser of miscValidator200 COM module


/images/arrow_right.png IValidate::AddService method space
Adds a new service which will be validated against all previously added services of the same session. If the code supplied passes all validations a VARIANT_TRUE value is returned. If the code was not accepted VARIANT_FALSE is returned and the variable plStatus contains the error code.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IValidate/AddService
[JSON input data] pIValidate:
bstrTariffType:
bstrCode:
bstrReferenceCode:
dQuantity:
dTP:
dTPValue:
dExternalFactor:
lSessionNumber:
dDate:
eIgnoreValidate:
lHook:
longValue,    //interface address
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
doubleValue,
doubleValue,
doubleValue,
doubleValue,
longValue,
variantDateValue | "stringISODateValue",
longValue,
longValue
[JSON result data] pbStatus: 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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT AddService( BSTR
BSTR
BSTR
double
double
double
double
long
DATE
YesNoType
long
VARIANT_BOOL
bstrTariffType,
bstrCode,
bstrReferenceCode,
dQuantity,
dTP,
dTPValue,
dExternalFactor,
lSessionNumber,
dDate,
eIgnoreValidate,
lHook,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
E_name This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.
space
/images/arrow_right.png Calling argument description
[in] BSTR bstrTariffType Tariff catalog to use.
Use the methods miscValidator::GetFirstTariff/miscValidator::GetNextTariff to iterate over all (filtered) tariff catalogs
[in] BSTR bstrCode Code of the service
[in] BSTR bstrReferenceCode The reference code of the service. The reference code must be set if the enServicePropertyIsNeedsRefCode bit of that service is set.
If a reference code is needed than that parent service must be supplied before this one.
[in] double dQuantity Quantity of the service
If enIgnoreValidate=enNo and dQuantity=0 then the quantity is auto-expanded to 1.0 by the validator
[in] double dTP Tax point of the service.
If enIgnoreValidate=enNo and dTP=0 then the tax point is auto-expanded to the correct TP by the validator. The auto-expansion of a variable TP service is set as (TPMax+TPmin)/2.
If the upper bound of a variable TP service is undefined than TP is set 0 in the auto-expansion!
[in] double dTPValue Tax point value of the service
Please note that there is no internal database for the various tax point values. Therefore, there is no auto-expansion of the TPV possible.
[in] double dExternalFactor External factor to set
If enIgnoreValidate=enNo and dExternalFactor=0 then the external factor is auto-expanded to 1.0 by the validator
[in] long lSessionNumber Session number
If enIgnoreValidate=enNo and lSessionNumber=0 then the session number is auto-expanded to 1 by the validator
[in] DATE dDate Date of the service to ensure a valid date range of the service record itself
[in] YesNoType eIgnoreValidate Flag indicating whether the validation should be ignored or not.
To turn off the validation might be useful in the situation when a service should be added even if the validation failed due to a special agreement with the insurance or patient.
[in] long lHook External hook. The software house can provide e.g. a record ID of the service to identify this service later on when reading data back.
[out,retval] VARIANT_BOOL *pbStatus The principal validation status
  • =0 is returned for success
  • >0 indicates that a validation rule was not fulfilled - the service is not added. Use the GetAbortInfo to get an error description string.
  • <0 indicates a severe principal COM automation error - the service is not added. Use the GetAbortInfo to get an error description string.
space