API browser of tarmedValidator100 COM module


/images/arrow_right.png ICatalog::GetQualitativeDignities method space
This method has a Restful Webservice representation only!
Method for collecting all qualitative dignity set of a certain code in one call without the necessity to call iterator pair GetFirstQualitativeDignity / GetNextQualitativeDignity.
 
The services are returned as JSON array however large that search space might be. So this might be a memory and performance bottleneck.
 
PATCH to request information if a given qualitative dignity qualifies as "FMH Specialist" dignity or not (cf. bstrCode argument).
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ICatalog/GetQualitativeDignities
[JSON input data] pICatalog:
bstrCode:
longValue,    //interface address
"utf8StringValue"
[JSON result array] { pbstrCode:
pbstrName:
peExclusive:
peQualitativeDignitySet:
pbStatus:
"utf8StringValue",
"utf8StringValue",
longValue,
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 Calling argument description
[in] BSTR bstrCode Qualitative dignity code to search for.
Use asterisk symbol (*) to search for all dignities.
 
PATCH: bstrCode can be appended with the instruction "#FMH" to request the additional information about the "FMH Specialist" status in the pbstrCode variable.
[out] BSTR *pbstrCode Qualitative dignity code.
 
PATCH: when additional information about the "FMH Specialist" status is requested, than the qualitative dignity is returned hash separated with the additional information tag
  • #FMH0 == dignity is not a "FMH Specialist" dignity
  • #FMH1 == dignity is a "FMH Specialist" dignity
[out] BSTR *pbstrName Qualitative dignity name.
[out] YesNoType *peExclusive A value of enYes indicates that during a session where the physician specifies this qualitative dignity, he can only report services which have a matching qualitative dignity. No services with another qualitative dignity are allowed, even if the physician has the required qualitative dignity as well.
[out] YesNoType *peQualitativeDignitySet A value of enYes indicates that the qualitative dignity code represents a dignity set code (see GetFirstQualitativeDignitySet).
[out,retval] VARIANT_BOOL *pbStatus Return status. VARIANT_TRUE means S_OK, VARIANT_FALSE means S_FALSE (e.g. in an iterator) or an error (E_name).
In the later case check for possible errors with the GetAbortInfo method.
space