The ATL COM module generalNotification is a structured
message exchange protocol between to healthcare partners
message exchange protocol between to healthcare partners
API browser of generalnotification451 COM module
IGeneralNotificationRequest::SetPatient method | |||
---|---|---|---|
Sets the primary parameters and structured address of the patient if a patient is involved in the notification thread. This is in principle true as soon as a dependent object reference is defined. In reverse this means that a dependent object reference must be defined as soon as a patient is defined.
The address is defined via an instance of the IAddress interface and the address data must be defined prior to call the SetPatient method. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationRequest/SetPatient | ||
[JSON input data] | pIGeneralNotificationRequest: eSexType: dBirthdate: bstrSSN: pIAddress: |
longValue, //interface address 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. | ||
C/C++ calling syntax | |||
HRESULT SetPatient( | SexType
DATE BSTR IAddress VARIANT_BOOL |
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. | ||
Calling argument description | |||
[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:
|
|
[in] IAddress | *pIAddress | The instance of a IAddress interface 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. | |