Version: 2.1.14297
The Web
Service includes methods that handle demographic data about a requester. New requesters
can be inserted and requester data can be read and updated.
The RequesterWS
Web Service contains these methods:
The Web Service reference is: RequesterWS.asmx
For more
detailed information as the Web Service's WSDL, SOAP request and response see:
https://linkws.service.tieto.com/PasLinkWS/RequesterWS/RequesterWS.asmx
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
|
Description:
Method is used for listing requester’s information
for valid requesters in query period. If period is not in input the method
lists valid requesters on current date. The listing can be filtered on type of
requester, zip code, requester payment type and/or municipality and county
Syntax:
ListRequestersResponse = ListRequester(ListRequestersRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
ListRequestersRequest |
|
N/A Dynamic |
ListRequestersRequest
class according to XML schema Requester.xsd |
|
Description: |
|
|
|
|
FromDate |
|
|
From
date for query period. Default:
Current date if there is no date in input |
|
ToDate |
|
|
To
date for query period. Default:
Current date if there is no date in input. |
|
Name |
|
|
Name
or name-part used for query. Listing
using name/name-part can not be used when listing on Id/Id part is used. Wildcard
search with % can be used. |
|
Ids.Id.RequesterId |
|
|
It
is possible to narrow requested listing using requester code or part of
requester code (LEN) and/or HER Id. Listing using Id/Id part can not be used
when listing on name/name-part part is used. HIS90: Wildcard
search with % can be used. Only
starts with is valid E.g. OLA% |
|
Ids.Id.IdType |
|
|
Type
of RequesterId in input HIS90:
Valid
types are: LEN
(obsolete do not use) LRC
Internal Requester id/code HER
Official Her id |
|
MaxRows |
|
|
Maximum
numbers of rows in response. If not in input maximum numbers of rows returned
in response are 300. Max.
total in one request is 9999. |
|
RequesterType |
|
|
Type
of requester. HIS90: Type
of requesters has fixed valid values in a range from 1 – 7. |
|
Address.PostalCode |
|
|
Requesters
Postal Code. HIS90:
Valid
postcode can be found in PAQPOST.POST_NO using CommonCodesWS.ListPostCodes. |
|
Address.Municipality |
|
|
Municipality
and County of payable social security office. HIS90:
Valid
code can be found in PAQMUNI and listed by using
CommonCodesWS.ListMunicipalityCodes. The method gives combined municipality
and county code where county is the 2 first digits in the code and
municipality is the 2 last digits. |
|
PaymentMethodType |
|
|
Payment
method for the requester. HIS90:
Valid
code can be found in PAQPAYM and listed by using CommonCodesWS. ListPaymentMethodCodes |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
ListRequestersResponse |
|
N/A Dynamic |
ListRequestersResponse
class according to XML schema Requester.xsd |
|
Description: |
|
|
|
|
TypeId |
|
|
Requester
Id Type. HIS90:
For
HIS90 this Id is ‘LEN’ (Lokal Enhets Nummer) |
|
RequesterId |
|
|
Requester
internal id. HIS90:
A
unique requester id. |
|
Name |
|
|
Requesters
name. |
|
AdditionalIds.AdditionalId.Id. RequesterId |
|
|
Additonal
requester id E.g.
HER-id, Organization number, RESH id etc |
|
AdditionalIds.AdditionalId.Id. Type |
|
|
Type
of additional The
type/code must be in accourdance to (KITH) code table 8268 Type
Identificator. |
|
RequesterType.Type |
|
|
Code
for type of requester. HIS90:
In
HIS90 type of requesters has fixed valid values in a range from 1 – 7. Description
of valid HIS90 values: 1. Ekstern institusjon. 2. Helsestasjon, Legesenter. 3. Ekstern lege. 4. Intern sengepost. 5. Intern poliklinikk. 6. Intern lege. 7. Aldershjem. |
|
RequesterType.Text |
|
|
Description
for RequesterType.Type See
information in Type above for valid Texts |
|
ValidPeriode.FromDate |
|
|
From-date
for requester code period of validity. |
|
ValidPeriode.ToDate |
|
|
To-date
for requester code period of validity. |
|
Economy.PaymentMethod.Type |
|
|
Code
for requester’s method of payment. HIS90:
Valid
code can be found in PAQPAYM and listed by using CommonCodesWS. ListPaymentMethodCodes |
|
Economy.PaymentMethod.Text |
|
|
Description
of payment method. |
|
Address.AddressLines.AddressLine.Type |
|
|
Requester
Address Type. HIS90:
Address
of requester is created using 2 address lines. The first line has type
defaulted to ‘1’ and the second on, if in use, is defaulted to ‘2’ |
|
Address.AddressLines.AddressLine.Text |
|
|
Address
information corresponding to type |
|
Address.PostalAddress.Code |
|
|
Requesters
Postal Code. |
|
Address.PostalAddress.Name |
|
|
Post
Offie corresponding to Postal Code. |
|
Address.Municipality.Code |
|
|
Municipality
for requester. HIS90: N/A
– Ikke i bruk |
|
Address.Municipality.Name |
|
|
Municipality
name HIS90: N/A
– Ikke i bruk |
Schema for Requesters: Requester.xsd
Schema
documentation for ListRequesters: Requester.html
Sample xml
file for ListRequesters: ListRequestersRequest.xml ListRequestersResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/RequesterWS/RequesterWS.asmx?op=ListRequesters
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 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 RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS90 specific information:
For getting
detailed information about single requester use GetRequester method. Number of
rows can be selected using MaxRows in request. If max rows are not used than
number of requesters in response are 500. If there are more requesters than
requested in maxrows than use next key from SOAP header and use it for paging.
Max number of rows in a single query is 9999.
The method
uses PAS server CWRQ01 and service 54428
There are
no access restrictions for users using this method.
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
|
Description:
Method is used getting detail information about
single requester.
Syntax:
GetRequesterResponse = GetRequester(GetRequesterRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
GetRequesterRequest |
|
N/A Dynamic |
GetRequesterRequest
class according to XML schema Requester.xsd |
|
Description: |
|
|
|
|
TypeId |
|
|
Requester
Id Type. Mandatory in input Valid
values are: LEN
( LRC
= uses internal id to find requester HER
= uses HER-id id to find requester |
|
RequesterId |
|
|
Unique
Requester Id. Mandatory in input HIS90:
Internal
requester Id from PAQREQR. REQR_CODE |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
GetRequesterResponse |
|
N/A Dynamic |
GetRequesterResponse
class according to XML schema Requester.xsd |
|
Description: |
|
|
|
|
TypeId |
|
|
Requester
Id Type. HIS90: For
HIS90 this Id is ‘LEN’ (Lokal Enhets Nummer) |
|
RequesterId |
|
|
Requester
internal id. HIS90:
A
unique requester id. |
|
Name |
|
|
Requesters
name. |
|
AdditionalId.AdditionalIds.Type |
|
|
Type
of additional ids for the requester HIS90: Following
codes/types are valid for HIS90: NPR,
LOK, HER |
|
AdditionalId.AdditionalIds.RquesterId |
|
|
Additional
requester Id according to type. NPR-Id, HER-Id and LOK-local Id. |
|
RequesterType.Type |
|
|
Code
for type of requester. HIS90:
In
HIS90 type of requesters has fixed valid values in a range from 1 – 7. See
Text below for description of the values. |
|
RequsterType.Text |
|
|
Description
of requester type HIS90: For
HIS90 description of requester type is hardcoded in method for HIS90: Description
of valid HIS90 values: 1. Ekstern institusjon. 2. Helsestasjon / Legesenter. 3. Ekstern lege. 4. Intern sengepost. 5. Intern poliklinikk. 6. Intern lege. 7. Aldershjem. |
|
ValidPeriode.FromDate |
|
|
From-date
for requester code period of validity. |
|
ValidPeriode.ToDate |
|
|
To-date
for requester code period of validity. |
|
RequesterMedSpecialty.RequesterMedSpecialties.Code |
|
|
Medical
specialty. Requester can have multiple specialties. HIS90: N/A |
|
RequesterMedSpecialty.RequesterMedSpecialties.Text |
|
|
Medical
specialty code description. HIS90: N/A |
|
Printers.Deparment |
|
|
HIS90
Specific: Department where requesters printers resides |
|
Printers.LinePrinter |
|
|
HIS90
Specific: Requesters default line printer |
|
Printers.LabelPrinter |
|
|
HIS90
Specific: Requesters default label printer |
|
Address.AddressLines.AddressLine.Type |
|
|
Requester
Address. HIS90:
Address
of requester is created using 2 address lines. The first line has type
defaulted to ‘1’ and the second one to ‘2’ |
|
Address.AddressLines.AddressLineText |
|
|
Address
information |
|
Address.PostalAddress.Code |
|
|
Requesters
Postal Code. HIS90:
Valid
postcodes are found in PAQPOST using
CommonCodesWS.ListPostCodes. |
|
Address.PostalAddress.Name |
|
|
Post
Office corresponding to Postal Code. Name is found in PAQPOST. |
|
Address.Municipality.Code |
|
|
Municipality
and County of payable social security office. HIS90:
Valid
code can be found in PAQMUNI and listed by using
CommonCodesWS.ListMunicipalityCodes. The method gives combined municipality
and county code where county is the 2 first digits in the code and
municipality is the 2 last digits. |
|
Address.Municipality.Name |
|
|
Municipality
name. HIS90:
Name is found in PAQMUNI. |
|
UrbanNeighbourhood.Code |
|
|
HIS90: N/A |
|
UrbanNeighbourhood.Name |
|
|
HIS90: N/A |
|
HouseProperty |
|
|
HIS90: N/A |
|
District |
|
|
HIS90: N/A |
|
BillingDistrict |
|
|
HIS90: N/A |
|
Telecom.OfficePhoneNumber.Value |
|
|
Requester’s
office phone number. HIS90:
Requester’s
phone number excluding extension. |
|
Telecom.OfficePhoneNumber.Extension |
|
|
Requester’s
office phone extension. |
|
Telecom.MobilePhone |
|
|
HIS90: N/A |
|
Telecom.FaxNumber |
|
|
Requesters
fax number. |
|
Telecom.EMailAddress |
|
|
HIS90: N/A |
|
Economy.PaymentMethod.Type |
|
|
Requester’s
method of payment. HIS90:
Valid
method of payment and description is in PAQPAYM . |
|
Economy.PaymentMethod.Text |
|
|
Description
of payment method. |
|
Economy.Giro.AccountNumber.Type |
|
|
Account
type. HIS90: Valid
types for HIS90 are “BANK” that is valid for number in
PAQREQR.BANK_GIRO_ACC_NO and “POST” that is valid for number in
PAQREQR.POSTAL_GIRO_ACC_NO |
|
Economy.Giro.AccountNumber.Number |
|
|
Requesters
account numbers. |
|
UpdateCount |
|
|
HIS90
only: UpdateCount used for concurrency check when updating patient. |
Schema for Requesters: Requester.xsd
Schema
documentation for GetRequester: Requester.html
Sample xml
file for GetRequester: GetRequesterRequest.xml GetRequesterResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/RequesterWS/RequesterWS.asmx?op=GetRequester
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 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 RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS90 specific information:
Currently
both Id’s from PAQREQR.REQR_CODE and
PAQREQR.HER_ID is valid as Id input. The Id types for local REQR_CODE is ‘LEN’
and for official HER_ID is ‘HER’
The method
uses PAS server CWRQ01 and service 54449
There are
no access restrictions for users using this method.
Errorcodes to note:
If erreorcode 11 is returned from the
GetRequester method, this
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
|
Description:
Method is used creating or modifying a single requester.
Syntax:
SaveRequesterResponse = SaveRequester(SaveRequesterRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
SaveRequesterRequest |
|
N/A Dynamic |
SaveRequesterRequest
class according to XML schema Requester.xsd |
|
Description: |
|
|
|
|
TypeId |
|
|
Requester
Id Type. Mandatory input HIS90:
For
HIS90 this Id is ‘LRC’ (Lokal Enhets Nummer) |
|
RequesterId |
|
|
Requester
internal id. Mandatory input. HIS90:
A
unique requester id. |
|
Name |
|
|
Requesters
name. |
|
AdditionalId.AdditionalIds.Type |
|
|
Type
of additional id for requester. HIS90: Following
codes/types are valid for HIS90: NPR,
LOK, HER |
|
AdditionalId.AdditionalIds.RquesterId |
|
|
Additional
requester Id according to type. NPR-Id, HER-Id, RESH_ID and LOK-local Id. |
|
RequesterType.Type |
|
|
Code
for type of requester. HIS90:
In
HIS90 type of requesters has fixed valid values in a range from 1 – 7. See
Text below for description of the values. Description
of valid HIS90 values: 1. Ekstern institusjon. 2. Helsestasjon / Legesenter. 3. Ekstern lege. 4. Intern sengepost. 5. Intern poliklinikk. 6. Intern lege. 7. Aldershjem. |
|
RequsterType.Text |
|
|
Description
of requester type HIS90: N/A
for in request to save requester |
|
ValidPeriode.FromDate |
|
|
From-date
for requester code period of validity. |
|
ValidPeriode.ToDate |
|
|
To-date
for requester code period of validity. |
|
RequesterMedSpecialty.RequesterMedSpecialties.Code |
|
|
Medical
specialty. Requester can have multiple specialties. HIS90:
N/A |
|
RequesterMedSpecialty.RequesterMedSpecialties.Text |
|
|
Medical
specialty code description. HIS90:
N/A |
|
Printers.Deparment |
|
|
HIS90
Specific: Department where requesters printers resides |
|
Printers.LinePrinter |
|
|
HIS90
Specific: Requesters default line printer |
|
Printers.LabelPrinter |
|
|
HIS90
Specific: Requesters default label printer |
|
Address.AddressLines.AddressLine.Type |
|
|
Requester
Address. HIS90:
Address
of requester is created using 2 address lines. The first line has type
defaulted to ‘1’ and the second one to ‘2’ |
|
Address.AddressLines.AddressLine.Text |
|
|
Address
information HIS90: Maximum
length is 25 characters. |
|
Address.PostalAddress.Code |
|
|
Requesters
Postal Code. HIS90:
Valid
postcodes are found in PAQPOST using
CommonCodesWS.ListPostCodes. |
|
Address.PostalAddress.Name |
|
|
Post
Office corresponding to Postal Code. Name is found in PAQPOST. HIS90: N/A
for in request to save requester |
|
Address.Municipality.Code |
|
|
Municipality
and County of payable social security office. HIS90:
Valid
code can be found in PAQMUNI and listed by using
CommonCodesWS.ListMunicipalityCodes. The method gives combined municipality
and county code where county is the 2 first digits in the code and
municipality is the 2 last digits. Set
according to zip code if municipality is not in input |
|
Address.Municipality.Name |
|
|
Municipality
name. HIS90: N/A
for in request to save requester |
|
UrbanNeighbourhood.Code |
|
|
HIS90:
N/A |
|
UrbanNeighbourhood.Name |
|
|
HIS90:
N/A |
|
HouseProperty |
|
|
HIS90:
N/A |
|
District |
|
|
HIS90:
N/A |
|
BillingDistrict |
|
|
HIS90:
N/A |
|
Telecom. HomePhoneNumber |
|
|
HIS90:
N/A |
|
Telecom.OfficePhoneNumber.Value |
|
|
Requester’s
office phone number. HIS90:
Requesters phone number excluding extension. Maximum
length is 11 characters. |
|
Telecom.OfficePhoneNumber.Extension |
|
|
Requester’s
office phone extension. HIS90: Maximum
length is 4 characters. |
|
Telecom.MobilePhone |
|
|
Requester
mobile phone number HIS90:
N/A |
|
Telecom.FaxNumber |
|
|
Requesters
fax number. |
|
Telecom.EMailAddress |
|
|
Email
address for requester HIS90:
N/A |
|
Economy.PaymentMethod.Type |
|
|
Requester’s
method of payment. HIS90:
Valid
method of payment and description is in PAQPAYM . |
|
Economy.PaymentMethod.Text |
|
|
Description
of payment method. HIS90: N/A
for in request to save requester |
|
Economy.Giro.AccountNumber.Type |
|
|
Account
type. HIS90: Valid
types for HIS90 are “BANK” that is valid for number in
PAQREQR.BANK_GIRO_ACC_NO and “POST” that is valid for number in
PAQREQR.POSTAL_GIRO_ACC_NO |
|
Economy.Giro.AccountNumber.Number |
|
|
Requesters
account numbers. |
|
UpdateCount |
|
|
HIS90
only: UpdateCount used for concurrency check when updating patient. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
SaveRequesterResponse |
|
N/A Dynamic |
SaveRequesterResponse
class according to XML schema Requester.xsd |
|
Description: |
|
|
|
|
TypeId |
|
|
Requester
Id Type. Mandatory input HIS90:
For HIS90 this Id is ‘LEN’ (Lokal Enhets Nummer) |
|
RequesterId |
|
|
Requester
internal id. Mandatory input. HIS90:
A unique requester id. |
|
Name |
|
|
Requesters
name. |
|
AdditionalId.AdditionalIds.Type |
|
|
Following
codes/types are valid for HIS90: NPR,
LOK, HER |
|
AdditionalId.AdditionalIds.RquesterId |
|
|
Additional
requester Id according to type. NPR-Id, HER-Id, RESH_ID and LOK-local Id. |
|
RequesterType.Type |
|
|
Code
for type of requester. HIS90:
In
HIS90 type of requesters has fixed valid values in a range from 1 – 7. See
Text below for description of the values. |
|
RequsterType.Text |
|
|
Description
of requester type HIS90: For
HIS90 description of requester type is hardcoded in method for HIS90: Description
of valid HIS90 values: 1. Ekstern institusjon. 2. Helsestasjon / Legesenter. 3. Ekstern lege. 4. Intern sengepost. 5. Intern poliklinikk. 6. Intern lege. 7. Aldershjem. |
|
ValidPeriode.FromDate |
|
|
From-date
for requester code period of validity. |
|
ValidPeriode.ToDate |
|
|
To-date
for requester code period of validity. |
|
RequesterMedSpecialty.RequesterMedSpecialties.Code |
|
|
Medical
specialty. Requester can have multiple specialties. HIS90:
N/A |
|
RequesterMedSpecialty.RequesterMedSpecialties.Text |
|
|
Medical
specialty code description. HIS90:
N/A |
|
Printers.Deparment |
|
|
HIS90
Specific: Department where requesters printers resides |
|
Printers.LinePrinter |
|
|
HIS90
Specific: Requesters default line printer |
|
Printers.LabelPrinter |
|
|
HIS90
Specific: Requesters default label printer |
|
Address.AddressLines.AddressLine.Type |
|
|
Requester
Address. HIS90:
Address of requester is created using 2 address lines. The first line has type
defaulted to ‘1’ and the second one to ‘2’ |
|
Address.AddressLines.AddressLineText |
|
|
Address
information |
|
Address.PostalAddress.Code |
|
|
Requesters
Postal Code. HIS90:
Valid
postcodes are found in PAQPOST using
CommonCodesWS.ListPostCodes. |
|
Address.PostalAddress.Name |
|
|
Post
Office corresponding to Postal Code. Name is found in PAQPOST. |
|
Address.Municipality.Code |
|
|
Municipality
and County of payable social security office. HIS90:
Valid code can be found in PAQMUNI and listed by using
CommonCodesWS.ListMunicipalityCodes. The method gives combined municipality
and county code where county is the 2 first digits in the code and
municipality is the 2 last digits. |
|
Address.Municipality.Name |
|
|
Municipality
name. HIS90:
Name is found in PAQMUNI. |
|
UrbanNeighbourhood.Code |
|
|
HIS90:
N/A |
|
UrbanNeighbourhood.Name |
|
|
HIS90:
N/A |
|
HouseProperty |
|
|
HIS90:
N/A |
|
District |
|
|
HIS90:
N/A |
|
BillingDistrict |
|
|
HIS90:
N/A |
|
Telecom. HomePhoneNumber |
|
|
HIS90:
N/A |
|
Telecom.OfficePhoneNumber.Value |
|
|
Requester’s
office phone number. HIS90:
Requester’s
phone number excluding extension. |
|
Telecom.OfficePhoneNumber.Extension |
|
|
Requester’s
office phone extension. |
|
Telecom.MobilePhone |
|
|
Requester
mobile phone number HIS90:
N/A |
|
Telecom.FaxNumber |
|
|
Requesters
fax number. |
|
Telecom.EMailAddress |
|
|
Email
address for requester HIS90:
N/A |
|
Economy.PaymentMethod.Type |
|
|
Requester’s
method of payment. HIS90:
Valid
method of payment and description is in PAQPAYM . |
|
Economy.PaymentMethod.Text |
|
|
Description
of payment method. |
|
Economy.Giro.AccountNumber.Type |
|
|
Account
type. Valid
types for HIS90 are “BANK” that is valid for number in
PAQREQR.BANK_GIRO_ACC_NO and “POST” that is valid for number in
PAQREQR.POSTAL_GIRO_ACC_NO |
|
Economy.Giro.AccountNumber.Number |
|
|
Requesters
account numbers. |
|
UpdateCount |
|
|
HIS90
only: UpdateCount used for concurrency check when updating patient. |
Schema for Requesters: Requester.xsd
Schema
documentation for SaveRequester: Requester.html
Sample xml
file for SaveRequester: SaveRequesterRequest.xml SaveRequesterResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/RequesterWS/RequesterWS.asmx?op=SaveRequester
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 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 RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS90 specific information:
The method
is used to create or modify requester in PAQREQR. All char that are saved in
PAQREQR are saved as HighChar. – the method is Case insensitive.
The method
uses PAS server CWRQ01
and service 54449
There are
no access restrictions for users using this method.