API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormRequest::SetPatient method space
Sets the primary parameters and structured address of the patient.

The address is defined via an IAddress interface pointer and the address data must be defined prior to call this method.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormRequest/SetPatient
[JSON input data] pIGeneralFormRequest:
bstrAddressName:
eSexType:
dBirthdate:
bstrSSN:
pIAddress:
longValue,    //interface address
"utf8StringValue",
longValue,
variantDateValue | "stringISODateValue",
"utf8StringValue",
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 SetPatient( BSTR
SexType
DATE
BSTR
IAddress
VARIANT_BOOL
bstrAddressName,
eSexType,
dBirthdate,
bstrSSN,
*pIAddress,
*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 bstrAddressName NOT_YET
[in] SexType eSexType The patient's gender.
[in] DATE dBirthdate The patient's birthdate.
[in] BSTR bstrSSN Defines the social security number (SSN) of the patient whereupon 3 distinguished types are allowed: The SSN can be supplied in its printed (with dots) or electronic (only digits) form.
[in] IAddress *pIAddress Pointer to an IAddress interface instance that holds the structured address parts.
[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