The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormRequest450 COM module
IGeneralFormRequest::AddTextResult method | |||
---|---|---|---|
Adds a textual result structure to the list of textual result structures.
Such a result structure can be from the clinical as well as from the lab area but is inherently of textual nature. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralFormRequest/AddTextResult | ||
[JSON input data] | pIGeneralFormRequest: bstrStructName: eResultCodeType: bstrCode: bstrName: dDate: bstrValue: bstrReference: bstrRemark: |
longValue, //interface address "utf8StringValue", longValue, "utf8StringValue", "utf8StringValue", variantDateValue | "stringISODateValue", "utf8StringValue", "utf8StringValue", "utf8StringValue" |
|
[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. | ||
C/C++ calling syntax | |||
HRESULT AddTextResult( | BSTR
ResultCodeType BSTR BSTR DATE BSTR BSTR BSTR VARIANT_BOOL |
bstrStructName,
eResultCodeType, bstrCode, bstrName, dDate, bstrValue, bstrReference, bstrRemark, *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. | ||
Calling argument description | |||
[in] BSTR | bstrStructName | The variable name/placeholder of the structure.
Use the iterator pair GetFirstStructRole / GetNextStructRole to retrieve the variable name, the semantical typification and the status (defined or undefined) of all structures defined by the currently load PDF form. |
|
[in] ResultCodeType | eResultCodeType | The used coding system in which the result is defined. | |
[in] BSTR | bstrCode | The code of the measurement defined in the used coding system.
While not imperative the preferable coding system for lab results is LOINC and SMERF for clinical results. Especially for lab results LOINC is the only guarantee that identifies lab measurements unambiguously and lab company independent. |
|
[in] BSTR | bstrName | The name of the measurement. | |
[in] DATE | dDate | The date of the measurement. | |
[in] BSTR | bstrValue | The textual value of the measurement. | |
[in] BSTR | bstrReference | An optional reference of any kind that further qualifies the given result value. | |
[in] BSTR | bstrRemark | An optional remark | |
[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. | |