The ATL COM module generalInvoiceRequest is capable of
generating electronic and printed invoices & reminders
API browser of generalInvoiceRequest450 COM module


/images/arrow_right.png IGeneralInvoiceRequest::AddService method space
Adds a service from a simple/normal tariff to the list of services.
The term "normal" means a tariff with a simple (code, name, tax point) structure as opposed to "extended" tariffs whose services are splitted into a medical and technical part (like the Tarmed).
 
Auto-expansion: under the condition that the corresponding validator is installed and eIgnoreValidate=enNo then bstrText, dUnit, and dAmount are auto-expanded to the correct values by the validator if and only if these values are set empty or 0, respectively.
 
Important new feature: the AddService method has been patched to allow for controlling the underlying validators by using a pseudo service code: bstrCode="setParameter(cmd=value)", where cmd=value are validator specific commands. In such a case besides the service code (bstrCode) only the tariff type (bstrTariffType) and date (dDate) must be defined.
 
Currently there are defined pseudo codes for the following tariff types/validators in effect: Pseudo codes are active until the next call of the Initialize method and are then reset to their default values.
Do not use pseudo service codes if the validator is turned off by setting eIgnoreValidate=enYes!
 
If the return status is VARIANT_FALSE then the service record is not added or the pseudo service code was not accepted!
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceRequest/AddService
[JSON input data] pIGeneralInvoiceRequest:
bstrTariffType:
bstrCode:
bstrReferenceCode:
dQuantity:
lSessionNumber:
dDateBegin:
dDateEnd:
bstrProviderEAN:
bstrResponsibleEAN:
bstrText:
dUnit:
dUnitFactor:
dExternalFactor:
dAmount:
dVatRate:
eIsObligatory:
bstrRemark:
bstrSectionCode:
eIgnoreValidate:
lServiceAttributes:		 longValue,    //interface address
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
doubleValue,
longValue,
variantDateValue | "stringISODateValue",
variantDateValue | "stringISODateValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
doubleValue,
doubleValue,
doubleValue,
doubleValue,
doubleValue,
longValue,
"utf8StringValue",
"utf8StringValue",
longValue,
longValue
[JSON result data] plID:
pbStatus:		 longValue,
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
long
DATE
DATE
BSTR
BSTR
BSTR
double
double
double
double
double
ObligationType
BSTR
BSTR
YesNoType
long
long
VARIANT_BOOL 		bstrTariffType,
bstrCode,
bstrReferenceCode,
dQuantity,
lSessionNumber,
dDateBegin,
dDateEnd,
bstrProviderEAN,
bstrResponsibleEAN,
bstrText,
dUnit,
dUnitFactor,
dExternalFactor,
dAmount,
dVatRate,
eIsObligatory,
bstrRemark,
bstrSectionCode,
eIgnoreValidate,
lServiceAttributes,
*plID,
*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 The official tariff type as defined by Forum Datenaustausch
[in] BSTR bstrCode The service code.
 
Important new feature: in order to control the underlying validators the feature of pseudo service codes bstrCode="setParameter(cmd=value)" have been defined, where cmd=value are validator specific.
[in] BSTR bstrReferenceCode The reference code if one must be supplied.
 
Supply an empty string if there is no reference code to set.
[in] double dQuantity The floating point quantity.
 
Note that quantity changes the sign if a storno request is produced.
[in] long lSessionNumber The session number - use a session value of 1 if no session concept is established for the used tariff
[in] DATE dDateBegin The date of the service's prescription
[in] DATE dDateEnd The date of the last prescription of the service if and only if the service was applied over a period of time.
 
dDateEnd is ignored if the condition (dDateEnd > dDateBegin+1) is not true! Therefore dDateEnd=0 is supplied for the vast majority of services.
[in] BSTR bstrProviderEAN EAN number of the service provider party.
 
Note if bstrProviderEAN is undefined and bstrResponsibleEAN is defined then bstrResponsibleEAN is copied into the bstrProviderEAN variable. If both variables are undefined the pseudo EAN "2099999999999" is set.
[in] BSTR bstrResponsibleEAN EAN number of the service responsible party.
 
Note if bstrResponsibleEAN is undefined and bstrProviderEAN is defined then bstrProviderEAN is copied into the bstrResponsibleEAN variable. If both variables are undefined the pseudo EAN "2099999999999" is set.
[in] BSTR bstrText The name of the service as defined by the used tariff
[in] double dUnit Tax points (TP) of the service.
[in] double dUnitFactor Tax point value (TPV) of the service.
[in] double dExternalFactor The external scaling factor used to scale the service e.g. to give a discount or surcharge.
 
In the case of a DRG service dExternalFactor is used to define any splitting situation!. If a 3-party splitting situation is described then dExternalFactor is the product of both splitting factors. The later 2 splitting factors are then defined and added by using the SetXtraDRG method!
[in] double dAmount The amount in CHF for the service.
 
Note that amount changes the sign if a storno request is produced due to the sign change of dQuantity.
[in] double dVatRate The VAT rate in percent or as real number that should be applied to this service.
[in] ObligationType eIsObligatory Obligatory enumerator indicating whether the given service record has a obligation status regarding the given law (UVG,KVG,...).
 
If the enumerator is set to enObligationAutomatic then the status is set internally using some ad hoc rules.
[in] BSTR bstrRemark An optional remark for the given service
 
Patch for populating service attributes
If service attribute keywords
{ Code207 | Franchisefree_12e_d |
drugOffLabelUse | withoutDoctorsOrder }
are supplied (case-independent) as part of the remark, than these keywords are migrated into the lServiceAttributes variable and thereafter removed from the remark.
Thus, this is an alternative method of setting lServiceAttributes - cf. below.
[in] BSTR bstrSectionCode An optional BfS section code where the service was applied as defined by Swiss Federal Statistical Office - this code is only given for eRoleType=enRoleHospital!
[in] YesNoType eIgnoreValidate Flag indicating whether the validation must be ignored that is whether the corresponding validator must be called or not.
 
This flag might be useful in the following situation: the user wants to add the service even if the validation failed, perhaps he has a special agreement with the insurance or patient.
[in] long lServiceAttributes lServiceAttributes is a 32-bit integer where each bit position defines a special information.
 
Defined bit positions as of February 2021
Bit Meaning
Bit 1:
(0x000001)		 Code207: no drug substitution due to medical reasons. Applies to drug services only!
 
If this bit ("Code207") is set, the service provider declares that the drug prescribed must not be substituted due to medical reasons.
Bit 2:
(0x000002)		 franchisefree_12e_d: Franchise exemption according to Art. 12e lit. D KLV
 
If this bit ("franchisefree_12e_d") is set, the service provider declares that the service was prescribed as part of a preventive care program and the health care company must bill this service as franchise-free.
[out] long *plID This is the returned internal ID of the service record.
 
This internal ID is used to append extra drug or DRG information to this service with the SetXtraDrug or SetXtraDRG methods, respectively.
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
space