and fills out a PDF based form system
IGeneralFormRequest::AddNumericResult method | |||
---|---|---|---|
Adds a numerical result structure to the list of numerical result structures.
Such a result structure can be from the clinical as well as from the lab area but is inherently of numerical nature. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralFormRequest/AddNumericResult | ||
[JSON input data] | pIGeneralFormRequest: bstrStructName: eResultCodeType: bstrCode: bstrName: dDate: bstrValue: bstrUnit: bstrLowerReference: bstrUpperReference: bstrRemark: |
longValue, //interface address "utf8StringValue", longValue, "utf8StringValue", "utf8StringValue", variantDateValue | "stringISODateValue", "utf8StringValue", "utf8StringValue", "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 AddNumericResult( | BSTR
ResultCodeType BSTR BSTR DATE BSTR BSTR BSTR BSTR BSTR VARIANT_BOOL |
bstrStructName,
eResultCodeType, bstrCode, bstrName, dDate, bstrValue, bstrUnit, bstrLowerReference, bstrUpperReference, 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 numerical measurement value ASCII formatted - thus the full measurement result consist of eOperator*bstrValue*bstrUnit
Note that the formatting of numerical values in the PDF is cumbersome and partly impossible (no scientific notation available). Furthermore there is no possibility to extracted and propagate such formatting instructions from the PDF via the COM module to the calling software. Consequently, all values of the numerical result structure are supplied ASCII formatted to allow the calling software to supply the needed display formatting. E.g. the distant sphere in an eyeglass prescription should be formatted like "+ 1.25" which is impossible with a general formatting instruction. |
|
[in] BSTR | bstrUnit | The unit in which the all values are expressed - thus the full measurement result consist of eOperator*bstrValue*bstrUnit
While not imperative the unit is preferably supplied in the UCUM system. |
|
[in] BSTR | bstrLowerReference | The lower reference value ASCII formatted of the measurement expressed in the same unit as the value.
Supply an empty string if no lower reference value is available. |
|
[in] BSTR | bstrUpperReference | The upper reference value ASCII formatted of the measurement expressed in the same unit as for the value.
Supply an empty string if no upper reference value is available. |
|
[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. | |