pushAdminMessage COM module is a data
exchange system for treatment messages
exchange system for treatment messages
API browser of pushAdminMessage450 COM module
IPushAdminMessageRequest::SetMessage4Stationary method | |||
---|---|---|---|
Sets and defines the primary administrative message parameters for a stationary treatment. | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/IPushAdminMessageRequest/SetMessage4Stationary | ||
[JSON input data] | pIPushAdminMessageRequest: eMessageAction: dMessageDate: eTreatmentReason: eHospitalizationType: eHospitalizationMode: eHospitalizationClass: bstrSectionMajor: bstrBfSResidenceCode: |
longValue, //interface address longValue, variantDateValue | "stringISODateValue", longValue, longValue, longValue, longValue, "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 SetMessage4Stationary( | MessageActionType
DATE TreatmentReasonType HospitalizationType HospitalizationModeType HospitalizationClassType BSTR BSTR VARIANT_BOOL |
eMessageAction,
dMessageDate, eTreatmentReason, eHospitalizationType, eHospitalizationMode, eHospitalizationClass, bstrSectionMajor, bstrBfSResidenceCode, *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] MessageActionType | eMessageAction | The message action is the principle action of message encoded by the MessageActionType enumeration | |
[in] DATE | dMessageDate | The message date is the date and time when the message's action is performed/defined almost like 'message_type::message_action@message_date' | |
[in] TreatmentReasonType | eTreatmentReason | The treatment reason given by the TreatmentReasonType enumeration | |
[in] HospitalizationType | eHospitalizationType | The type/reason of hospitalization given by the HospitalizationType enumeration | |
[in] HospitalizationModeType | eHospitalizationMode | The mode/indication of hospitalization given by the HospitalizationMode enumeration. | |
[in] HospitalizationClassType | eHospitalizationClass | The hospitalization class given by the HospitalizationClass enumeration. | |
[in] BSTR | bstrSectionMajor | The optional Major BfS Section Code as defined by Swiss Federal Statistical Office. Note that depending on the message action this is the admission or discharge section. | |
[in] BSTR | bstrBfSResidenceCode | The optional BfS Residence Code supplies information about a BfS-coded residence where the patient is coming from or going to dependent on the message's action. The attribute is formatted as bfs_residence_code=value, where bfs_residence_code is a variable of the medical statistics specification defined by the Swiss Federal Statistical Office and the value is a legal datum of its variable space, e.g. "1.2.V02=3" for defining the residence before admission=nursing home or "1.5.V03=1" for defining the residence after discharge=home. Please note, that the content is neither case-sensitive nor whitespace-dependent. |
|
[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. | |