pushAdminMessage COM module is a data
exchange system for treatment messages
exchange system for treatment messages
API browser of pushAdminMessage500 COM module
| Sets and defines the primary administrative message parameters for a stationary treatment. | |||
| [POST] | /baseURL/IPushAdminMessageRequest/SetMessage4Stationary | ||
| [JSON input data] | pIPushAdminMessageRequest: eMessageAction: dMessageDate: eTreatmentReason: eHospitalizationType: eHospitalizationMode: eHospitalizationClass: bstrSectionMajor: eResidenceCode: |
longValue, //interface address longValue, variantDateValue | "stringISODateValue", longValue, longValue, longValue, longValue, "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. | ||
| HRESULT SetMessage4Stationary( | MessageActionType
DATE TreatmentReasonType HospitalizationType HospitalizationModeType HospitalizationClassType BSTR ResidenceCodeType VARIANT_BOOL |
eMessageAction,
dMessageDate, eTreatmentReason, eHospitalizationType, eHospitalizationMode, eHospitalizationClass, bstrSectionMajor, eResidenceCode, *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. | ||
| [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 bstrSectionCode stems from a variable set defined by "OAAT-OTMA - Reglement Fachbereiche", that designates the service-providing department within a hospital or medical practice, e.g. 'M100.06' for the gastroenterology department.
The list of all departments is documented elsewhere on the "OAAT-OTMA" website, whereby the tariffs used, the law applied or special contracts stipulates the application/usage of the section code (primarily for body@role=hospital, body@role=rehab_clinic, body@role=psychiatric_clinic). |
|
| [in] ResidenceCodeType | eResidenceCode | The ResidenceCode defines the relevant admission or discharge location where the patient stayed before admission or is discharged to, encoded by the ResidenceCode enumeration.
Please note that if eMessageAction=enActionStart, the ResidenceCode specifies an admission location, while eMessageAction=enActionEnd forces a ResidenceCode that corresponds to a discharge location. |
|
| [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. | |