Version: 2.1.17180
The Web
Service includes methods related to booking.
The
BookingWS Web Service contains these methods:
The Web Service reference is: BookingWS.asmx
For more
detailed information on the web service's WSDL, SOAP request and response see:
https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx
BookingWS
uses two expressions when booking time for visit/treatment; “appointment” and
“schedule slot”. These are the same but are used in different contexts.
Appointment
is used for the patient context.
Schedule
slot is used in context with a resource or organization unit.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists appointments according to search criteria.
Syntax:
AppointmentCollection = ListAppointments(ResourceId,
FromDate, ToDate)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
ResourceId |
Numeric |
4 |
The resource id. |
|
FromDate |
DateTime |
N/A Dynamic |
Used to search within a
date interval. |
|
ToDate |
DateTime |
N/A Dynamic |
Used to search within a
date interval. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
AppointmentCollection |
|
N/A Dynamic |
Appointment collection
class according to XML schema Appointment.xsd. |
Schema for AppointmentCollection: Appointment.xsd
Schema
documentation for Appointment: Appointment.html
Sample xml
file for Appointment: Appointment.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=ListResourceAppointments
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be
raised if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Gets data about one patient. A search can be made
using either the internal patient id or the official id.
Syntax:
Resources
= ListBookedResources(UnitId, FromDate, ToDate)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
UnitId |
Number |
4 |
Internal unique unit id. |
|
FromDate |
DateTime |
N/A Dynamic |
Used to search within a
date interval. |
|
ToDate |
DateTime |
N/A Dynamic |
Used to search within a
date interval. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
Resource
Collection |
|
N/A Dynamic |
Resource collection
class according to XML schema Resources.xsd. |
Schema for Resources: Resources.xsd
Schema
documentation for Resources: Resources.html
Sample xml
file for Resources: Resources.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=ListBookedResources
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be
raised if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
The method is used for listing pasient appointments. The search can be
filtered on department, unit, section and/or period. If not filtered then
patient appointments are listed across organization units.
For HIS90 actual appointments booked, active waiting list (without
booking/visit time) and suspended waiting lists are listed in ListPatientAppointments.
Syntax:
ListPatientAppointmentsResponse
= ListPatientAppointments(ListPatientAppointmentsRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
ListPatientAppointmentsRequest |
|
N/A Dynamic |
Request
class according to XML schema in Booking.xsd. |
|
Description: |
|
|
|
|
PatientId |
|
|
Patient’s id. Mandatory field. Patient id’s can be found by using PatientWS.ListPatients
or PatientWS.GetPatient. |
|
From |
|
|
Search period from date and time. The period starts
on given date and time. Defaulted to current date/time if not provided. |
|
To |
|
|
Search period to date and time. The period ends on given
to date and time. Defaulted to current date/time if not provided. |
|
Organization.MedicalUnit.Id |
|
|
Restrict search/list to patient appointments in a
selected medical unit/department. MedicalUnit.Id’s can
be found by using OrganizationWS.ListOrganizations or OrganizationWS.GetOrganization2G. |
|
Organization.CareUnit.Id |
|
|
Restrict search/list to patient appointments in a
selected care unit. When selecting a care unit a department must also be
selected. CareUnit.Id’s can
be found by using OrganizationWS.ListOrganizations or OrganizationWS.GetOrganization2G. |
|
Organization.Section.Code |
|
|
Restrict search/list to patient appointments in a
selected section. When selecting a section a department must also be
selected. Section
codes can be found by using OrganizationWS.ListOrganizations or OrganizationWS.GetOrganization2G. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
ListPatientAppointmentsResponse |
|
N/A Dynamic |
Response class according to XML schema in Booking.xsd. |
|
Description: |
|
|
|
|
Id.OfficialId.Value |
|
|
Official
id. |
|
Id.OfficialId.TypeOfId |
|
|
Type
of id above. Legal values F or N. See PatientWS for details about
TypeOfId. |
|
Id.OfficialId.FormattedId |
|
|
Official
id formatted for viewing. |
|
Id.PatientId |
|
|
Internal
patient id. |
|
Name.FormattedName |
|
|
Formatted
patient name: last name, first name middle name. |
|
Appointment.Id |
|
|
Internal
id of the appointment/booking. HIS90: Combined
id BookingId, based on the patient id and the serial number assigned by the
system to identify the appointment. Format:
PatientId|BookingNo |
|
Appointment.ContactId |
|
|
Used
only if the appointments are related to a contact. HIS90: Combined
id: ContactId |
|
Appointment.CarePeriodId |
|
|
Internal
id of the care period the appointment/booking belongs to. An
id used to identify associated appointments, waiting lists or referrals. |
|
Appointment.From |
|
|
Planned start date/time of a booking by patient
responsible. Note - If the appointment is suspended/postponed
(see Status.Code) the From and To date will contain the original start
date/time of the appointment (not the new date/time). |
|
Appointment.To |
|
|
If an appointment is scheduled then this gives end
time for booking by patient responsible. Note - If the appointment is suspended/postponed
(see Status.Code) the From and To date will contain the original end
date/time for the appointment (not the new date/time). |
|
Appointment.Type |
|
|
Type
of booking. HIS90: Valid
types are T1-T5 and OB. |
|
Appointment.Status.Code |
|
|
Status
code of an appointment (booking). HIS90: Valid
status codes: 1, 3 and 4 |
|
Appointment.Status.Text |
|
|
Status
text for an appointment (booking). HIS90: Valid
status texts are: -
(1) Active on waiting list -
(3) Active on waiting list with appointment
time (visit time) in place -
(4) Postponed appointment |
|
Appoinment.TypeOfCare.Code |
|
|
Type
of care code. Valid
codes are: I,
P or D |
|
Appoinment.TypeOfCare.Text |
|
|
Description
of type of care. HIS90: TypeOfCare: I = Inpatient (Inneliggende) P = OutPatient (Poliklinikk) D
= In hospital only at daytime (Dagbehandling) |
|
Appointment.Organization.MedicalUnit.Id |
|
|
Internal
id/number of the department responsible for the appointment. |
|
Appointment.Organization.MedicalUnit.ShortName |
|
|
Short
name/code of the department responsible for the appointment. |
|
Appointment.Organization.MedicalUnit.Name |
|
|
The
name of the department responsible for the appointment. |
|
Appointment.Organization.CareUnit.Id |
|
|
Internal
id/number of the care unit that is responsible for the appointment. |
|
Appointment.Organization.CareUnit.ShortName |
|
|
Short
name/code of the care unit responsible for the appointment. |
|
Appointment.Organization.CareUnit.Name |
|
|
The
name/description of the care unit that is responsible for the appointment. |
|
Appointment.Organization.Section.Code |
|
|
Code
for department section. |
|
Appointment.Organization.Section.Text |
|
|
Description
of the department section code. HIS90: N/A |
|
Appointment.Resources.Resource.ResourceId |
|
|
Internal
unique id identifying physicians or other resources reserved for the
appointment. HIS90: Combined
id for unique identification of a resource. |
|
Appointment.Resources.Resource.Id |
|
|
Internal
id identifying physicians or other resources reserved for the appointment. HIS90: N/A |
|
Appointment.Resources.Resource.From |
|
|
Planned start date/time of an appointment/booking on
the resource. |
|
Appointment.Resources.Resource.To |
|
|
If an appointment is scheduled then this gives end
time of the appointment/booking on the resource. |
|
Appointment.Resources.Resource.Code |
|
|
Code
identifying physicians or other resources reserved for the appointment. |
|
Appointment.Resources.Resource.Name |
|
|
Physician
name or description of other resource reserved for the appointment. |
|
Appointment.Resources.Resource.Type |
|
|
Type/category
of resources reserved for the appointment. HIS90: Valid
codes in PAQRECA. |
|
Appointment.Resources.Resource.MedicalUnit.Id |
|
|
Internal
id/number of the department that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.MedicalUnit.ShortName |
|
|
Short
name/code of the department that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.MedicalUnit.Name |
|
|
The
name of the department that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.CareUnit.Id |
|
|
Internal
id/number of the unit that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.CareUnit.ShortName |
|
|
Short
name/code of the unit that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.CareUnit.Name |
|
|
The
name of the unit that owns resources reserved for the appointment. |
|
Appointment.Resources.EvaluatedBy.Id |
|
|
Internal
id identifying responsible physician or other resource responsible for the
medical care or evaluation (review of the requisition/referral). HIS90: N/A |
|
Appointment.Resources.EvaluatedBy.Code |
|
|
Code
identifying responsible physician or other resource responsible for the
medical care or evaluation (review of the requisition/referral). |
|
Appointment.Resources.EvaluatedBy.Name |
|
|
Name
identifying responsible physician or other resource responsible for the
medical care or evaluation (review of the requisition/referral). |
|
Appointment.Resources.EvaluatedBy.Type |
|
|
Type/category
of resource. HIS90: Valid
codes in PAQRECA. |
|
Appointment.Requesters.Requester.Id |
|
|
Internal
id of the requester. HIS90: N/A |
|
Appointment.Requesters.Requester.Code |
|
|
Code
of who requested this service/booking. This
can either be an organization or a physican. -
1 (external or internal requester organization) -
2 (requesting physician) |
|
Appointment.Requesters.Requester.Name |
|
|
Name
of who requested this service/booking. -
[1] Name of requesting organization -
[2] Name of requesting physician |
|
Appointment.Requesters.Requester.Type |
|
|
Type of requester. HIS90: Valid values, description: 1: External institution (Ekstern
institusjon) 2: Health
station, medical centre (Helsestasjon, legesenter) 3:
External physician (Ekstern lege) 4: Internal
ward (Intern sengepost) 5:
Internal polyclinic (Intern poliklinikk) 6:
Internal physician (Intern lege) 7:
Nursing home (Aldershjem) |
Schema for ListPatientAppointments: Booking.xsd
Schema
documentation for ListPatientAppointments: Booking.html
Sample xml
file for ListPatientAppointments: ListPatientAppointmentsRequest.xml
and ListPatientAppointmentsResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=ListPatientAppointments
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be
raised if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
HIS90 spesific information:
Server used for the
method is CWBP01 and service code 54422.
Server is
only to list appointments that user is allowed to access according to
organization status and placement.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
The method is used for getting information about one selected
appointment.
ListPatientAppointments can be
used to find valid appointments for a patient.
Syntax:
GetAppointmentResponse
= GetAppointment(GetAppointmentRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
GetAppointmentRequest |
|
N/A Dynamic |
Request
class according to XML schema in Booking.xsd. |
|
Description: |
|
|
|
|
Id
|
|
|
Internal
id of the appointment/booking. HIS90: Combined
id BookingId. Based on the patient id and the serial number assigned by the
system to identify the appointment. Format:
PatientId|BookingNo |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
GetAppointmentResponse |
|
N/A Dynamic |
Response class according to XML schema in Booking.xsd. |
|
Description: |
|
|
|
|
Patient.Id |
|
|
Internal
patient id. |
|
Appointment.Id |
|
|
Internal
id of the appointment/booking. HIS90: Combined
id BookingId. Based on the patient id and the serial number assigned by the
system to identify the appointment. Format:
PatientId|BookingNo |
|
Appointment.CarePeriodId |
|
|
Internal
id of the care period the appointment/booking belongs to. An
id used to identify associated appointments, waiting lists or referrals. |
|
Appointment.Type |
|
|
Type
of booking. HIS90: Valid
types are T1-T5 and OB. |
|
Appointment.Status.Code |
|
|
Status
code of an appointment (booking). Valid
status codes: 1-9 |
|
Appointment.Status.Text |
|
|
Status
text of an appointment (booking). Valid
status codes and text: 1 - Aktivt på venteliste (Actively on waiting list) 2 - Slettet fra venteliste (Deleted from waiting list) 3 - Utsatt på venteliste (Suspended from waiting list) 4
- Time er satt/bestilt (Active on waiting list with appointment time (visit
time) in place) 5 - Slettet fra timebestilling (Deleted from waiting list deleted from status 4)) 6 - Ikke møtt (Did not meet) 7 - Ankommet poliklinikk (Arrived at policlinic) 8 - Ankommet sengepost (Arrived at inpatient clinic) 9
- Sperrekode prioritet 55 (Suspension, code 55) |
|
Appointment.VisitType.Code |
|
|
Type
of consultation. HIS90:
Patient_Type Use
CommonCodesWS.ListAdmitCodes
to list valid values. |
|
Appointment.VisitType.Text |
|
|
Description
of VisitType.Code. |
|
Appoinment.TypeOfCare.Code |
|
|
Type
of care code. Valid
codes are: I,
P or D |
|
Appoinment.TypeOfCare.Text |
|
|
Description
of type of care. HIS90: TypeOfCare: I = Inpatient (Inneliggende) P = OutPatient (Poliklinikk) D
= In hospital only at daytime (Dagbehandling) |
|
Appointment.From |
|
|
Planned start date/time of a booking by patient
responsible. Note - If the appointment is suspended/postponed
(see Status.Code) the From and To date will contain the original start
date/time of the appointment (not the new date/time). |
|
Appointment.To |
|
|
If an appointment is scheduled then this gives end
time of booking by patient responsible. Note - If the appointment is suspended/postponed
(see Status.Code) the From and To date will contain the original end
date/time of the appointment (not the new date/time). |
|
Appointment.PreviousVisits.PreviousVisit |
|
|
Previous
visit date/time. HIS90: In
case of cancelled or suspended visit
for out-patient this date is the planned appointment. Same as in
PaqBook.Visit_date, PaqBook.Visit_time |
|
Appointment.Group.Code |
|
|
Group
code. HIS90: Valid
codes are found in PAS table PAQGRUP. |
|
Appointment.FreeHospitalChoice |
|
|
If
treatment (booking) is due to Free Hospital Choice ( True =
Free choice False =
Not free choice Tag
missing/null = Not decided/patient has not made a choice (not asked) |
|
Appointment.Organization.MedicalUnit.Id |
|
|
Internal
id/number of the department that is responsible for the appointment. |
|
Appointment.Organization.MedicalUnit.ShortName |
|
|
Short
name/code of the department that is responsible for the appointment. |
|
Appointment.Organization.MedicalUnit.Name |
|
|
The
name of the department that is responsible for the appointment. |
|
Appointment.Organization.CareUnit.Id |
|
|
Internal
id/number of the care unit that is responsible for the appointment. |
|
Appointment.Organization.CareUnit.ShortName |
|
|
Short
name/code of the care unit that is responsible for the appointment. |
|
Appointment.Organization
CareUnit.Name |
|
|
The
name/description of the care unit that is responsible for the appointment. |
|
Appointment.Organization.Section.Code |
|
|
Code
for department section. Section defines a collection of CareUnits within one
MedicalUnit. |
|
Appointment.Organization.Section.Text |
|
|
Description
of the department section code. HIS90: N/A |
|
Appointment.Resources.Resource.ResourceId |
|
|
Internal
unique id identifying physicians or other resources reserved for the
appointment. HIS90: Combined
id for unique identification of a resource. |
|
Appointment.Resources.Resource.Id |
|
|
Internal
id identifying physicians or other resources reserved for the appointment. HIS90: N/A |
|
Appointment.Resources.Resource.From |
|
|
Planned start date/time for an appointment/booking on
the resource |
|
Appointment.Resources.Resource.To |
|
|
If an appointment is scheduled then this gives end
time of the appointment/booking on the resource |
|
Appointment.Resources.Resource.Code |
|
|
Code
identifying physicians or other resources reserved for the appointment. |
|
Appointment.Resources.Resource.Name |
|
|
Physician
name or description of other resource reserved for the appointment. |
|
Appointment.Resources.Resource.Type |
|
|
Type/category
of resources reserved for the appointment. HIS90: Valid
codes in PAQRECA. |
|
Appointment.Resources.Resource.MedicalUnit.Id |
|
|
Internal
id/number of the department that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.MedicalUnit.ShortName |
|
|
Short
name/code of the department that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.MedicalUnit.Name |
|
|
The
name of the department that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.CareUnit.Id |
|
|
Internal
id/number of the unit that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.CareUnit.ShortName |
|
|
Short
name/code of the unit that owns resources reserved for the appointment. |
|
Appointment.Resources.Resource.CareUnit.Name |
|
|
The
name of the unit that owns resources reserved for the appointment. |
|
Appointment.Resources.EvaluatedBy.Id |
|
|
Internal
id identifying responsible physician or other resource responsible for the
medical care or evaluation (review of the requisition/referral). HIS90: N/A |
|
Appointment.Resources.EvaluatedBy.Code |
|
|
Code
identifying responsible physician or other resource responsible for the
medical care or evaluation (review of the requisition/referral). |
|
Appointment.Resources.EvaluatedBy.Name |
|
|
Name
identifying responsible physician or other resource responsible for the
medical care or evaluation (review of the requisition/referral). |
|
Appointment.Resources.EvaluatedBy. Property |
|
|
Type/category
of resource. HIS90: Valid
codes in PAQRECA. |
|
Appointment.Requesters.Requester.Id |
|
|
Internal
id of the requester. HIS90: N/A |
|
Appointment.Requesters.Requester.Code |
|
|
Code
of who requested this service/booking. This
can either be an organization or a physican. -
1 (external or internal requester organization) -
2 (requesting physician) |
|
Appointment.Requesters.Requester.Name |
|
|
Name
of who requested this service/booking. -
[1] Name of requesting organization -
[2] Name of requesting physician |
|
Appointment.Requesters.Requester.Type |
|
|
Type of requester. HIS90: Valid values, description: 1: External institution (Ekstern
institusjon) 2: Health
station, medical centre (Helsestasjon, legesenter) 3:
External physician (Ekstern lege) 4:
Internal ward (Intern sengepost) 5:
Internal polyclinic (Intern poliklinikk) 6:
Internal physician (Intern lege) 7:
Nursing home (Aldershjem) |
|
Appointment.Reason |
|
|
Reason
for appointment, from referral and/or waiting list evaluation. |
|
Appointment.BookingText.Text |
|
|
Free
text used in confirmation letter to patient. HIS90: If
ICPC is registered in requisition then this is shown in booking_text_2 Then the
text has the following format: (Code
type) Code description |
|
Appointment.BookingText.TypeOfText |
|
|
Coded
description for type of HIS90: BT1
= Booking text 1 BT2
= Booking text 2 |
|
Appointment.Admission.ContactedDate |
|
|
Date
when patient is/was contacted about admittance. HIS90: Set
by server when letter is created. |
|
Appointment.Admission.ByPhone |
|
|
Admission
confirmed/done by phone HIS90: N/A |
|
Appointment.Admission.Letter.ToRequester.Code |
|
|
Code
used in letter of admission confirmation to requester. HIS90: Valid
code is found in PAQLETT using CommonCodesWS.ListLetterCodes. |
|
Appointment.Admission.Letter.ToRequester.Text |
|
|
Letter
description of code above. |
|
Appointment.Admission.Letter.ToPatient.Code |
|
|
Code
used in letter to in-patient confirming admittance. HIS90: Valid
code is found in PAQLETT using CommonCodesWS.ListLetterCodes. |
|
Appointment.Admission.Letter.ToPatient.Text |
|
|
Letter
code description of the code above. |
|
Appointment.Admission.Letter.TextToPatient.Text |
|
|
Free
text used in admittance letter. |
|
Appointment.Admission.Letter.TextToPatient.TypeOfText |
|
|
Coded
description of type of HIS90: LIT
= Letter in text |
|
Appointment.Update.Date |
|
|
Date
when waiting list instance was last modified. HIS90: Set
by server. |
|
Appointment.Update.Name |
|
|
Name
of updater. HIS90: N/A |
|
Appointment.Update.Organization.
Id |
|
|
Department
responsible for last modification of waiting list instance. HIS90: Internal
|
|
Appointment.Update.Organization.ShortNameId |
|
|
Department
code/short name. |
|
Appointment.Update.Organization.Name |
|
|
Department
name. |
|
Appointment.Update.SignedBy |
|
|
Initials
of user who modified waiting list instance. HIS90: Set
by server using information from security token. |
|
Appointment.Update.UpdateCount |
|
|
Count
used for concurrency testing when waiting list is updated. |
Schema for GetAppointment: Booking.xsd
Schema
documentation for GetAppointment: Booking.html
Sample xml
file for GetAppointment: GetAppointmentRequest.xml GetAppointmentsResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=GetAppointment
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be
raised if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
HIS90 spesific information:
Server used for the
method is CWBP03 and service PWS0815.
There is no
restriction regarding user access for this method.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
The method is used for listing a resource’s scheduled
slots giving the resource’s id as input. Filters for organization unit, from/to
date and scheduled slot status can be applied.
·
The
response returned is scheduled slots/appointments with patient information, from/to
date/time, scheduled slot status, booking status and main resource.
·
If
unit is not given in request the method will use the user’s default unit (according
to the ticket/security token given).
ListPatientAppointments can be
used to find valid appointments/scheduled slots for a patient.
Syntax:
ListScheduleByResourceResponse
= ListScheduleByResource(ListScheduleByResourceRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
ListScheduleByResourceRequest |
|
N/A Dynamic |
Request
class according to XML schema in Booking.xsd. |
|
Description: |
|
|
|
|
ResourceId |
String |
|
Internal
resource id. HIS90: Combined
id: DeptNo|ResourceCode |
|
TypeOfResourceId |
String |
|
Type
of id given in ResourceId. Valid
type is: LOC
= Local resource id |
|
Unit.Id |
String |
|
Unit
where the resource is currently working and for which schedule slots are
wanted. User must have access to the given unit. If
unit is blank/null then unit will the user’s default unit. |
|
Unit.TypeOfId |
String |
|
Type
of Unit.Id. Valid
type is: LEN
= Local care unit |
|
From |
DateTime |
|
From
date/time. |
|
To |
DateTime |
|
To
date/time. |
|
ScheduleslotStatusFilter |
Enum |
|
Filter
for filtering the different schedule slots on a resource. Multiple statuses
can be set to select scheduled slots with several statuses in the same
request. If
ScheduleslotStatusFilter is null/missing in request the default status is
BOOKED. Valid
filters are: -
ALL -
BOOKED -
BLOCKED -
FREE -
PAUSE |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
ListScheduleByResourceResponse ResourceSchedules.ResourceSchedule |
|
N/A Dynamic |
Response class according to XML schema in Booking.xsd. |
|
Description: |
|
|
|
|
ScheduleSlotId |
String |
|
Unique
id for a scheduled slot. Used
for getting or updating the specific scheduled slot with ListScheduleSlots or
SaveScheduleSlots methods. HIS90:
Combined ScheduleSlotId |
|
BookingId |
String |
|
Internal
appointment/booking id. HIS90: Combined
BookingId |
|
CarePeriod.CarePeriodId |
String |
|
Internal Care Period Id.
An id used to identify associated contacts or referrals. HIS90: Combined Id Ref format
PatientId|CapeNo |
|
CarePeriod.ClinicalArea.Code |
String |
|
Clinical
area. HIS90:
Fagområde |
|
CarePeriod.ClinicalArea.Text |
String |
|
Description
of clinical area code above |
|
CarePeriod.InDiagnosis.Id |
String |
|
Referral
diagnosis id. Use
CommonCodesWS.ListMedicalCodes to list all valid codes. HIS90: Combined
id PAQCAPE |
|
CarePeriod.InDiagnosis.Code |
String |
|
In
diagnosis code from medical register, e.g. ICD-10. HIS90: PAQCAPE |
|
CarePeriod.InDiagnosis.Text |
String |
|
Diagnosis name. |
|
CarePeriod.InDiagnosis.MedRegister.Id |
String |
|
Id
of medical register, e.g. ICD-10. HIS90: PAQREGI |
|
CarePeriod.InDiagnosis.MedRegister.Code |
String |
|
Medical
register code. HIS90: N/A |
|
CarePeriod.InDiagnosis.MedRegister.Text |
String |
|
Description of medical register. |
|
WaitingList.WaitingListId |
String |
|
Internal
waiting list id the scheduled slot/appointment/booking belongs to. HIS90: Combined
WaitingListId |
|
WaitingList.Reason |
String |
|
The
reason for the scheduled slot/appointment from the waiting list. |
|
WaitingList.Status.Code |
String |
|
Status
code for waiting list (booking in waiting list). Valid
status codes are: 1-9 |
|
WaitingList.Status.Text |
String |
|
Corresponding
status text for waiting list booking in waiting list). Valid status texts are: - (1) Aktivt på venteliste (Actively on waiting list) - (2) Slettet fra venteliste (Deleted from waiting list) - (3) Utsatt på venteliste (Suspended from waiting list) -
(4) Time er satt/bestilt (Active on waiting list
with appointment time visit time) in place) - (5) Slettet fra timebestilling (Deleted from waiting list deleted from status 4)) - (6) Ikke møtt (Did not meet) - (7) Ankommet poliklinikk (Arrived at policlinic) - (8) Ankommet sengepost (Arrived at inpatient clinic) -
(9) Sperrekode prioritet 55 (Suspension, code
55) |
|
WaitingList.VisitType.Code |
String |
|
Type
of consultation. HIS90:
Patient_Type Use
CommonCodesWS.ListAdmitCodes
to list valid values. |
|
WaitingList.VisitType.Text |
String |
|
Description
of VisitType.Code. |
|
WaitingList.ClinicalArea.Code |
String |
|
Clinical
area. If
not set on waiting list level then use clinical area from care period. HIS90:
Fagområde |
|
WaitingList.ClinicalArea.Text |
String |
|
Description
of clinical area code above |
|
WaitingList.InDiagnosis.Id |
String |
|
Referral
diagnosis id. Use
CommonCodesWS.ListMedicalCodes to list all valid codes. HIS90: Combined
id PAQBOOK |
|
WaitingList.InDiagnosis.Code |
String |
|
In
diagnosis code from medical register, e.g. ICD-10. HIS90: PAQBOOK |
|
WaitingList.InDiagnosis.Text |
String |
|
Diagnosis name. |
|
WaitingList.InDiagnosis.MedRegister.Id |
String |
|
Id
of medical register, e.g. ICD-10. HIS90: PAQREGI |
|
WaitingList.InDiagnosis.MedRegister.Code |
String |
|
Medical
register code. HIS90: N/A |
|
WaitingList.InDiagnosis.MedRegister.Text |
String |
|
Description of medical register. |
|
Contact.ContactId |
String |
|
Internal
ContactId if the appointment/booking has resulted in a contact. Normally
after patient has arrived. HIS90: Combined
ContactId. |
|
Contact.Status.Code |
String |
|
Status
of the contact. Valid values are: -
AK =
Active - Out-patient visit arrival registered (Aktiv - Ankomstregistrert) -
FB =
Treatment finished but not discharged (Ferdig behandlet, ikke utskrevet) - UT = Discharged - Out-patient visit
finished registered (Utskrevet - Besøksregistrert) - PM = Leave (Permisjon) - IM = No-meet (Ikke møtt) - SL = Visit deleted (Besøk slettet) |
|
Contact.Status.Text |
String |
|
Description
of the contact status. HIS90: Valid
values are: - Ankomstregistrert
(2): Arrival registered - Pasienten ikke møtt
(3): No-meet - Besøksregistrert (4):
Visit registered - Besøk makulert (5): Visit deleted |
|
Contact.Status.VisitStatus.Code |
String |
|
The
visit status of the contact. This
is a sub detail for the Status.Code. HIS90: Valid values are 2, 3, 4, 5. |
|
Contact.Status.VisitStatus.Text |
String |
|
The
description of the visit status code. |
|
ScheduleSlotStatus |
String |
|
Schedules
slot status type, tells what type of scheduled slot the resource is allocated
with. Valid
ScheduleSlotStatus are: -
BOOKED -
BLOCKED -
FREE -
PAUSE |
|
ScheduleSlotType |
String |
|
Type
of booking. HIS90: Valid
types are T1-T5 and OB. |
|
ScheduleSlotDescription |
String |
|
Appointment
reason/description. HIS90: Booking
reason from PAQREBO.REASON. |
|
OpenScheduleSlot |
Boolean |
|
Flag to indicate if the scheduled slot is based on
an open template. If open template, OpenScheduleSlot is set to TRUE. A scheduled slot with an open template can be split
into several scheduled slots/appointments when they are booked. A scheduled slot with a fixed template has a
predefined from and to time, so here the given scheduled slot is booked
entirely. If OpenSceduleSlot is NULL or false it is a fixed
template. |
|
OverBookingAllowed |
Int |
|
Number to indicate if overbooking is allowed for the
resource. If the scheduled slot is based on an open template
(see OpenScheduleSlot above) then OverBookingAllowed will give number of minutes the resource can be
overbooked on the given date. If the scheduled slot is based on a fixed template
(see OpenScheduleSlot above) then OverBookingAllowed will give number of scheduled slots for the
resource that are available for overbooking on the given date. |
|
ReservedToDate |
DateTime |
|
The date and time until when the scheduled slot is
reserved. As long as the scheduled slot is reserved it cannot be booked. If no reservation or the ReservedToDate is in the
past, ReservedToDate
will be NULL/missing in the response. |
|
From |
DateTime |
|
Planned start date/time for a booking by patient
responsible. Note - If the scheduled slot/appointment is
suspended/postponed (see Status.Code) the From and To date will contain the
original start date/time of the scheduled slot/appointment (not the new
date/time). |
|
To |
DateTime |
|
If a scheduled slot/appointment is scheduled then
this gives end time for booking by patient responsible. Note - If the scheduled slot/appointment is
suspended/postponed (see Status.Code) the From and To date will contain the
original end date/time of the scheduled slot/appointment (not the new
date/time). |
|
Patient.PatientId |
String |
|
Internal
Patient id. |
|
Patient.FormattedName |
String |
|
Patient’s name. |
|
Patient.BirthDate |
DateTime |
|
Patient’s birth date. |
|
Patient.Dead.DeathDate |
DateTime |
|
Patient’s
death date, if dead. |
|
Patient.Sex.Code |
String |
|
Patient’s
sex. Valid
values are: M = Male (Mann) K = Female (Kvinne) U = Unknown (Ukjent) |
|
Patient.Sex.OfficialCode |
String |
|
Patient’s
sex code. Valid
values are: 1 = Male (Mann) 2 = Female (Kvinne) 9 = Unknown (Ukjent) |
|
Patient.Sex.Text |
String |
|
Description of patient’s sex. |
|
Patient.Municipality.Code |
String |
|
Municipality
code. HIS90: Not used. |
|
Patient.Municipality.Name |
String |
|
Municipality
name. HIS90: Not used. |
|
Patient.PostalAdress.Code |
String |
|
Postal
address code (zip code). HIS90: Not used. |
|
Patient.PostalAdress.Name |
String |
|
Postal
address name (city). HIS90: Not used. |
|
Patient.Telecom. MobilePhoneNumber |
String |
|
Patient’s
mobile phone number. HIS90: Not used. |
|
Patient.Telecom.MobilePhoneReservation |
Boolean |
|
If
patient has reserved himself/herself that the mobile phone number can be
used. True: If
tag missing, i.e. mobile phone number can be used. False: Patient
has reserved against use of mobile phone number. HIS90: Not used. |
|
Resource.ResourceId |
|
|
Internal
unique id identifying physicians or other resources reserved for the scheduled
slot/appointment. HIS90: Combined
id for unique identification of a resource. |
|
Resource.TypeOfId |
|
|
Type
of id for ResourceId. Valid
values are: LOC
= local resource id for system |
|
Resources.Resource.Code |
|
|
Code
identifying physicians or other resources reserved for the scheduled
slot/appointment. |
|
Resources.Resource.Name |
|
|
Physician’s
name, or description of other resource reserved for the scheduled
slot/appointment. |
|
Resources.Resource.Property |
|
|
Type/category
of resource reserved for the scheduled slot/appointment. HIS90: Not
used. |
|
BookingText.Text |
|
|
Free
text used in referrall/waitinglist/booking |
|
BookingText.TypeOfText |
|
|
Coded
description of the text type. For valid codes see documentation. |
|
SendNotification.Code |
|
|
Sending
notfication to the patient. If not
set/null the no notifictaion is sent. Codes
are: Y
(YES) only patient N
(NO) no for both patients and relations R
Relations only A
All (both aptient and relations) |
|
SendNotification.Text |
|
|
Description
of notfication |
|
SendNotification.TypeOfNotification |
|
|
Type
of notification to send. Valid
values are: -
SMS -
Letter -
EMail |
Schema for ListScheduleByResource: Booking.xsd
Schema
documentation for ListScheduleByResource: Booking.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=ListScheduleByResource
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be
raised if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
HIS90 spesific information:
Server used for the
method is CWBR01 and service PWS1601.
There is no
restriction regarding user access for this method.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
·
The
method is used for listing scheduled slots at a medical/department or care unit
provided the unit id and type as input. Filters in from/to date and scheduled
slot status can be applied.
·
The
response contains scheduled slots with patient information, from/to date/time, scheduled
slot status, booking status and main resource.
·
If
unit is not provided in request the method will use the user’s default unit (according
to the ticket/security token).
·
If
a patient is booked on several resources one row for each resource will be
returned.
ListPatientAppointments can be
used to find valid appointments for a patient.
Syntax:
ListScheduleByOrgResponse
= ListScheduleByOrg(ListScheduleByOrgRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
ListScheduleByOrgRequest |
|
N/A Dynamic |
Request
class according to XML schema in Booking.xsd. |
|
Description: |
|
|
|
|
Unit.Id |
String |
|
Unit
where resource is currently working for which scheduled slots are wanted. User must have access to the
given unit. If
unit is blank/null then the user default unit will be used. Use
OrganizationWS.ListOrganizations2G or OrganizationWS.ListOrganizations
to list valid organizations. Required
parameter. |
|
Unit.TypeOfId |
String |
|
Type
of Unit.Id. Valid
values are: LAV
= medical/department unit LEN
= care unit Required
parameter. |
|
From |
DateTime |
|
From
date/time. |
|
To |
DateTime |
|
To
date/time. |
|
ScheduleslotStatusFilter |
Enum |
|
Filter
for filtering the different schedule slots on a resource. Multiple statuses
can be set to select scheduled slots with several statuses in the same
request. If
ScheduleslotStatusFilter is null/missing in request the default status is
BOOKED Valid
filters are: -
ALL -
BOOKED -
BLOCKED -
FREE -
PAUSE -
FirstEachResource |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
ListScheduleByOrgResponse ScheduleByOrgs.ScheduleByOrg |
|
N/A Dynamic |
Response class according to XML schema in Booking.xsd. |
|
Description: |
|
|
|
|
ScheduleSlotId |
String |
|
Unique
id for a scheduled slot. Used
for getting or updating the specific scheduled slot with ListScheduleSlots or
SaveScheduleSlots methods. HIS90: Combined
ScheduleSlotId |
|
BookingId |
String |
|
Internal
appointment/booking id. HIS90: Combined
BookingId |
|
CarePeriod.CarePeriodId |
String |
|
Internal Care Period Id.
An id used to identify associated contacts or referrals. HIS90: Combined Id Ref format
PatientId|CapeNo |
|
CarePeriod.ClinicalArea.Code |
String |
|
Clinical
area. HIS90:
Fagområde |
|
CarePeriod.ClinicalArea.Text |
String |
|
Description
of clinical area code above |
|
CarePeriod.InDiagnosis.Id |
String |
|
Referral
diagnosis id. Use
CommonCodesWS.ListMedicalCodes to list all valid codes. HIS90: Combined
id PAQCAPE |
|
CarePeriod.InDiagnosis.Code |
String |
|
In
diagnosis code from medical register, e.g. ICD-10. HIS90: PAQCAPE |
|
CarePeriod.InDiagnosis.Text |
String |
|
Diagnosis name. |
|
CarePeriod.InDiagnosis.MedRegister.Id |
String |
|
Id
of medical register, e.g. ICD-10. HIS90: PAQREGI |
|
CarePeriod.InDiagnosis.MedRegister.Code |
String |
|
Medical
register code. HIS90: N/A |
|
CarePeriod.InDiagnosis.MedRegister.Text |
String |
|
Description of medical register. |
|
WaitingList.WaitingListId |
String |
|
Internal
waiting list id the scheduled slot/appointment/booking belongs to. HIS90: Combined
WaitingListId |
|
WaitingList.Reason |
String |
|
The
reason for the scheduled slot/appointment from the waiting list. |
|
WaitingList.Status.Code |
String |
|
Status
code for waiting list (booking in waiting list). Valid
status codes are: 1-9 |
|
WaitingList.Status.Text |
String |
|
Corresponding
status text for waiting list booking in waiting list). Valid status texts are: - (1) Aktivt på venteliste (Actively on waiting list) - (2) Slettet fra venteliste (Deleted from waiting list) - (3) Utsatt på venteliste (Suspended from waiting list) -
(4) Time er satt/bestilt (Active on waiting list
with appointment time visit time) in place) - (5) Slettet fra timebestilling (Deleted from waiting list deleted from status 4)) - (6) Ikke møtt (Did not meet) - (7) Ankommet poliklinikk (Arrived at policlinic) - (8) Ankommet sengepost (Arrived at inpatient clinic) -
(9) Sperrekode prioritet 55 (Suspension, code
55) |
|
WaitingList.VisitType.Code |
String |
|
Type
of consultation. HIS90:
Patient_Type Use
CommonCodesWS.ListAdmitCodes
to list valid values. |
|
WaitingList.VisitType.Text |
String |
|
Description
of VisitType.Code. |
|
WaitingList.ClinicalArea.Code |
String |
|
Clinical
area. If
not set on waiting list level then use clinical area from care period. HIS90:
Fagområde |
|
WaitingList.ClinicalArea.Text |
String |
|
Description
of clinical area code above |
|
WaitingList.InDiagnosis.Id |
String |
|
Referral
diagnosis id. Use
CommonCodesWS.ListMedicalCodes to list all valid codes. HIS90: Combined
id PAQBOOK |
|
WaitingList.InDiagnosis.Code |
String |
|
In
diagnosis code from medical register, e.g. ICD-10. HIS90: PAQBOOK |
|
WaitingList.InDiagnosis.Text |
String |
|
Diagnosis name. |
|
WaitingList.InDiagnosis.MedRegister.Id |
String |
|
Id
of medical register, e.g. ICD-10. HIS90: PAQREGI |
|
WaitingList.InDiagnosis.MedRegister.Code |
String |
|
Medical
register code. HIS90: N/A |
|
WaitingList.InDiagnosis.MedRegister.Text |
String |
|
Description of medical register. |
|
Contact.ContactId |
String |
|
Internal
ContactId if the appointment/booking has resulted in a contact. Normally
after patient has arrived. HIS90: Combined
ContactId. |
|
Contact.Status.Code |
String |
|
Status
of the contact. Valid values are: -
AK =
Active - Out-patient visit arrival registered (Aktiv - Ankomstregistrert) -
FB =
Treatment finished but not discharged (Ferdig behandlet, ikke utskrevet) - UT = Discharged - Out-patient visit
finished registered (Utskrevet - Besøksregistrert) - PM = Leave (Permisjon) - IM = No-meet (Ikke møtt) - SL = Visit deleted (Besøk slettet) |
|
Contact.Status.Text |
String |
|
Description
of the contact status. HIS90: Valid
values are: - Ankomstregistrert
(2): Arrival registered - Pasienten ikke møtt
(3): No-meet - Besøksregistrert (4):
Visit registered - Besøk makulert (5): Visit deleted |
|
Contact.Status.VisitStatus.Code |
String |
|
The
visit status of the contact. This
is a sub detail for the Status.Code. HIS90: Valid values are 2, 3, 4, 5. |
|
Contact.Status.VisitStatus.Text |
String |
|
The
description of the visit status code. |
|
ScheduleSlotStatus |
String |
|
Schedules
slot status type, tells what type of scheduled slot the resource is allocated
with. Valid
ScheduleSlotStatus are: -
BOOKED -
BLOCKED -
FREE -
PAUSE |
|
ScheduleSlotType |
String |
|
Type
of booking. HIS90: Valid
types are T1-T5 and OB. |
|
ScheduleSlotDescription |
String |
|
Appointment
reason/description. HIS90: Booking
reason from PAQREBO.REASON. |
|
OpenScheduleSlot |
Boolean |
|
Flag to indicate if the scheduled slot is based on
an open template. If open template, OpenScheduleSlot is set to TRUE. A scheduled slot with an open template can be split
into several scheduled slots/appointments when they are booked. A scheduled slot with a fixed template has a
predefined from and to time, so here the given scheduled slot is booked
entirely. If OpenSceduleSlot is NULL or false it is a fixed
template. |
|
OverBookingAllowed |
Int |
|
Number to indicate if overbooking is allowed for the
resource. If the scheduled slot is based on an open template
(see OpenScheduleSlot above) then OverBookingAllowed will give number of minutes the resource can be
overbooked on the given date. If the scheduled slot is based on a fixed template
(see OpenScheduleSlot above) then OverBookingAllowed will give number of scheduled slots for the
resource that are available for overbooking on the given date. |
|
ReservedToDate |
DateTime |
|
The date and time until when the scheduled slot is
reserved. As long as the scheduled slot is reserved it cannot be booked. If no reservation or the ReservedToDate is in the
past, ReservedToDate
will be NULL/missing in the response. |
|
From |
DateTime |
|
Planned start date/time for a booking by patient
responsible. Note - If the scheduled slot/appointment is
suspended/postponed (see Status.Code) the From and To date will contain the
original start date/time of the scheduled slot/appointment (not the new
date/time). |
|
To |
DateTime |
|
If a scheduled slot/appointment is scheduled then
this gives end time for booking by patient responsible. Note - If the scheduled slot/appointment is
suspended/postponed (see Status.Code) the From and To date will contain the
original end date/time of the scheduled slot/appointment (not the new
date/time). |
|
Patient.PatientId |
String |
|
Internal
Patient id. |
|
Patient.FormattedName |
String |
|
Patient’s name. |
|
Patient.BirthDate |
DateTime |
|
Patient’s birth date. |
|
Patient.Dead.DeathDate |
DateTime |
|
Patient’s
death date, if dead. |
|
Patient.Sex.Code |
String |
|
Patient’s
sex. Valid
values are: M = Male (Mann) K = Female (Kvinne) U = Unknown (Ukjent) |
|
Patient.Sex.OfficialCode |
String |
|
Patient’s
sex code. Valid
values are: 1 = Male (Mann) 2 = Female (Kvinne) 9 = Unknown (Ukjent) |
|
Patient.Sex.Text |
String |
|
Description of patient’s sex. |
|
Patient.Municipality.Code |
String |
|
Municipality
code. HIS90: Not used. |
|
Patient.Municipality.Name |
String |
|
Municipality
name. HIS90: Not used. |
|
Patient.PostalAdress.Code |
String |
|
Postal
address code (zip code). HIS90: Not used. |
|
Patient.PostalAdress.Name |
String |
|
Postal
address name (city). HIS90: Not used. |
|
Patient.Telecom. MobilePhoneNumber |
String |
|
Patient’s
mobile phone number. HIS90: Not used. |
|
Patient.Telecom.MobilePhoneReservation |
Boolean |
|
If
patient has reserved himself/herself that the mobile phone number can be
used. True: If
tag missing, i.e. mobile phone number can be used. False:
Patient has reserved against use of mobile phone number. HIS90: Not used. |
|
Resource.ResourceId |
|
|
Internal
unique id identifying physicians or other resources reserved for the scheduled
slot/appointment. HIS90: Combined
id for unique identification of a resource. |
|
Resource.TypeOfId |
|
|
Type
of id for ResourceId. Valid
values are: LOC
= local resource id for system |
|
Resources.Resource.Code |
|
|
Code
identifying physicians or other resources reserved for the scheduled
slot/appointment. |
|
Resources.Resource.Name |
|
|
Physician’s
name, or description of other resource reserved for the scheduled
slot/appointment. |
|
Resources.Resource.Property |
|
|
Type/category
of resource reserved for the scheduled slot/appointment. HIS90: Not
used. |
|
BookingText.Text |
|
|
Free
text used in referrall/waitinglist/booking |
|
BookingText.TypeOfText |
|
|
Coded
description of the text type. For valid codes see documentation. |
|
SendNotification.Code |
|
|
Sending
notfication to the patient. If not
set/null the no notifictaion is sent. Codes
are: Y
(YES) only patient N
(NO) no for both patients and relations R
Relations only A
All (both aptient and relations) |
|
SendNotification.Text |
|
|
Description
of notfication |
|
SendNotification.TypeOfNotification |
|
|
Type
of notification to send. Valid
values are: -
SMS -
Letter -
EMail |
|
MedicalUnit.Id |
String |
|
Id of the medical/department unit
where the appointment is made. Use
OrganizationWS.GetOrganization2G
to get more informationan about the unit. |
|
MedicalUnit.TypeOfId |
String |
|
Type
of id above. For medical/department unit ‘LAV’ is the only valid value. |
|
MedicalUnit.ShortNameId |
String |
|
Code/shortname of the medical/department unit
where the appointment is made. |
|
MedicalUnit.Name |
String |
|
Name
of the medical/department unit where the appointment is made. |
|
CareUnit.Id |
String |
|
Id of the care unit where the
appointment is made. Use
OrganizationWS.GetOrganization2G
to get more information about the unit. |
|
CareUnit.TypeOfId |
String |
|
Type
of id above. For care unit ‘LEN’ is the only valid value. |
|
CareUnit.ShortNameId |
String |
|
Code/shortname of the care unit where the
appointment is made. |
|
CareUnit.Name |
String |
|
Name
of the care unit where the appointment is made. |
Schema for ListScheduleByOrg: Booking.xsd
Schema
documentation for ListScheduleByOrg: Booking.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=ListAppointmentsByOrg
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be
raised if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
HIS90 spesific information:
Server used for the
method is CWBR01 and service PWS1604.
There is no
restriction regarding user access for this method.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Gets a specific schedule slot or list of schedule
slots from a resource’s time book according to the search criteria. ListScheduleByResource
og ListScheduleByOrg must be run beforehand to find available bookings on the
resource or for resources in a department/unit.
Syntax:
ScheduleSlots = ListScheduleSlots(ListScheduleSlotsRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
ListScheduleSlotsRequest |
|
N/A Dynamic |
Request
class according to XSD schema in Booking.xsd. |
|
.ScheduleSlotId |
String |
Dynamic |
Gets a specific booking on a resource. ScheduleSlotId
is a combined value. Use BookingWS.ListSchedulesByResource
or BookingWS.ListSchedulesByResource
to get valid ScheduleSlotsId HIS90: Combined id consisting of:
DeptNo|ResourceCode|Period|RschDate|HourMin|SerialNoRebo. cfr. document PasLinkWS HIS90 combined id
definitions.doc. |
|
.WaitingListId |
String |
Dynamic |
Gets all bookings associated with a single
waiting list. WaitingListId is a combined value. Use WaitingListWS.ListWaitingLists
or WaitingListWS.ListWaitingListsByOrg
to get valid waiting lists. HIS90: Combined id consisting of: PatientId|BookingNo. cfr. document PasLinkWS HIS90 combined id
definitions.doc. |
|
.PatientId |
Int |
4 |
Gets all bookings on a single patient. Id of
patient. Use PatientWS.ListPatients
to get valid patientids. HIS90: Value consists of: PatientId. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
ListScheduleSlotsResponse |
|
N/A Dynamic |
Response
class according to XSD schema in Booking.xsd |
|
ScheduleSlots[] |
|
N/A Dynamic |
Collection of schedule
slots. |
|
.ScheduleSlotId |
String |
Dynamic |
Unique id identifying a
booking on a resource. Combined value. HIS90: Combined id consisting
of: DeptNo|ResourceCode|Period|RschDate|HourMin|SerialNoRebo. cfr. document PasLinkWS HIS90 combined id
definitions.doc. |
|
.NewScheduleSlotId |
String |
Dynamic |
Unique id identifying a
saved booking on a resource. Combined value. Used only for
SaveScheduleSlots. HIS90: Combined id consisting
of: DeptNo|ResourceCode|Period|RschDate|HourMin|SerialNoRebo. cfr. document PasLinkWS HIS90 combined id
definitions.doc. |
|
.ScheduleSlotSequence |
Int |
4 |
Sequence of bookings.
For rebooking this can be 0. HIS90: Indirectly, sequence of
bookings on resources, as booking id is resource specific, if resource is 1,
2 or 3 in PAQBOOK. |
|
.WaitingList.WaitingListId |
String |
Dynamic |
Waiting list id.
Mandatory when creating booking on patient. Can be omitted when updating
existing booking or rebooking, as it will be got from the existing booking.
Patient id and booking no is got from waiting list id, a combined id, cfr.
document PasLinkWS HIS90 combined id
definitions.doc. |
|
.WaitingList. BookingText[].Text |
String |
Dynamic |
Text from waiting list. |
|
.WaitingList. BookingText[].TypeOfText |
String |
Dynamic |
Type of text. HIS90: Legal values: TXT1
(BOOKING_TEXT1), TXT2 (BOOKING_TEXT2). |
|
.WaitingList.Status.Code |
String |
Dynamic |
Status of waiting
list/booking. HIS90: Integer: 1-9 |
|
.WaitingList.Status.Text |
String |
Dynamic |
Explanatory text for
code above, set by WS according to rules in WaitingListWS. |
|
.ScheduleSlotStatus |
String |
Dynamic |
Appointment status. HIS90: Legal values are: FREE, BOOKED, BLOCKED,
PAUSE |
|
.ScheduleSlotType |
String |
Dynamic |
Type
of booking. HIS90: Valid
types are T1-T5 and OB. |
|
.ScheduleSlotDescription |
String |
Dynamic |
Appointment
reason/description HIS90: Booking
reason from PAQREBO.REASON. In case of blocked booking, this will give the
reason. |
|
.OpenScheduleSlot |
String |
Dynamic |
Flag to indicate if the scheduled slot is based on
an open template. If open template OpenScheduleSlot is set to TRUE. A scheduled slot with an open template can be split
into several scheduled slots/appointments when they are booked. A scheduled slot with a fixed template has
predefined from and to time, so here the given scheduled slot is booked
entirely. If OpenSceduleSlot is NULL or false it is a fixed
template. |
|
.OverBookingAllowed |
String |
Dynamic |
Number to indicate if
overbooking is allowed for the resource. If the scheduled slot is
based on an open template (see OpenScheduleSlot above) then
OverBookingAllowed will give number of minutes the resource can be overbooked
on the given date. If the scheduled slot is
based on a fixed template (see OpenScheduleSlot above) then
OverBookingAllowed will give number of scheduled slots for the resource that
is available for overbooking on the given date. If 0 or NULL,
overbooking is not allowed. |
|
.ReservedToDate |
String |
Dynamic |
The date (and time) until when the scheduled slot is
reserved. As long as the scheduled slot is reserved it cannot be booked. If no reservation or ReservedToDate is in the past, ReservedToDate will be
NULL/missing in the response. |
|
.From |
DateTime |
|
Planned start date/time for a booking by patient
responsible. Note - If the scheduled slot/appointment is
suspended/postponed (see Status.Code) the From and To date will contain the
original start and end date/time for the scheduled slot/appointment (not the
new date/time). |
|
.To |
DateTime |
|
If a scheduled slot/appointment is scheduled then
this gives end time for booking by patient responsible. Note - If the scheduled slot/appointment is
suspended/postponed (see Status.Code) the From and To date will contain the
original start and end date/time for the scheduled slot/appointment (not the
new date/time). |
|
.CareUnit.Id |
String |
Dynamic |
Id of the care unit where the
appointment is made at. Use
OrganizationWS.GetOrganization2G
for more information about the unit. This
is where the patient will be treated. |
|
.CareUnit.TypeOfId |
String |
Dynamic |
Type
of Id above. For care unit only ‘LEN’ is valid. |
|
.CareUnit.ShortNameId |
String |
Dynamic |
Code/short
name of the care unit
where the appointment is made at. |
|
.CareUnit.Name |
String |
Dynamic |
Name
of the care unit where the appointment is made at. |
|
.Resource.ResourceId |
String |
Dynamic |
Internal
unique id identifying physicians or other resources reserved for the scheduled
slot/appointment. HIS90: Combined
id for unique identification of a resource consisting
of DeptNo|ResourceCode. |
|
.Resource.TypeOfId |
String |
Dynamic |
Type
of id for ResourceId. HIS90: Value
set to ‘LRC’ by WS, denoting resource id for system. |
|
.Resource.Code |
String |
Dynamic |
Code
identifying physicians or other resources reserved for the scheduled
slot/appointment. |
|
.Resource.Name |
String |
Dynamic |
Physician’s
name, or description of other resource reserved for the scheduled
slot/appointment. |
|
.Resource.Property |
String |
Dynamic |
Type/category
of resource reserved for the scheduled slot/appointment. |
|
.Resource.MedicalUnit.Id |
String |
Dynamic |
Id of the medical/department unit
where the resource is allocated. Use
OrganizationWS.GetOrganization2G
for more information about the unit. |
|
.Resource.MedicalUnit.TypeOfId |
String |
Dynamic |
Type
of Id above. For medical/department unit only ‘LAV’ is valid. |
|
.Resource.MedicalUnit.ShortNameId |
String |
Dynamic |
Code/short
name of the
medical/department unit where the resource is allocated. |
|
.Resource.MedicalUnit.Name |
String |
Dynamic |
Name
of the medical/department unit where the resource is allocated. |
|
.Resource.CareUnit.Id |
String |
Dynamic |
Internal
id/number of the unit that owns the resource reserved for the scheduled slot. |
|
.Resource.CareUnit.TypeOfId |
String |
Dynamic |
Type
of Id above. HIS90: Value
set to ‘LEN’ by WS. |
|
.Resource.CareUnit.ShortNameId |
String |
Dynamic |
Short
name/code of the unit that owns the resource reserved for the scheduled slot. |
|
.Resource.CareUnit.Name |
String |
Dynamic |
The
name of the unit that owns the resource reserved for the scheduled slot. |
|
.Update.Date |
DateTime |
Dynamic |
Date
when schedule slot instance was last modified. HIS90: N/A |
|
.Update.Name |
String |
Dynamic |
Name
of updater. HIS90: N/A |
|
.Update.Organization.Id |
String |
Dynamic |
Department
responsible for last modification of schedule slot instance. HIS90: N/A |
|
.Update.Organization.TypeOfId |
String |
Dynamic |
Type
of id above. HIS90: N/A |
|
.Update.Organization.ShortNameId |
String |
Dynamic |
Department
code/short name. HIS90: N/A |
|
.Update.Organization.Name |
String |
Dynamic |
Department
name. HIS90: N/A |
|
.Update.SignedBy |
String |
Dynamic |
Initials
of user that modified schedule slot instance. HIS90: N/A |
|
.Update.UpdateCount |
Int |
4 |
Counter
used for concurrency testing when schedule slot is updated. |
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=ListScheduleSlots
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be raised
if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Saves a specific schedule slot or several schedule
slots belonging to patients, waiting lists or resources.
Booking/appointment/slot must be retrieved by using ListScheduleSlots before
saving. There are several uses of this method.
The method can
update a booking/slot on a resource. Either change the booking/slot on the
resource (e.g. free or block slots that have not been booked) or
order/rebook/free booking/slot for a patient or waiting list.
Updating a booking on a resource requires a slot
id (ScheduleSlotId) and a blank/null waiting list id (WaitingListId). A
resource can free or block a slot in their time book using this method, and
change the text (reason). A slot can only be blocked if not booked. To block a
slot that is not booked, the slot must be freed or rebooked before blocking.
To
order/rebook/free a slot belonging to a resource and booked on a patient, a
slot id (ScheduleSlotId) and waiting list id (WaitingListId) is required. When
ordering/rebooking/freeing the resource information in the waiting list is
updated (HIS90: cfr. resource 1, 2 and 3).
The method can
rebook a time slot based on an existing slot id (ScheduleSlotId) and a new slot
id (NewScheduleSlotId). The patient id on the existing time slot is used.
The method can free
a booked time slot by setting status to FREE for an existing slot
booked/ordered on a patient.
Additionally,
reason, booking texts and dates/times can be changed.
Syntax:
ScheduleSlotsResponse = SaveScheduleSlots(SaveScheduleSlotsRequest)
|
Parameter
in |
Type |
Length byte |
Description
– Data format – Valid data |
|
SaveScheduleSlotRequest |
|
N/A Dynamic |
Request
class according to XSD schema in Booking.xsd. |
|
.ScheduleSlotId |
String |
Dynamic |
Saves a specific slot. ScheduleSlotId is a
combined value. Use BookingWS.ListSchedulesByResource
or BookingWS.ListSchedulesByResource
to get valid ScheduleSlotId Set value according to
desired action: -
required for all
actions HIS90: Combined id consisting of:
DeptNo|ResourceCode|Period|RschDate|HourMin|SerialNoRebo. cfr. document PasLinkWS HIS90 combined id
definitions.doc. |
|
.NewScheduleSlotId |
String |
Dynamic |
Updates a specific slot (rebook). ScheduleSlotId
is a combined value. Use BookingWS.ListSchedulesByResource
or BookingWS.ListSchedulesByResource
to get valid ScheduleSlotsId. Set value according to
desired action: -
rebook: required -
else: Not used. HIS90: Combined id consisting of:
DeptNo|ResourceCode|Period|RschDate|HourMin|SerialNoRebo. cfr. document PasLinkWS HIS90 combined id definitions.doc. |
|
.ScheduleSlotSequence |
Int |
4 |
Sequence of bookings.
For rebooking this can be 0. Set value according to
desired action: -
rebook: 0 (value from existing
time slot will be used), or 1/2/3 -
book: 1, 2 or 3 (required) -
else: 0 (Not used.) HIS90: Indirectly, sequence of
bookings on resources, as booking id is resource specific, if resource is 1,
2 or 3 in PAQBOOK. |
|
.WaitingList.WaitingListId |
String |
Dynamic |
Saves schedule slot(s) associated with a
single waiting list. WaitingListId is a combined value. Use WaitingListWS.ListWaitingLists
or WaitingListWS.ListWaitingListsByOrg
to get valid waiting lists. Set value according to
desired action: -
rebook: optional; if blank,
value from existing slot will be used -
book: required -
free on patient: optional; if blank,
value from existing slot will be used -
else: Not used. HIS90: Combined id consisting of:
PatientId|BookingNo. cfr. document PasLinkWS HIS90 combined id
definitions.doc. |
|
.WaitingList.BookingText.Text |
String |
Dynamic |
Text from waiting list. Set value according to
desired action: -
rebook: optional; if blank,
value from existing slot will be used -
book: optional -
else: Not used. |
|
.WaitingList.BookingText.TypeOfText |
String |
Dynamic |
Type of text. Set value according to
desired action: -
same as for Text above HIS90: Legal values: TXT1 (BOOKING_TEXT1) TXT2 (BOOKING_TEXT2) |
|
.WaitingList.Status.Code |
String |
Dynamic |
Status of waiting
list/booking. HIS90: Integer: 1-9 |
|
.WaitingList.Status.Text |
String |
Dynamic |
Text set by WS according
to rules in WaitingListWS. |
|
.ScheduleSlotStatus |
String |
ScheduleSlotStatusType |
Appointment status. Set value according to
desired action: -
rebook: not specified
(ignored) -
book: BOOKED -
free/block on resource: FREE/BLOCKED -
free on patient: FREE |
|
.ScheduleSlotType |
String |
Dynamic |
Type
of Booking. Set value according to
desired action: -
free on patient: N/A -
else: optional HIS90: Valid
types are T1-T5 and OB. |
|
.ScheduleSlotDescription |
String |
Dynamic |
Appointment
reason/description HIS90: Booking
reason from PAQREBO.REASON |
|
.OpenScheduleSlot |
Boolean |
|
Flag to indicate if the scheduled slot is based on a
open template. If open template OpenScheduleSlot is set to TRUE. A scheduled slot with an open template can be split
into several scheduled slots/appointments when they are booked. A scheduled slot with a fixed template has
predefined from and to time, so here the given scheduled slot is booked
entirely. If OpenSceduleSlot is NULL or false, it means a
fixed template will be used. Set value according to
desired action: - free/block on resource: optional; if blank, value from existing slot will be used - else: N/A |
|
.OverBookingAllowed |
Int |
4 |
Number to indicate if overbooking is allowed for the
resource. HIS90: N/A |
|
.ReservedToDate |
DateTime |
|
The date (and time) until when the scheduled slot is
reserved. As long as the scheduled slot is reserved it cannot be booked. HIS90: N/A |
|
.From |
DateTime |
|
Planned start date/time for a booking by patient
responsible. Set value according to
desired action: -
book: required only if time
slot is based on an open time book; if fixed time slot, slot will be booked
according to slot in PAQREBO -
free on patient: N/A -
else: optional |
|
.To |
DateTime |
|
If a schedule slot/appointment is scheduled then
this gives end time for booking by patient responsible. Set value according to
desired action: - free on patient: N/A - else: optional |
|
.CareUnit.Id |
String |
Dynamic |
Id of the care unit where the
appointment is made at. Use
OrganizationWS.GetOrganization2G
for more information about the unit. Set value according to
desired action: - rebook: required - book: required
(will update existing value) -
else: N/A |
|
.CareUnit.TypeOfId |
String |
Dynamic |
Type
of Id above. For care unit only ‘LEN’ is valid. Set value according to
desired action: -
same as for TypeOfId above |
|
.CareUnit.ShortNameId |
String |
Dynamic |
Code/short
name of the care unit
where the appointment is made at. HIS90: N/A |
|
.CareUnit.Name |
String |
Dynamic |
Name
of the care unit where the appointment is made at. HIS90: N/A |
|
.Resource.MedicalUnit.Id |
String |
Dynamic |
Id of the medical/department unit
where the resource is allocated. Use
OrganizationWS.GetOrganization2G
for more information about the unit. HIS90: N/A |
|
.Resource.MedicalUnit.TypeOfId |
String |
Dynamic |
Type
of Id above. HIS90: N/A |
|
.Resource.MedicalUnit.ShortNameId |
String |
Dynamic |
Code/short
name of the medical/department
unit where the resource is allocated. HIS90: N/A |
|
.Resource.MedicalUnit.Name |
String |
Dynamic |
Name
of the medical/department unit where the resource is allocated. HIS90: N/A |
|
.Resource.CareUnit.Id |
String |
Dynamic |
Internal
id/number of the unit that owns the resource reserved for the scheduled slot. Set value according to
desired action: - rebook: optional - book:
optional -
else: N/A |
|
.Resource.CareUnit.TypeOfId |
String |
Dynamic |
Type
of Id above. For care unit only ‘LEN’ is valid. Set value according to
desired action: -
same as for Id above |
|
.Resource.CareUnit.ShortNameId |
String |
Dynamic
Dynamic |
Short
name/code of the unit that owns the resource reserved for the scheduled slot. HIS90: N/A |
|
.Resource.CareUnit.Name |
String |
Dynamic |
The
name of the unit that owns the resource reserved for the scheduled slot. HIS90: N/A |
|
.Resource.ResourceId |
String |
Dynamic |
Internal
unique id identifying physicians or other resources reserved for the scheduled
slot/appointment. HIS90: N/A |
|
.Resource.TypeOfId |
String |
Dynamic |
Type
of id for ResourceId. HIS90: N/A |
|
.Resource.Code |
String |
Dynamic |
Code
identifying physicians or other resources reserved for the scheduled
slot/appointment. HIS90: N/A |
|
.Resource.Name |
String |
Dynamic |
Physician’s
name, or description of other resource reserved for the scheduled
slot/appointment. HIS90: N/A |
|
.Resource.Property |
String |
Dynamic |
Type/category
of resources reserved for the scheduled slot/appointment. HIS90: Not
used. |
|
.Update.UpdateCount |
Int |
4 |
Counter
used for concurrency testing when schedule slot is updated. HIS90: Set
by server. |
|
.Update.Date |
DateTime |
|
Date
when schedule slot instance was last modified. HIS90: N/A |
|
.Update.Name |
String |
Dynamic |
Name
of updater. HIS90: N/A |
|
.Update.Organization.Id |
String |
Dynamic |
Department
responsible for last modification of schedule slot instance. HIS90: N/A |
|
.Update.Organization.ShortNameId |
String |
Dynamic |
Department
code/short name. HIS90: N/A |
|
.Update.Organization.Name |
String |
Dynamic |
Department
name. HIS90: N/A |
|
.Update.SignedBy |
String |
Dynamic |
Initials
of user that modified schedule slot instance. HIS90: N/A |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
SaveScheduleSlotsResponse |
|
N/A Dynamic |
Response
class according to XSD schema in Booking.xsd |
|
ScheduleSlots[] |
|
N/A Dynamic |
Collection of schedule
slots. See the ListScheduleSlots method above. |
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=SaveScheduleSlots
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be
raised if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
MoveScheduleSlots
method moves scheduled slots to another day or resource.
Syntax:
MoveScheduleSlotsResponse = MoveScheduleSlots(MoveScheduleSlotsRequest)
Request and response:
See schema
and schema documentation
Schema for BookingWS: Booking.xsd
Schema
documentation for BookingWS: BookingWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/BookingWS/BookingWS.asmx?op=MoveScheduleSlots
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required when 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 the system name is required. An error will be
raised if one of these is missing.
Valid
authentication block for the RequestHeader
can be retrieved by using the method GetUserLogin
in 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 checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Method is
not implemented yet, do not use the interface as it can change.