Version: 2.1.19073
EventWS contains a set of methods to retrieve information from the event
table and to update state of an event.
All methods require a correct and verified authentication block from
AuthenticationWS to get/update any information from/in the HIS.
The EventWS web service contains these methods:
The web service reference is: EventWS.asmx
For more detailed information, e.g. the web service WSDL, SOAP request and
response see:
https://linkws.service.tieto.com/PasLinkWS/EventWS/EventWS.asmx
Applicable systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Method for getting a single event or listing events from the event table.
Syntax:
ListEventsResponse =
ListEvents(ListEventsRequest)
Request:
|
Parameter in ListEventsRequest |
Type |
Length byte |
Description – Data format – Valid data |
|
EventId |
String |
|
Event id used in search. If EventId contains a legal
value, a single event will be returned (if found). If EventId is blank or null,
MessageType and EventState must be filled out and will be used to filter
events. Format: integer value
identifying a single event. |
|
MessageType |
Enum |
|
Message type used for
filtering events. Legal message types are: NotSet – must not be
used PatientBooking – patient
bookings and showup PatientPay – patient
payment in BKM Patient – patient
information EconomyRefund – refunds for
BKM Economy – economy
transactions |
|
EventState |
Enum |
|
Event state used for
filtering events. Legal event statuses are: NOTSET – all event
states will be returned NEW – event is ready
for processing PROCESSING – event is being
processed SENT – event is
transferred to receiver ERROR – event has
failed during transfer RESEND – special status
used only in SaveEventStatus for resent event |
|
EventDates.FromDate |
DateTime |
|
From date/time used for
filtering events. If not given, today’s date
will be used with time set to 00:00:00. |
|
EventDates.ToDate |
DateTime |
|
To date/time used for
filtering events. If not given, today’s date
will be used with time set to 23:59:59. |
Example of returned parameters in ListEventsResponse:
|
Returned parameter ListEventsResponse |
Type |
Length Byte |
Description – Comments |
|
EventId |
String |
|
The internal id for the event. This id can be used with SaveEventState to update/set the
state on the event. |
|
MessageType |
Enum |
|
Message type This describes the main type
that the event belongs to Legal message types are: PatientBooking – patient
bookings and showup PatientPay – patient
payment in BKM Patient – patient
information EconomyRefund – refunds for BKM Economy – economy
transactions |
|
EventType |
Enum |
|
Type of event Legal event types are: New – New (e.g. new patient booking) Freepass – Patient’s freepass Meet – Meet (e.g. patient meet at booking) Cancelled - Cancelled Bill – Bill and economy |
|
EventState |
Enum |
|
Event state Legal event statuses are: NEW – event is ready
for processing PROCESSING – event is being
processed SENT – event is
transferred to receiver ERROR – event has
failed during transfer |
|
Date |
DateTime |
|
Date for the event |
|
Message.Id |
|
|
The id to the object that has changed and then resulted in
the event. To get full information/data that has changed this id must
be used wit another Web Sevice method. |
|
Message.TypeOfId |
|
|
Type of id in Message.Id. TypeOfId will give indications
which other web services and method that can be used |
|
Message.Text |
|
|
Description of the id HIS90: Not used yet |
|
AdditionalMessage.Id |
|
|
The id to the additional objects that has changed and then
resulted in the event. To get full information/data that has changed this id must
be used with another Web Sevice method. Please note that AdditionalMessage is a list/array of objects. |
|
AdditionalMessage.TypeOfId |
|
|
Type of id in AdditionalMessage.Id. TypeOfId will give indications
which other web services and method that can be used |
|
AdditionalMessage.Text |
|
|
Description of the id HIS90: Not used yet |
|
Registration.Institution.Id |
String |
|
Id of institution (hospital) that registered this record. |
|
Registration.Institution.TypeOfId |
String |
|
Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: Set to “LIN” by web service. |
|
Registration.Institution.ShortNameId |
String |
|
Short name of institution. HIS90: N/A |
|
Registration.Institution.Name |
String |
|
Name of institution. HIS90: N/A |
|
Registration.Date |
DateTime |
|
Insertion date of record. HIS90: Extracted from ticket (op block) by PAS server program. |
|
Registration.Name |
String |
|
Name of person responsible for registration of the record. HIS90: N/A |
|
Registration.Organization.Id |
String |
|
Code of organization that first registered this record. HIS90: Department id, extracted from ticket (op block) by PAS
server program. |
|
Registration.Organization.TypeOfId |
String |
|
Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: Set to “LAV” by web service. |
|
Registration.Organization.ShortNameId |
String |
|
Short name/code of organization. HIS90: N/A |
|
Registration.Organization.Name |
String |
|
Name of organization. HIS90: N/A |
|
Registration.SignedBy |
String |
|
Initials of person who originally created this record. HIS90: Extracted from ticket (op block) by PAS server program. |
|
Update.Institution.Id |
String |
|
Institution person who updated the record belongs to. HIS90: Set
by web service from record to be updated. |
|
Update.Institution.TypeOfId |
String |
|
Type of institution id. HIS90: Set to “LIN” by web service. |
|
Update.Institution.ShortNameId |
String |
|
Institution short name. HIS90: N/A |
|
Update.Institution.Name |
String |
|
Institution name. HIS90: N/A |
|
Update.Date |
DateTime |
|
Date and time when the
record was updated. HIS90: Set
by web service from record to be updated. |
|
Update.Name |
String |
|
Name
of person who updated the record. HIS90: N/A |
|
Update.Organization.Id |
String |
|
Organization that record to
be updated belongs to. HIS90: Set
by web service to department id from record to be updated. |
|
Update.Organization.TypeOfId |
String |
|
Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: Set to “LAV” by web service. |
|
Update.Organization.ShortNameId |
String |
|
Organization short name. HIS90: N/A |
|
Update.Organization.Name |
String |
|
Organization that updated record belongs to. HIS90: N/A |
|
Update.SignedBy |
String |
|
Initials of person who
updated the record. |
Schema for ListEvents: EventWS.xsd
Schema documentation for ListEvents: EventWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EventWS/EventWS.asmx?op=ListEvents
Related methods or functions used:
GetUserLogin Used
to verify user and get a valid authentication block in return.
Other references:
RequestHeader Information required calling a
method, containing authentication information.
ResponseHeader Information and messages returned
from the method, e.g. error codes/description,
system name or
version.
Comments:
To use this method the RequestHeader
must contain a valid authentication block, and system name is also required. An
error will result if any of these are missing.
A valid authentication block for RequestHeader
can be retrieved by using the method GetUserLogin
in the Authentication web service.
In the return from the method there will always be a ResponseHeader, which contains Error
Information and System Information. The Error Information block must always be
examined to determine if any error has occurred during execution of the method.
Applicable systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Method for changing the state of an existing event in the event table.
The ListEvents method can be used to get the event to be updated.
Syntax:
SaveEventStateResponse =
SaveEventState(SaveEventStateRequest)
Request:
|
Parameter in SaveEventStateRequest |
Type |
Length byte |
Description – Data format – Valid data |
||||
|
EventId |
String |
|
Event id used in search. Format: integer value
identifying a single event. |
|
|||
|
EventState |
Enum |
|
Desired event state to which
found event will be set. Legal event statuses are: NOTSET – shall not be
used, if used an error will be triggered NEW – set event
ready for processing, same as RESEND PROCESSING – set event to
processing SENT – set event to
transferred to receiver ERROR – set event to
error state RESEND – used to resend
event; will be set to NEW in database |
|
|||
|
StateMessage |
String |
|
Textual description of
status, e.g. error message. HIS90: Will not be saved, only
logged as a warning. |
|
|||
Allowed state transitions:
The following table lists all allowed transitions between event states. If
other transitions are used an error message will be returned and no update
performed.
|
Current event state |
|
Legal transitions |
|
NEW |
> |
PROCESSING, SENT, ERROR |
|
PROCESSING |
> |
SENT, ERROR, RESEND/NEW |
|
SENT |
> |
RESEND |
|
ERROR |
> |
RESEND |
Response:
The method returns only a ResponseHeader with an empty reply structure.
Schema for SaveEventState: EventWS.xsd
Schema documentation for SaveEventState: EventWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EventWS/EventWS.asmx?op=SaveEventState
Related methods or functions used:
GetUserLogin Used
to verify user and get a valid authentication block in return.
Other references:
RequestHeader Information required calling a
method, containing authentication information.
ResponseHeader Information and messages returned
from the method, e.g. error codes/description,
system name or
version.
Comments:
To use this method the RequestHeader
must contain a valid authentication block, and system name is also required. An
error will result if any of these are missing.
A valid authentication block for RequestHeader
can be retrieved by using the method GetUserLogin
in the Authentication web service.
In the return from the method there will always be a ResponseHeader, which contains Error
Information and System Information. The Error Information block must always be
examined to determine if any error has occurred during execution of the method.
NOTE: Only interface description is delivered in the EventWS. Method is not
implemented fully and will give “Method not implemented yet!” error if used.
Applicable systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Method for saving (inserting/updating) an event.
Syntax:
SaveEventResponse = SaveEvent(SaveEventRequest)
Request:
|
Parameter in SaveEventRequest |
Type |
Length byte |
Description – Data format – Valid data |
|
EventId |
String |
|
The internal id for the event. This id can be used with SaveEventState to update/set the
state on the event. Note:
EventId is only set for updating an existing event. For inserting a new event
leave this blank or null. |
|
MessageType |
Enum |
|
Message type This describes the main type
that the event belongs to Legal message types are: PatientBooking – patient
bookings and showup PatientPay – patient
payment in BKM Patient – patient
information EconomyRefund – refunds for BKM Economy – economy
transactions |
|
EventType |
Enum |
|
Type of event Legal event types are: New – New (e.g. new patient booking) Freepass – Patient’s freepass Meet – Meet (e.g. patient meet at booking) Cancelled - Cancelled Bill – Bill and economy |
|
EventState |
Enum |
|
Event state Legal event statuses are: NEW – event is ready
for processing PROCESSING – event is being
processed SENT – event is
transferred to receiver ERROR – event has
failed during transfer |
|
Date |
DateTime |
|
Date for the event |
|
Message.Id |
|
|
The id to the object that has changed and then resulted in
the event. To get full information/data that has changed this id must
be used wit another Web Sevice method. |
|
Message.TypeOfId |
|
|
Type of id in Message.Id. TypeOfId will give indications
which other web services and method that can be used |
|
Message.Text |
|
|
Description of the id HIS90: N/A Not
used/leave null |
|
AdditionalMessage.Id |
|
|
The id to the additional objects that has changed and then
resulted in the event. To get full information/data that has changed this id must
be used with another Web Sevice method. Please note that AdditionalMessage is a list/array of objects. |
|
AdditionalMessage.TypeOfId |
|
|
Type of id in AdditionalMessage.Id. TypeOfId will give indications
which other web services and method that can be used |
|
AdditionalMessage.Text |
|
|
Description of the id HIS90: Not used yet |
|
Registration.Institution.Id |
String |
|
Id of institution (hospital) that registered this record. HIS90: N/A Not
used/leave null |
|
Registration.Institution.TypeOfId |
String |
|
Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: N/A Not
used/leave null Set to “LIN” by web service. |
|
Registration.Institution.ShortNameId |
String |
|
Short name of institution. HIS90: N/A Not
used/leave null |
|
Registration.Institution.Name |
String |
|
Name of institution. HIS90: N/A Not
used/leave null |
|
Registration.Date |
DateTime |
|
Insertion date of record. HIS90: N/A Not
used/leave null Extracted from ticket (op block) by PAS server program. |
|
Registration.Name |
String |
|
Name of person responsible for registration of the record. HIS90: N/A Not
used/leave null |
|
Registration.Organization.Id |
String |
|
Code of organization that first registered this record. HIS90: N/A Not
used/leave null Department id, extracted from ticket (op block) by PAS
server program. |
|
Registration.Organization.TypeOfId |
String |
|
Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: N/A Not
used/leave null Set to “LAV” by web service. |
|
Registration.Organization.ShortNameId |
String |
|
Short name/code of organization. HIS90: N/A Not
used/leave null |
|
Registration.Organization.Name |
String |
|
Name of organization. HIS90: N/A Not
used/leave null |
|
Registration.SignedBy |
String |
|
Initials of person who originally created this record. HIS90: N/A Not
used/leave null Extracted from ticket (op block) by PAS server program. |
|
Update.Institution.Id |
String |
|
Institution person who updated the record belongs to. HIS90: N/A Not
used/leave null Set
by web service from record to be updated. |
|
Update.Institution.TypeOfId |
String |
|
Type of institution id. HIS90: N/A Not
used/leave null Set to “LIN” by web service. |
|
Update.Institution.ShortNameId |
String |
|
Institution short name. HIS90: N/A Not
used/leave null |
|
Update.Institution.Name |
String |
|
Institution name. HIS90: N/A Not
used/leave null |
|
Update.Date |
DateTime |
|
Date and time when the
record was updated. HIS90: N/A Not
used/leave null Set
by web service from record to be updated. |
|
Update.Name |
String |
|
Name
of person who updated the record. HIS90: N/A Not
used/leave null |
|
Update.Organization.Id |
String |
|
Organization that record to
be updated belongs to. HIS90: N/A Not
used/leave null Set
by web service to department id from record to be updated. |
|
Update.Organization.TypeOfId |
String |
|
Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: N/A Not
used/leave null Set to “LAV” by web service. |
|
Update.Organization.ShortNameId |
String |
|
Organization short name. HIS90: N/A Not
used/leave null |
|
Update.Organization.Name |
String |
|
Organization that updated record belongs to. HIS90: N/A Not
used/leave null |
|
Update.SignedBy |
String |
|
Initials of person who
updated the record. HIS90: N/A Not
used/leave null |
Response:
Example of returned parameters in SaveEventResponse:
|
Returned parameter SaveEventResponse |
Type |
Length Byte |
Description – Comments |
|
See ListEvents response for details about the
SaveEvent reponse as they are equal |
|
|
|
|
|
|
|
|
Schema for SaveEvent: EventWS.xsd
Schema documentation for SaveEvent: EventWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EventWS/EventWS.asmx?op=SaveEvent
Related methods or functions used:
GetUserLogin Used
to verify user and get a valid authentication block in return.
Other references:
RequestHeader Information required calling a
method, containing authentication information.
ResponseHeader Information and messages returned
from the method, e.g. error codes/description,
system name or
version.
Comments:
To use this method the RequestHeader
must contain a valid authentication block, and system name is also required. An
error will result if any of these are missing.
A valid authentication block for RequestHeader
can be retrieved by using the method GetUserLogin
in the Authentication web service.
In the return from the method there will always be a ResponseHeader, which contains Error
Information and System Information. The Error Information block must always be
examined to determine if any error has occurred during execution of the method.
NOTE: Only interface description is delivered in the EventWS. Method is not
implemented fully and will give “Method not implemented yet!” error if used.
Applicable systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Method for getting a single event or listing events from the event table.
Syntax:
DeleteEventResponse = DeleteEvent(DeleteEventRequest)
Request:
|
Parameter in DeleteEventRequest |
Type |
Length byte |
Description – Data format – Valid data |
|
EventId |
String |
|
Event id to delete Format: integer value
identifying a single event. |
Response:
Example of returned parameters in DeleteEventResponse:
|
Returned parameter DeleteEventResponse |
Type |
Length Byte |
Description – Comments |
|
Only Error code in ResponseHeader.ErrorInformation block if
delete succeded or failed |
|||
Schema for DeleteEvent: EventWS.xsd
Schema documentation for DeleteEvent: EventWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EventWS/EventWS.asmx?op=DeleteEvent
Related methods or functions used:
GetUserLogin Used
to verify user and get a valid authentication block in return.
Other references:
RequestHeader Information required calling a
method, containing authentication information.
ResponseHeader Information and messages returned
from the method, e.g. error codes/description,
system name or
version.
Comments:
To use this method the RequestHeader
must contain a valid authentication block, and system name is also required. An
error will result if any of these are missing.
A valid authentication block for RequestHeader
can be retrieved by using the method GetUserLogin
in the Authentication web service.
In the return from the method there will always be a ResponseHeader, which contains Error
Information and System Information. The Error Information block must always be
examined to determine if any error has occurred during execution of the method.
All three
parameters MessageType, EventType and EventState are enumerators in EventWS
with fixed values.
The
combination of MessageType and EventType must be used to see what the event is
for.
|
EventMessageTypes in WS |
Use |
Comment |
|
NotSet |
Only set by WS internally |
Not for external use, if
this is received from WS method it indicates bad data in database |
|
PatientBooking |
Patient bookings |
HIS90: Patient booking, meet and
cancelled bookings |
|
PatientPay |
Patient economy/BKM |
HIS90: Patient economy/payment for
BKM |
|
Patient |
Patient generic |
HIS90: Patient information, e.g.
freepass |
|
EconomyRefund |
Ecoomy refunds |
HIS90: Economy refunds for BKM |
|
Economy |
Economy generic |
HIS90: Economy transactions |
|
EventTypeTypes in WS |
Use |
Comment |
|
NotSet |
Only set by WS internally |
Not for external use, if
this is received from WS method it indicates bad data in database |
|
New |
New/change event |
|
|
Freepass |
Patient freepass |
|
|
Meet |
Meet event |
|
|
Cancelled |
Cancelled event |
|
|
Bill |
Bill event |
|
|
Change |
Change of records/data. E.g. change of patient
demographics |
|
|
OfficialIdChange |
Change of patients official
id |
|
|
Merge |
Mergs of records/data. E.g. merge of two patient
records |
|
|
EventStateTypes in WS |
Use |
Comment |
|
NotSet |
Only set by WS internally |
Not for external use, if
this is received from WS method it indicates bad data in database |
|
NEW |
New |
New state, evnet can be
processed |
|
PROCESSING |
Processing |
Event is in processing or
sending |
|
SENT |
Sent/Ok |
Event is processed/sent ok
without any errors |
|
ERROR |
Error |
An error occurred when event
was processed/sent |
|
RESEND |
Resend |
Resen evenet, only used with
SaveEventState method |
Valid
combinations of MessageType, EventType and EventState for HIS90 PAS are:
|
EventMessageTypes |
EventTypeTypes |
EventStateTypes |
Message.Id in WS |
Message. TypeOfId in WS |
Comment |
|
PatientBooking |
New |
NEW * |
BookingId |
BookingId |
New
booking for a patient. Returns a
BookingId/WaitingListId in Id |
|
PatientBooking |
Meet |
NEW * |
BookingId |
BookingId |
Patient
meets at booking. Returns a
BookingId/WaitingListId in Id |
|
PatientBooking |
Cancelled |
NEW * |
BookingId |
BookingId |
Booking
cancelled. Returns a BookingId/WaitingListId in Id |
|
PatientPay |
Bill |
NEW * |
BKM_Id |
BKMId |
Only used
in BKM solution. |
|
EconomyRefund |
Bill |
NEW |
BKM_Id |
BKMId |
Only used
in BKM solution. |
|
Patient |
FREE |
NEW * |
Official
id (Fødselsnummer) in format DDMMYYNNNNN |
FNR |
Free pass
(Frikort) update for an patient. Returns official
id for the patient that shall have free pass update/check. (E.g. get free
pass info from ELFO) |
|
Patient |
CHANGE |
NEW * |
Patient
id in format NNNNNNNNN |
PID |
Patient’s
demographics has changed |
|
Patient |
OfficialIdChange |
NEW * |
Patient
id in format NNNNNNNNN |
PID |
Patient’s
official id has changed |
|
Patient |
Merge |
NEW * |
Patient
id in format NNNNNNNNN |
PID |
Patient’s
records have been merged |
|
Economy |
BILL |
NEW |
BillNumberId |
BillNumberId |
BillnumberId Returns an Id to the
bill for a patient for a contact. The BillNumberId is a
combined id containing bill number, source of service, user’s printer
department no and user’s giro printer code. See HIS90 combined id
documentation for complete definition of the BillNumberId. Using this with
EconomyWS can give all economy transaction on the BillNumberId and contact. |
* Use of PROCESSING,
SENT or ERROR with the events marks with * is possible to set states on the
event. This is not tested yet, but there are no technical problems using these
three extra states, other than the external systems using/handling the event
must set/handle these. In future releases of event functionality cleanup of the
event will be based on the states sett correctly.