Product description
PasLink
Web Services
Version:
2.2.19073
14.03.2019
User
documentation for PasLink Web Services
Tieto
Corporation
1.3 About PasLink Web Services
1.4 PasLink Web Services as modules
1.5 Naming in PasLink Web Services
1.10 Development tools and rules
1.10.1 Microsoft Visual Studio
1.11 Common Errors from PasLink Web Services
1.11.1 Error Messages from methods using HIS-90
3.2 Web Service ResponseHeader
PasLinkWS is service platform with standardized
service interface. The object with PasLink Web Services is to give third party
applications the opportunity to access patient information stored in PAS
Systems (E.g. INFOMEDIX PAS, HIS90 and Classic) with the same interface
regardless of system.
The PasLink Web Services are available for use
by developers that wishes to integrate with the PAS/HIS system. This
documentation is intended for use by developers or other which needs technical
information about PasLink Web Services. The security on both authentication and
the limitations of information based on this authentication is taken care of by
the Web Services or the HIS/PAS databases.
PasLink Web Services is a licensed product from
Tieto HealthCare and all applications using PasLink Web Services must be
registered. The customer, to whom the product is licensed, is responsible for
the registration of all applications integrated with the PAS system through
PasLink Web Services in his environment. Tieto HealthCare reserves the right to
change PasLink Web Services if necessary. The provider of registered
applications will be notified in advance of such changes.
INFOMEDIX PAS |
Patient administration application
executing on Windows-platform. |
HIS90 PAS |
Patient administration application
executing on HP/Compaq Himalaya-platform |
Classic |
Patient administration application
executing on Windows-platform. Old – replaced by INFOMEDIX PAS |
HIS |
Health Information System, general
description of all three systems above and any future systems. |
PasLink Web Services is grouped under several
main titles.
The document is divided into several parts with
one main document and several sub documents.
To view or print the entire master document
switch to outline view, expand the subdocuments and switch to normal
view, and then print it as usual. To specify the amount of detail to print,
use the following procedure.
PasLink Web Services is designed as two main
layers, one independent layer that contains generic methods and one dependent
layer containing PAS specific interfaces and modules. When changes are made in
the interface against the PAS database, the methods should stay unchanged. Only
the dependent part is affected and must be rewritten for a new communication
interface.
This means that applications using PasLink Web
Services not necessarily needs to be changed as a result of changes in the
communication between PasLink Web Services and the PAS database.
It is important to know that PasLink Web
Services is offering a collection of methods for use by other
applications. The providers of these applications are responsible for how these
methods are used and implemented. As an example, PasLink Web Services contains
methods for login in and authentication of users. Through this method an
application gets an authentication block to use with the other methods. The
provider of a third party application is responsible to make use of the login
and authentication methods (to get and store the authentication block) before
he makes use of other methods.
PasLinkWS uses RequestHeader and ResponseHeader based on the Soap standards with
extension.
Tieto will try to keep same information in
interfaces and logic regarding error, but will be limited to what information the PAS system gives. Thus
error codes for the PAS systems will be different for same operations.
PasLink Web Services consists of several
modules, so the client does not need to load unnecessary code. Methods
containing similar logic are grouped together:
The following naming standard is applied in the
Web Services for the methods:
|
|
GetX() |
Get one set of information. |
ListX() |
Get a list or collection of data. Patient
related. |
ListXByOrg() |
Get a list or collection of data.
Organizational related. |
SaveX() |
Save (insert or updates) one set of data. |
DeleteX() |
Delete a chosen set of data from the
database. |
CancelX() |
Cancel (sets a status) for a chosen set of
data from the database. |
There
are methods where it is not practical to follow this naming standard. The name
of the method will reflect what function the methods have.
Versioning
information in this documentation can be on several levels, both on main
document/page and for each Web Service documentation.
The
version number on main document/page is the release version number of the
complete document; this does not necessarily match the Web Service Package
release version.
Web
service method’s request and response are normally kept compatible with
previous version’s WSDL.
If
compatibility is broken this is either notified before this happens so changes
can be made or normally a new method will be created if compatibility is
broken.
Compatibility
with older WSDL is kept if: New information (properties/field) is added to the
request or response (WSDL) as optional information. Information (properties/field)
changes placement within same level it is defined. Data types is changed from
number to string(as long as client applications does not update its WSDL it is
compatible, after update of WSDL at client applications it might need some code
changes from number to string also).
Compatibility
is broken if: Information (properties/field) in request or response is
restructured. Information (properties/field) is renamed or deleted, or
information (properties/field) is moved to other placement in request/response
that is not the same level as before. (Note: There can be problems with keeping
compatibility on WSDL proxies generated at client
side if this is not done correctly, see note for Visual
Studio)
If
compatibility is broken a new method with generation extension is created. A
generation extension is for example 2G, 3G 4G … Some if there would be a new
version of the method ListOrganization due to compatibility breaks, the next
generation version would be ListOrganizations2G
The
PasLink Web Services can access several different PAS systems.
At
the top of every method description there is a system information bar to tell
which system this method is valid in. There can be more systems available then
listed in this document, but generally this is systems under development or for
special cases.
Example:
Applicable systems for the method:
INFOMEDIX |
Classic |
HIS-90 |
HL7 |
RoS |
MasterPAS |
This
system info bar tells that this method has access to three PAS-systems.
List of Web Services/Methods and
which systems they are applicable for
X=Implemented, - =Not applicable,
Blank = Not implemented,
X ** (or Italic method name) = The method has no public documentation, but
can be used as is.
Grey method name is internal method, cannot be used by other, only Tieto can use method.
Web Service |
Method |
INFO MEDIX |
Classic |
HIS-90 |
HL7 |
RoS |
Master PAS |
Number of
methods per system-> |
75 |
17 |
175 |
8 |
7 |
7 |
|
AuthenticationWS |
ChangePassword |
X |
|
X |
|
|
|
|
GetSystemInformation |
X |
X |
X |
X |
X |
X |
|
GetSystemInformations |
X |
X |
X |
X |
X |
X |
|
GetUser |
|
|
X |
|
|
|
|
GetUserLogin |
X |
X |
X |
X |
X |
X |
|
GetUserID |
X |
|
X |
X |
|
X |
|
SaveUser |
|
|
X |
|
|
|
|
SetActiveRoleAccessTemplate |
X |
|
|
|
|
|
AuthorizationWS |
GetUserAuthorizations |
|
|
X |
|
|
|
|
GetUserServiceAccess |
X |
X |
X |
|
|
|
|
GetUserServiceAccesses |
|
|
X |
|
|
|
|
GetUserUnitAccess |
X |
X |
X |
|
|
|
|
ListAccessTemplates |
|
|
X |
|
|
|
|
ListRoles (Category) |
|
|
X |
|
|
|
|
ListServiceAccesses |
|
|
X |
|
|
|
|
SaveUserAuthorizations |
|
|
X |
|
|
|
|
SaveUserServiceAccesses |
|
|
X |
|
|
|
BookingWS |
GetAppointment |
|
|
X |
|
|
|
|
ListBookedResources |
|
|
X |
|
|
|
|
ListPatientAppointments |
|
|
X |
|
|
|
|
ListResourceAppointments |
|
|
X |
|
|
|
|
ListScheduleByOrg |
|
|
X |
|
|
|
|
ListScheduleByResource |
|
|
X |
|
|
|
|
ListScheduleByResources |
|
|
(X) [1] |
|
|
|
|
ListScheduleSlots |
|
|
X |
|
|
|
|
MoveScheduleSlots |
|
|
X |
|
|
|
|
SaveScheduleSlots |
|
|
X |
|
|
|
CommonCodesWS |
GetCommonCode |
|
|
X |
|
|
|
|
GetServiceCode |
|
|
X |
|
|
|
|
ListAdmitCodes |
|
|
X |
|
|
|
|
ListAllMunicipalityCodes[2] |
X |
|
X |
|
|
|
|
ListAllPostalCodes |
X |
|
X |
|
|
|
|
ListCancelReasonCodes |
|
|
X |
|
|
|
|
ListCashCodes |
|
|
X |
|
|
|
|
ListClinicalAreaGroupCodes |
|
|
X |
|
|
|
|
ListCommonCodes |
|
|
X [3] |
|
|
|
|
ListFreeCodes |
|
|
X |
|
|
|
|
ListLanguageCodes |
|
|
X |
|
|
|
|
ListLetterCodes |
|
|
X |
|
|
|
|
ListMedicalCodeCombinations
[4] |
X |
|
|
|
|
|
|
ListMedicalCodeRules |
X |
|
|
|
|
|
|
ListMedicalCodes |
X |
|
X |
|
|
|
|
ListMedicalRegisters |
X |
|
X |
|
|
|
|
ListMunicipalityCodes |
|
|
X |
|
|
|
|
ListNationalityCodes |
|
|
X |
|
|
|
|
ListPaymentMethodCodes |
|
|
X |
|
|
|
|
ListPostCodes |
|
|
X |
|
|
|
|
ListPriorityCodes |
|
|
X |
|
|
|
|
ListRates |
|
|
X |
|
|
|
|
ListRefoundCodes |
|
|
X |
|
|
|
|
ListReqrCodes |
|
|
X |
|
|
|
|
ListRoles |
X |
|
|
|
|
|
|
ListSystemCodes |
X |
|
|
|
|
|
|
ListVDGRCodes |
|
|
X |
|
|
|
|
ListVHDGCodes |
|
|
X |
|
|
|
|
SearchCommonCodes |
|
|
X |
|
|
|
|
SearchMunicipalityCodes
[5] |
X |
|
X |
|
|
|
|
SearchPostalCodes |
X |
|
X |
|
|
|
|
SaveCommonCode |
|
|
X |
|
|
|
ContactRatesWS |
GetContactRates |
X |
|
|
|
|
|
ContactWS |
DeletePatientTreatmentTime |
|
|
X |
|
|
|
|
DeleteContact |
|
|
X |
|
|
|
|
GetContact |
|
|
X |
|
|
|
|
GetContactReferral |
X |
|
|
|
|
|
|
GetLatestContact |
|
|
X |
|
|
|
|
GetPatientContact |
X |
|
X [6] |
|
|
|
|
GetPatientContactUnitDetails |
X |
|
|
|
|
|
|
GetPatientContacts |
X |
X |
X [7] |
|
|
|
|
GetPatientIndividualPlan |
|
|
X ** |
|
|
|
|
ListContactLeaves |
|
|
X ** |
|
|
|
|
ListContactMeasurements |
|
|
X |
|
|
|
|
ListContactParticipants |
|
|
X |
|
|
|
|
ListContactReferral |
X |
|
|
|
|
|
|
ListContactTreaters |
|
|
X |
|
|
|
|
ListContactTreatment |
|
|
X |
|
|
|
|
ListContacts |
|
|
X |
|
|
|
|
ListPatientIndividualPlans |
|
|
X ** |
|
|
|
|
ListPatientTreatmentTimes |
|
|
X |
|
|
|
|
SaveContact |
|
|
X |
|
|
|
|
SaveContactActivity |
X |
|
|
|
|
|
|
SaveContactLeave |
|
|
X ** |
|
|
|
|
SaveContactMeasurement |
|
|
X |
|
|
|
|
SaveContactParticipant |
|
|
X |
|
|
|
|
SaveContactTreater |
|
|
X |
|
|
|
|
SaveContactTreatment |
|
|
X |
|
|
|
|
SaveDischarge |
|
|
X |
|
|
|
|
SaveDischargeLetterDistributed
|
X |
|
X |
|
|
|
|
SavePatientIndividualPlan |
|
|
X ** |
|
|
|
|
SavePatientTreatmentTime |
|
|
X |
|
|
|
DecisionWS |
ListComplaints |
|
|
X |
|
|
|
|
ListCriteria |
|
|
X |
|
|
|
|
ListDecisionsByOrg |
|
|
X [8] |
|
|
|
|
ListPatientDecisions |
X |
|
X |
|
|
|
|
SaveComplaint |
|
|
X |
|
|
|
|
SaveCriteria |
|
|
X |
|
|
|
|
SavePatientDecision |
X |
|
X |
|
|
|
DiagnosisWS |
CancelMedicalRegistration |
X |
|
|
|
|
|
|
ContactDiagnosisRegistration |
X |
|
|
|
|
|
|
DeleteContactDiagnosis |
X |
|
X |
|
|
|
|
DeleteContactDiagnosisInclHistory |
X |
|
|
|
|
|
|
FinishMedicalRegistration |
X |
|
|
|
|
|
|
GetContactDiagnosis |
X |
|
X |
|
|
|
|
RenumberSubDiagnosis |
X |
|
|
|
|
|
|
SaveContactDiagnosis |
X |
|
X |
|
|
|
|
SaveContactDiagnosisInclHistory |
X |
|
|
|
|
|
DocumentWS |
DeleteTemplate |
|
|
X |
|
|
|
|
DeleteTemplateMapping |
|
|
X |
|
|
|
|
GetDocumentInfo |
|
|
X |
|
|
|
|
GetTemplate |
|
|
X |
|
|
|
|
ListTemplateMappings |
|
|
X |
|
|
|
|
ListTemplates |
|
|
X |
|
|
|
|
PrintSystemDocument |
|
|
X |
|
|
|
|
SaveTemplate |
|
|
X |
|
|
|
|
SaveTemplateMapping |
|
|
X |
|
|
|
DrugWS [9] |
ListPatientDrugInformations |
|
|
X |
|
|
|
|
GetPatientDrugInformation |
|
|
X |
|
|
|
|
SavePatientDrugInformation |
|
|
X |
|
|
|
|
GetPatientLatestDrugInformation |
|
|
X[10] |
|
|
|
EconomyWS |
DeleteGiro |
|
|
X |
|
|
|
|
GetCashBoxBalanceReport |
|
|
X |
|
|
|
|
GetEconomyTransactions |
|
|
X |
|
|
|
|
GetGiro |
|
|
X |
|
|
|
|
SaveGiro |
|
|
X |
|
|
|
EventWS |
DeleteEvent |
|
|
X |
|
|
|
|
ListEvents |
|
|
X |
|
|
|
|
SaveEvent |
|
|
X |
|
|
|
|
SaveEventState |
|
|
X |
|
|
|
ExternalOrganizationWS |
GetExternalOrganization |
X |
|
|
|
|
|
|
ListExternalOrganization |
X |
|
|
|
|
|
ImportantMedicalFactsWS |
DeleteIMF |
X |
|
|
|
|
|
|
GetIMF |
X |
|
|
|
|
|
|
ListIMFToSign |
X |
|
|
|
|
|
|
ListIMFVersions |
X |
|
|
|
|
|
|
ListPatientsWithIMFToSign |
X |
|
|
|
|
|
|
SaveIMF |
X |
|
|
|
|
|
LinkItemsWS |
GetLinkItem |
X |
|
|
|
|
|
|
ListLinkItems |
X |
|
|
|
|
|
MedicalRegistrationWS |
CancelMedicalRegistration |
X |
|
|
|
|
|
|
FinishMedicalRegistration |
X |
|
|
|
|
|
OrganizationWS |
GetInstitutionAddresses |
X |
|
|
|
|
|
|
GetOrganization |
X |
|
|
|
|
|
|
GetOrganization2G |
|
|
X |
|
|
|
|
GetOrganizationAddresses |
X |
|
|
|
|
|
|
GetOrganizationStatus |
|
|
X |
|
|
|
|
GetResource |
|
|
X |
|
|
|
|
ListOrganization |
X |
X |
X |
|
|
|
|
ListOrganizations2G |
|
|
X |
|
|
|
|
ListResources |
X |
X |
X |
|
|
|
PatientWS |
GetPatient |
X |
X |
X |
X |
X |
X |
|
GetPatientEmployers |
|
|
X |
|
|
|
|
GetPatientFromPerson |
X |
|
X |
|
|
|
|
GetPatientIMF |
X |
|
X |
|
|
|
|
GetPatientJournalPlacement |
X |
|
|
|
|
|
|
GetPatientOverview |
X |
|
|
|
|
|
|
GetPatientOverviewTekst |
X |
|
|
|
|
|
|
GetPatientRelatives |
X |
|
X |
|
|
|
|
GetPlacement |
|
|
X |
|
|
|
|
GetResponsiblePerson |
X |
|
|
|
|
|
|
GetUpdatedPatientFreepass |
|
|
X |
|
|
|
|
ListPatients |
X |
X |
X |
X |
X |
X |
|
ListPatientsById |
X |
X |
X |
|
|
X |
|
ListPatientsById2G |
|
|
X |
|
|
|
|
ListPatientsByOrg |
X |
X |
X |
|
|
|
|
ListPatientsByResource |
|
|
X |
|
|
|
|
ListPatientRelations |
|
|
X |
|
|
|
|
SavePatient |
X |
X |
X |
|
X |
|
|
SavePatientJournalPlacement |
X |
|
|
|
|
|
|
SavePatientRelatiuons |
|
|
X |
|
|
|
|
SavePlacement |
|
|
|
|
X |
|
|
UpdateOfficialId |
|
|
X |
|
|
|
PersonWS |
GetPerson |
X |
X |
X |
X |
|
|
|
ListPersons |
X |
X |
X |
X |
|
|
ProcedureWS |
DeleteContactProcedures |
X |
|
X |
|
|
|
|
GetContactProcedures |
X |
|
X |
|
|
|
|
SaveContactProcedures |
X |
|
X |
|
|
|
ReferralWS |
SaveReferral |
|
|
X |
|
|
|
ReportWS |
CreateReportData |
|
|
X |
|
|
|
|
GetBkmInfo |
|
|
X |
|
|
|
|
GetPaqEvent
[11] |
|
|
X |
|
|
|
|
GetReportData |
|
|
X |
|
|
|
|
ListBkmTransactions |
|
|
X |
|
|
|
|
SetReportStatus |
|
|
X |
|
|
|
RequesterWS |
GetRequester |
|
|
X |
|
|
|
|
ListRequesters |
|
|
X |
|
|
|
|
SaveRequester |
|
|
X |
|
|
|
UserConfigurationWS |
GetUserDefaultOrganization |
X |
X |
X |
|
|
|
|
GetUserInformation |
X |
X |
X |
|
|
|
|
SaveUserDefaultOrganization |
X |
|
|
|
|
|
WaitingListWS [12] |
CancelWaitingList |
|
|
X |
|
|
|
|
ChangeWaitingListCarePeriod |
|
|
X |
|
|
|
|
DeleteCarePeriod |
|
|
X |
|
|
|
|
DeleteCarePeriodInformation |
|
|
X |
|
|
|
|
GetCarePeriod |
|
|
X |
|
|
|
|
GetWaitingList |
|
|
X |
|
|
|
|
ListCarePeriodInformations |
|
|
X |
|
|
|
|
ListCarePeriods |
|
|
X |
|
|
|
|
ListWaitingLists |
|
|
X |
|
|
|
|
ListWaitingListsByOrg |
|
|
X |
|
|
|
|
ListWaitingListsReport1ByOrg |
|
|
X ** |
|
|
|
|
SaveCarePeriod |
|
|
X |
|
|
|
|
SaveCarePeriodInformation |
|
|
X |
|
|
|
|
SaveWaitingList |
|
|
X |
|
|
|
Required Bold declares this parameter as required
Normal Parameter can be empty/uninitialized.
[Optional] Parameter
can be omitted
If
Microsoft Visual Studio (VS) is used as tool to access/consume the web
services, the web service must be added to VS as Web Reference NOT as Service
Reference.
The
proxies generated through Web Reference allow more compatibility with PasLink
changes, as new properties/fields can be added and compatibility with older
WSDL proxies can be kept without needing to update them if none of the new
properties/fields are used.
The
reason for not using Service Reference is that is it too tight coupled to
Microsoft’s WCF thoughts, and then the binding to properties/fields in the
proxies generated is absolute to order index of the property/field not to
property/field name. As Tieto’s web services follow the w3c.org standard/basic
profile and are asmx based this allows inserting new properties/field within an
existing WSDL definition and keeping compatibility, order of property/field is
not important. With using Service Reference to generate proxies this will not
go as it uses absolute order index, a new property/field in the middle will
render the WSDL proxy useless.
Using
Web Reference to generate/update proxies to Tieto’s web services will bind to
property/field name not the order/index, and new properties/fields will then be
“invisible” until WSDL proxy is updated and as long as new properties/fields is
not used there is no need to update WSDL proxy and still be compatible.
Tieto
will change a web services WSDL according to usage of Web Reference proxies and
keep compatibility to this on the XML naming level. Underlying class structure
names in the WSDL file can change but this only affects code after WSDL update
and not WSDL compatability with PasLinkWS server/services and communications.
Any use of Service Reference proxies is not supported by Tieto’s web services
and must be updated with each WSDL change.
To
ensure that data is saved correctly and consistent when updating an item via
PasLinkWS a Get must always be done before the corresponding Save method is
called.
Errors
from PasLinkWS methods are always returned in the
ResponseHeader.ErrorInfomation block. See web service
response header chapter.
More
information about errors, warning and general information in PasLinkWS can be
found in logs or windows event log for PasLinkWS, please contact a system or
operation responsible for the PasLinkWS installation for accessing logs.
Code
Description
0 No error, method completed
successfully.
1 Invalid ticket/security token provided
in the request.
2 Ticket/security token is blank/missing
in the request.
3 Ticket/security token has expired,
please reauthenticate,
5 RequestHeader is missing/blank, a
requestheader to the Web Service method is required.
7 Invalid encryption keys for the
ticket/security token.
8 Encryption keys for the
ticket/security token is missing/cannot be created.
-1 Internal error in the Web Service,
check ResponseHeader\ErrorInformation for error
description and severity.
-10 General database error
-20 Input data is invalid/wrong
-21 Input data is invalid type
-22 Input data is invalid length
-70 Configuration
data is missing.
-71 Configuration
data is invalid.
>0 Error in Web Service Request or from the database, check
ResponseHeader\ErrorInformation
for error description and severity.
>100000 Error from HIS90 database
communication (CXL). See chapter below for details.
These
error codes is only valid if the PasLinkWS is configured for the HIS90 PAS
syste,
Possible errors from CSL/network |
|||||
Code |
|
||||
From |
To |
SubCode |
Recoverable |
Module |
Description |
100000 |
|
0 |
N |
CSL |
Undefined error/message from CSL |
100001 |
>108191 |
? |
N |
0 |
The CSL API has reported an error |
108192 |
>112287 |
? |
Some |
4 |
Pathway Server class has reported an error |
112288 |
>153247 |
? |
N |
7 |
Guardian File open has reported an error |
153248 |
>157343 |
? |
N |
8 |
Guardian Write Read has reported an error |
157344 |
>188999 |
? |
N |
3 |
TMF Subsystem has reported an error |
189001 |
|
0 |
N |
|
Session was rejected by ACS |
189002 |
|
0 |
N |
|
Session with the same alias already logged in |
189003 |
|
0 |
N |
|
Invalid session alias |
189004 |
|
0 |
N |
|
Cannot connect specified terminal |
189005 |
|
0 |
N |
|
Terminal does not configured for this version of
client |
189006 |
|
0 |
N |
|
Error communicating ACS |
189007 |
|
0 |
N |
|
No connection to host |
189019 |
|
0 |
N |
CSL |
No transaction in progress |
189027 |
|
0 |
N |
CSL |
Transaction in progress |
190000 |
|
1 |
Y |
CSL |
TCP connection/network failed |
190101 |
|
0 |
N |
CSL |
Error reading INI file |
190102 |
|
0 |
N |
CSL |
Check format of INI parameters |
SOAP
RequestHeader must be used on all methods called in any Web Service.
A
RequestHeader is used to attach a given set of information in a defined
structure. This can be the Authentication block, System name, Version and
Username
Definition
of the data structure for RequestHeader
Name |
Type |
Length Byte |
Description
– Comments |
AuthenticationInfo |
XML |
N/A |
Authentication
block for check and verification of a valid user calling the method. An
Authentication block can be retrieved by using GetUserLogin in
AuthenticationWS. Required
for all method except GetUserLogin in AuthenticationWS which can accept an
empty Authentication block. |
SystemInformation |
|
||
Version |
String |
N/A |
Used
for setting the clients version number. Optional
can be empty. |
SysName |
String |
N/A |
Used
for setting the name of the calling client. Required for execution of the Web
Service. For
use with PasLink for HL7 please se note below. |
|
|
||
UserName |
String |
N/A |
Username
using the Method/Web Service |
ConfigSectionName |
String |
N/A |
Sets
which section in ConfigServer for Web Service to use for database connection. |
NextKey |
String |
N/A |
Used
for paging/getting next page in some methods. |
SysName with PasLink HL7 (and only HL7
implementation)
In SysName for the HL7 implementation
MessageId and SenderId can be set in the SysName parameter.
The format is
ApplicationName;MessageId=xxx;SenderId=xxx where xxx I replaced with the
correct OID for the installation.
ApplicationName is a name that can identy
the application for logging purposes.
This is configured in the application
using/consuming PasLink. OID is set for each instance for the application.
E.g. SysName for Sympathy i HVIKT/Stavanger
Sympathy;MessageId=2.16.578.1.34.1.7.1.1;SenderId=2.16.578.1.34.7
SOAP
RequestHeader in a SOAP Envelope as it
is called to a method:
<soap:Header>
<RequestHeader xmlns="http://healthXML.org/PasLink">
<AuthenticationInfo>xml</AuthenticationInfo>
<UserName>string</UserName>
<SystemInfo>
<Version>string</Version>
<SysName>string</SysName>
</SystemInfo>
<ConfigSectionName>string</ConfigSectionName>
<NextKey>string</NextKey>
</RequestHeader>
</soap:Header>
SOAP
ResponseHeader exists in all data returned from any method in the Web Service.
ResponseHeader
contains a defined structure with information about ErrorInformation,
SystemInformation, ProfilInfo and the AuthenticationInfo block.
Definition
of the data structure for ResponseHeader
Name |
Type |
Length Byte |
Description
– Comments |
AuthenticationInfo |
XML |
N/A |
Authentication
block returned from Web Service. This is the same Authentication block as in
the RequestHeader calling the method. |
NextKey |
String |
N/A |
Used
for paging/getting next page in some methods. This is used with RequestHeader
for next request. |
ErrorInformation |
|
||
ErrorType |
String |
N/A |
Type
of error occurred |
ModuleName |
String |
N/A |
Module/class
where the error occurred |
SubModuleName |
String |
N/A |
Module/class
where the error originates from. |
FunctionName |
String |
N/A |
Method/Function
where the error occurred |
Description |
String |
N/A |
Description
of the error |
Code |
Long |
8 |
Error
code/number |
SubCode |
Long |
8 |
Sub
(error) code/number to further describe error/warning or information. |
RecoverableError |
Boolean |
|
Indicates
if an error is recoverable. True or False. To be used in conjunction with
error code and severity. |
Severity |
Enum |
N/A |
Indicates the severity/level of the error None = 0 Critical = 1 Warning =
2 Information
= 3 |
SystemInformation |
|
||
Version |
String |
N/A |
Version
number (assembly version) for the Web Service called. |
DatabaseInformation |
String |
N/A |
Database
information. |
DatabaseServer |
String |
N/A |
Database
server used. |
DatabaseName |
|
|
Name
of Database used. |
SysName |
String |
N/A |
SystemName
for the Web Service called. |
ProfileInfo |
|
||
UnitCode |
String |
N/A |
Unitcode
|
ProfileName |
String |
N/A |
Profilename |
DeptCode |
String |
N/A |
Departmentcode
|
SectionCode |
String |
N/A |
Sectioncode
|
SOAP ResponseHeader in a SOAP Envelope as it is returned from a method
called:
<soap:Header>
<ResponseHeader xmlns="http://healthXML.org/PasLink">
<AuthenticationInfo>xml</AuthenticationInfo>
<ErrorInformation>
<FunctionName>string</FunctionName>
<Severity>None or Critical or Warning or Information</Severity>
<ErrorType>string</ErrorType>
<ModuleName>string</ModuleName>
<Description>string</Description>
<Code>long</Code>
<SubCode>long</SubCode>
<RecoverableError>boolean</RecoverableError>
<SubModuleName>string</SubModuleName>
</ErrorInformation>
<ProfileInfo>
<DeptCode>string</DeptCode>
<SectionCode>string</SectionCode>
<UnitCode>string</UnitCode>
<ProfileName>string</ProfileName>
</ProfileInfo>
<SystemInformation>
<DatabaseInformation>string</DatabaseInformation>
<DatabaseServer>string</DatabaseServer>
<DatabaseName>string</DatabaseName>
</SystemInformation>
<NextKey>string</NextKey>
</ResponseHeader>
</soap:Header>
Version |
Date |
Edited
by |
Comments |
0.1 |
08.05.2003 |
Kristin Dahle |
First draft and internal revision |
1.0 |
13.05.2003 |
Jørn Agnar Solheim |
Updated after internal revision |
1.1 |
03.06.2003 |
Jørn Agnar Solheim |
.Net Framework 1.1 for the Web Services |
1.2 |
27.06.2003 |
Jørn Agnar Solheim |
New Web Services – ImportantMedicalFactsWS Correction in document(missing information) |
1.2.1 |
04.09.2003 |
Jørn Agnar Solheim |
New method ListPatientsById in PatientWS |
1.3 |
04.11.2003 |
Jørn Agnar Solheim |
New WS Authorization and new methods in
AuthenticationWS and OrganizationWS. Correction in text and links in other WS. |
1.4 |
31.03.2004 |
Eyvind Andersen |
Updated documentation for His90
(AuthorizationWS, PatientWS, OrganizationWS) |
1.5 |
01.07.2004 |
Jørn Agnar Solheim |
Updated methods with system |
1.13 |
15.12.2004 |
Eyvind Andersen |
Added documentation for BookingWS, ReferralWS
and UserConfigurationWS |
1.13 |
21.12.2004 |
Jørn Agnar Solheim |
Release of 1.13 version |
1.14 |
01.07.2005 |
Jørn Agnar Solheim |
Release of PasLinkWS 1.14 version. Updated
HIS90() and INFOMEDIX(). PasLinkWS & TEHC Framework installation and
configuration are moved to a separate document. |
1.14.1 |
03.10.2005 |
Jørn Agnar Solheim |
Updated minor errors in documentation. |
1.14.2 |
08.11.2005 |
Jørn Agnar Solheim |
Updated documentation for HIS90. |
1.14.3 |
15.11.2005 |
Jørn Agnar Solheim |
Updated with new methods for both Infomedix
and HIS90 |
1.15.0 |
15.06.2005 |
Armann Helgason |
Updated with new methods for HIS90 |
1.15.1-5 |
03.10.2006 |
Jørn Agnar Solheim |
Updated version numbers and minor updates to
PatientWS documentation. |
1.15.6 |
14.11.2006 |
Armann Helgason |
Updated EconomyWS and CommonCodesWS
documentation. New method GetServiceCode in CommonCodesWS and modified
HIS90SaveDebitTransaction in EconomyWS. |
2.1 |
28.01.2008 |
Jørn Agnar Solheim |
Added WaitingListWS and RequesterWS documents Removed EconomyWS as this is HIS90 specific Rewritten some text in chapter 1 |
2.1.8058 |
26.02.2008 |
Jørn Agnar Solheim |
Changes to BookingWS and WaitingListWS
documentation |
2.1.8102 |
11.04.2008 |
Jørn Agnar Solheim |
Updates in main document, BookingWS and
WaitingListWS after comments form customers. |
2.1.10082 |
23.03.2010 |
Jørn Agnar Solheim |
Updated several documenet after comments |
2.1.10145 |
27.05.2010 |
Jørn Agnar Solheim |
Updated several documenet after testing and
comments from customer |
2.1.10314 |
10.11.2010 |
Jørn Agnar Solheim |
Correct errors in documents. Added MasterPAS to documents. |
2.1.10320 |
16.11.2010 |
Jørn Agnar Solheim |
Correct errors in documents. Added BookingWS.ListAppointmentsByOrg |
2.1.11084 |
25.03.2011 |
Jørn Agnar Solheim |
Updated ContacWS, BookingWS, OrganizationWS,
PatientWS according to projects and trackers. |
2.1.12061 |
01.03.2012 |
Jørn Agnar Solheim |
Updated BookingWS with methods that are
renamed/changed. |
2.1.13066 |
07.03.2013 |
Jørn Agnar Solheim |
Updated main document, BookingWs,
WaitingListWS, + small changes in all other documents |
2.1.14302 |
29.10.2014 |
Jørn Agnar Solheim |
Added EventWS and DrugWS. New method and
changes to CommonCodesWS, WaitingListWS, DecisionWS and EconomyWS. |
2.1.14337 |
03.12.2014 |
Jørn Agnar Solheim |
Updated EventWS and DrugWS documentation. |
2.2.16291 |
17.10.2016 |
Jørn Agnar Solheim |
Updated documentation for new fetures/methods
for HIS90 autumn delivery. |
2.2.18236 |
23.11.2018 |
Jørn Agnar Solheim |
Updated documentation for new fetures/methods
for HIS90 november 2018 delivery. |
2.2.19036 |
07.02.2019 |
Jørn Agnar Solheim |
Updated for HIS90 – PAS2019-2.0 delivery |
2.2.19073 |
14.03.2019 |
Jørn Agnar Solheim |
Updated for HIS90 – PAS2019 delivery |
[1] Not implemented yeat, only WS
interface is defined
[2] ListAllMunicipalityCodes and
ListAllPostalCodes is not documented
[3] New ListCommonCodes method is a
general method that replaces most of the previous methods in CommonCodesWS
[4] ListMedicalCodeCombinations is an
internal method, therefore no public documentation
[5] SearchMunicipalityCodes and
SearchPostalCodes is not documented
[6] For HIS90 use GetContact instead of
GetPatientContact. Old method will be obsoleted for HIS90 from 01.07.2013
[7] For HIS90 use ListContact instead
of GetPatientContacts. Old method will be obsoleted for HIS90 from 01.07.2013
[8] ListDecisionsByOrg is under testing,
and no documentation is available before method is approved.
[9] DrugWS is not documented as methods
are internal. Documentation will be available when methods are made public.
[10] GetPatientLatestDrugInformation is
under testing, and no documentation is available before method is approved.
[11] GetPaqEvent is an internal HIS90
method, will in the future be replace with an official method. No
documentation.
[12] WaitingLiistWS methods
ListCarePeriodInformations, SaveCarePeriodInformation and DeleteCarePeriodInformation
is not documented as methods are internal. Documentation will be available when
methods are made public.