Version: 2.1.17180
Web Service
with methods to get information about a giro, save a giro, update a giro and
delete a giro
All methods
require a correct and verified Authentication Block from AuthenticationWS to
get any information from the HIS.
The Economy
Web Service contains these methods:
The Web Service reference is: EconomyWS.asmx
For more
detailed information as the Web Service's WSDL, SOAP request and response see:
https://linkws.service.tieto.com/PasLinkWS/EconomyWS/Economy.asmx
Applicable
systems for method:
HIS90 |
|
|
|
|
|
Description:
Gets a giro
based on input kid
Returns one
giro.
Syntax:
GetGiroResponse = GetGiro(GetGiroRequest)
Request:
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
GetGiroRequest |
|
|
Request
class according to XML schema in EconomyWS.xsd |
Description of request: |
|
|
|
KID |
String |
|
Valid
KID existing in PAS. Required. HIS90: KID
must be Mod10. |
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
GetGiroResponse
|
|
|
Response class according to XML schema in EconomyWS.xsd |
|
Description of response: |
|
|
|
|
PatientId |
Number |
|
Internal
Patient's id in the HIS. Use PatientWS.GetPatient to get detailed
patient information. |
|
KID |
String |
|
Giro’s
KID-number |
|
VistitDateTime |
DateTime |
|
Date
and time of visit |
|
Organization.Id |
String |
|
Internal OrganizationId for
medical/care unit where patient visited. Use OrganizationWS.GetOrganization2G to get detailed unit information. Id will always be care unit as
this is the only allowed id in HIS90 PAS. |
|
Organization.TypeOfId |
String |
|
Type of Id for Organization HIS90: Always LEN for HIS90 PAS |
|
Organization.ShortNameId |
String |
|
Short name of organization |
|
Organization.Name |
String |
|
Name of organization |
|
PaymentMethod.Code |
String |
|
Payment
method kode |
|
PaymentMethod.Text |
String |
|
Payment
method description |
|
Amount |
Decimal |
|
Amount that shall be paid by the
patient |
|
Update.Date |
DateTime |
|
Date when last modified. |
|
Update.Name |
String |
|
Person updating the record |
|
Update.Organization.Id |
Number |
|
Id for Organization responsible
for insertion/last modification of the instance. HIS90:
N/A |
|
Update.Organization.TypeOfId |
String |
|
Type of ID for organization. HIS90:
N/A |
|
Update.Organization.ShortNameId |
String |
|
Code/Shortname on Organization
responsible for insertion/last modification of the instance. HIS90:
N/A |
|
Update.Organization.Name |
String |
|
Name on Organization responsible
for insertion/last modification of the instance. HIS90:
N/A |
|
Update.SignedBy |
String |
|
Signature of user responsible for
last update HIS90:
N/A |
|
Schema for GetGiro: EconomyWS.xsd
Schema
documentation for GetGiro: EconomyWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EconomyWS/EconomyWS.asmx?op=GetGiro
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
ListOrganizations For getting organizationinfo
ListOrganizations2G
For getting organizationinfo
GetOrganization2G For getting organizationinfo
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
form 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.
Applicable
systems for method:
HIS90 |
|
|
|
|
|
Description:
Saves or updates a giro on a existing
patient.
Syntax:
SaveGiroResponse
= SaveGiro(SaveGiroRequest)
Request:
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
SaveGiroRequest |
|
|
Request class according to XML schema in EconomyWS.xsd |
Description of request: |
|
|
|
PatientId |
Number |
|
Internal
Patient's id in the HIS. Use PatientWS.ListPatients or PatientWS.GetPatient
to get a valid patient. |
KID |
String |
|
Giro’s
KID-number |
VistitDateTime |
DateTime |
|
Date
and time of visit |
Organization.Id |
String |
|
Internal OrganizationId for
medical/care unit where patient visited Use Use OrganizationWS.ListOrganizations, OrganizationWS.ListOrganizations2G or
OrganizationWS.GetOrganization2G to get a valid unit. Id will always must care unit as
this is the only allowed id in HIS90 PAS. |
Organization.TypeOfId |
String |
|
Type of Id for Organization HIS90: Always LEN for HIS90 PAS |
Organization.ShortNameId |
String |
|
Not used for save. |
Organization.Name |
String |
|
Not used for save. |
PaymentMethod.Code |
String |
|
Payment
method code Use CommonCodesWS.ListCommonCodes
with CommonCodeType= PaymentMethodCode to get a valid code. HIS90: If PaymentMethod.Code is null or empty the value 2 for
giro will be set as default value. |
PaymentMethod.Text |
String |
|
Payment
method description |
Amount |
Decimal |
|
Amount that shall be paid by the
patient |
Update.Date |
DateTime |
|
Not used for save. Automatic set by the web service
method or database. |
Update.Name |
String |
|
Not used for save. Automatic set by the web service
method or database. |
Update.Organization.Id |
Number |
|
Not used for save. Automatic set by the web service
method or database. |
Update.Organization.TypeOfId |
String |
|
Not used for save. Automatic set by the web service
method or database. |
Update.Organization.ShortNameId |
String |
|
Not used for save. Automatic set by the web service
method or database. |
Update.Organization.Name |
String |
|
Not used for save. Automatic set by the web service
method or database. |
Update.SignedBy |
String |
|
Not used for save. Automatic set by the web service
method or database. |
Response:
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
SaveGiroResponse
|
|
|
Response class according to XML schema in EconomyWS.xsd Same
as GetGiro, see GetGiroRepsonse |
Schema for SaveGiro: EconomyWS.xsd
Schema
documentation for SaveGiro: EconomyWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EconomyWS/EconomyWS.asmx?op=SaveGiro
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
PatientWS.ListPatients For getting patient
PatientWS.GetPatient
For getting patient
ListOrganizations For getting organizationinfo
ListOrganizations2G
For getting organizationinfo
GetOrganization2G For getting organizationinfo
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
form 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.
Applicable
systems for method:
HIS90 |
|
|
|
|
|
Description:
Deletes an existing giro.
Syntax:
DeleteGiroResponse
= DeleteGiro(DeleteGiroRequest)
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
DeleteGiroRequest |
|
|
Request
class according to XML schema in EconomyWS.xsd |
Description
of request: |
|
|
|
KID |
String |
N/A |
Valid
KID existing in PAS. This
field is required. HIS90: KID
must be Mod10 valid. |
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
DeleteGiroResponse
|
|
|
Response class according to XML schema in EconomyWS.xsd DeleteGiroResponse
does not contain any data. Result
from a DeleteGiro operation is display in ResponseHeader.ErrorInformation
block where Code is 0 if delete was ok or Code<>0 if an error occurred.
See comments below. |
Schema for DeleteGiro: EconomyWS.xsd
Schema
documentation for DeleteGiro: EconomyWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EconomyWS/EconomyWS.asmx?op=DeleteGiro
Related
methods or functions used:
GetUserLogin Used
to verify as 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
form 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.
Applicable
systems for method:
HIS90 |
|
|
|
|
|
Description:
List the
balance reports for a given cash box. Balance reports can be filtered dates(default
is today) orginazation unit or payment methods.
Syntax:
GetCashBoxBalanceReportResponse = GetCashBoxBalanceReport(GetCashBoxBalanceReportRequest)
Request:
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
GetCashBoxBalanceReportRequest |
|
|
Request
class according to XML schema in EconomyWS.xsd |
Description of request: |
|
|
|
CashBoxCode |
String |
|
Valid
CashCode. Required. HIS90: Use
CommonCodesWS.ListCommonCodes with CommonCodeType=CashCode. |
RegistrationDate.FromDate |
Date |
|
Start
of timeinterval used to filter balance reports. If
omitted, blank date or not a valid date today’s date will be used when the
method is called. |
RegistrationDate.ToDate |
Date |
|
End
of timeinterval used to filter balance reports. If
omitted, blank date or not a valid date today’s date will be used when the
method is called. |
Organization.Id |
Number |
|
Internal
OrganizationId for the medical/care unit to include in the balance report. If
omitted, no filtering on medical/care unit will be performed. |
Organization.TypeOfId |
String |
|
Type
of Id for Organization. Valid values: LAV = Local medical unit/department id LEN = Local care unit id HIS90: Required if Organization.Id is
specified. |
Organization.ShortName |
String |
|
Not
used by the service. |
Organization.Name |
String |
|
Not
used by the service. |
PaymentMethodFilter |
List of String |
|
Filter
the balance reports on the given payment codes. If
omitted, no filtering on payment method will be performed. Use
CommonCodesWS.ListCommonCodes with CommonCodeType=PaymentMethodCode.
|
Response:
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
GetCashBoxBalanceResponse
|
|
|
Response class according to XML schema in EconomyWS.xsd |
|
Description of response: |
|
|
|
|
CashBox.Code |
String |
|
Cash
box code |
|
CashBox.Text |
String |
|
Description
of cash box. |
|
ReportDate |
DateTime |
|
Date
and time when report is retrieved. |
|
ExecutingUser |
String |
|
Name of user that requested the
report. |
|
RegistrationDate.FromDate |
Date |
|
Start of interval used in
filtering balance reports. If omitted in request, the value
will be today’s date. |
|
RegistrationDate.ToDate |
Date |
|
Start of interval used in
filtering balance reports. If omitted in request, the value
will be today’s date. |
|
OrganizationUnits.MedicalUnit.Id |
Number |
|
Id for the local medical
unit/department. |
|
OrganizationUnits.MedicalUnit.TypeOfId |
Number |
|
Type of organization id. HIS90: Always LAV. |
|
OrganizationUnits.MedicalUnit.ShortNameId |
String |
|
Short name/code of organization. HIS90: Set by PAS server program. |
|
OrganizationUnits.MedicalUnit.Name |
String |
|
Name of organization. HIS90: Set by PAS server program. |
|
OrganizationUnits.MedicalUnit.AdditionalIds.AdditionalId.Id |
String |
|
Additional ids for the
organization |
|
OrganizationUnits.MedicalUnit.AdditionalIds.AdditionalId.TypeOfId |
String |
|
Type of additional id KITH code standard 8268 Some of the types are: ENH=Off. org.no in Br.sund HER=HER-id RSH=RESH-id NPR=
NPR nr LOK=
Lokal id XXX=Annet Other Tieto codes are: For HIS90: LUI=UniqueId |
|
OrganizationUnits.MedicalUnit.AdditionalIds.AdditionalId.Description |
String |
|
Description of the MedicalUnit additional id |
|
OrganizationUnits.CareUnit.Id |
Number |
|
Id for the local care unit. |
|
OrganizationUnits. CareUnit.TypeOfId |
Number |
|
Type of organization id. HIS90: Always LEN |
|
OrganizationUnits. CareUnit.ShortNameId |
String |
|
Short name/code of organization. HIS90: Set by PAS server program. |
|
OrganizationUnits. CareUnit.Name |
String |
|
Name of organization. HIS90: Set by PAS server program. |
|
OrganizationUnits.CareUnit.AdditionalIds.AdditionalId.Id |
String |
|
Additional ids for the CareUnit
organization |
|
OrganizationUnits.CareUnit.AdditionalIds.AdditionalId.TypeOfId |
String |
|
Type of additional id KITH code standard 8268 Some of the types are: ENH=Off. org.no in Br.sund HER=HER-id RSH=RESH-id NPR=
NPR nr LOK=
Lokal id XXX=Annet Other Tieto codes are: For HIS90: LUI=UniqueId |
|
OrganizationUnits.CareUnit.AdditionalIds.AdditionalId.Description |
String |
|
Description of the additional id |
|
OrganizationUnits.PaymentMethods.PaymentMethod.Code |
String |
|
Payment
code for the payment. |
|
OrganizationUnits.PaymentMethods.PaymentMethod.Text |
String |
|
The name of the payment method. |
|
OrganizationUnits.PaymentMethods.NumberOfTransactions |
Number |
|
Number of transactions for the payment method. |
|
OrganizationUnits.PaymentMethods.Amount |
Decimal |
|
Amount paid by the payment
method.. |
|
OrganizationUnits.TotalAmountCareUnit |
Decimal |
|
Total amount paid at unit. |
|
TotalAmount |
Decimal |
|
Total amount cash box. |
|
Schema for GetCashBoxBalanceReport: EconomyWS.xsd
Schema
documentation for GetCashBoxBalanceReport: EconomyWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EconomyWS/EconomyWS.asmx?op=GetCashBoxBalanceReport
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
ListOrganizations For getting organizationinfo
ListOrganizations2G
For getting organizationinfo
GetOrganization2G For getting organizationinfo
ListCommonCodes For getting cash code and payment
methods
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
form 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.
Applicable
systems for method:
HIS90 |
|
|
|
|
|
Description:
Lists
information about economy transactions for one bill or patient’s contact.
Syntax:
GetEconomyTransactionsResponse
= GetEconomyTransactions (GetEconomyTransactionsRequest)
Request:
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
GetEconomyTransactionsRequest |
|
|
Request
class according to XML schema in EconomyWS.xsd. Either ContactId or
BillNumberId must be in input. If both are in input ContactId is used. |
Description of request: |
|
|
|
ContactId |
String |
|
Combined
Id: PatientId|SourceOfServ|SerialNoMeca|SerialNoStay |
BillNumberId |
String |
|
CombinedId:
Unique bill number id. BillNumberPatient|SourceOfServ |
Response:
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
GetEconomyTransactionsResponse |
|
|
Response class according to XML schema in EconomyWS.xsd.
Includes |
|
Description of response: |
|
|
|
|
PatientId |
Int |
|
Internal
PID |
|
EconomytransactionId |
String |
|
HIS90: Combined internal id for one cost
row. That is a Economy transaction.
PatientID|SourceOfServ|SerialNoMeca|SerialNoStay|SerialNoSeco|SerialNoCost |
|
ContactId |
String |
|
HIS90: Combined Id:
PatientId|SourceOfServ|SerialNoMeca|SerialNoStay |
|
BillNumberId |
String |
|
HIS90: CombinedId: Unique bill number id.
BillNumberPatient|SourceOfServ |
|
BillNumber |
String |
|
Unique bill number used in
communication with patient. |
|
Status |
Status |
|
Status for an economy row. Ether
status Active or Cancelled |
|
Source.Code |
String |
|
Code/description of type of service,
example 1 for inpatient and 2 for outpatient |
|
Source.Text |
|
|
Description of source code |
|
Codes.Procedure.ProcedureId |
String |
|
Internal id for service or
procedure. HIS90:
Combined Id. SerialNoMeca|SerialNoStay|SourceOfServ|SerialNoServ |
|
Codes.Procedure.BelongsToOrganization.Id |
String |
|
Id to a unit where the procedure
was carried out or belongs to. |
|
Codes.Procedure.BelongsToOrganization.TypeOfId |
String |
|
Type of id for a Id ownd by a unit
where the procedure was carried out or belongs to. Example: LOC local, LIN
Local institution. |
|
Codes.Procedure.BelongsToOrganization.Shortname |
String |
|
|
|
Codes.Procedure.BelongsToOrganization.Name |
String |
|
|
|
Codes.RateCode.Code |
String |
|
Rate code. |
|
Codes.RateCode.Text |
String |
|
Description of rate code |
|
Codes.RateCode.PercentAddition |
Int |
|
Addition to the rate given in
percents. Example 50 gives 50% addition. |
|
Codes.RateCode.Multiplier |
Decimal |
|
Addition to the rate given as a
multiplier. |
|
Codes.RateCode.AmountAddition |
Int |
|
Addition to the rate given as a
fixed integer |
|
Codes.RefundCode.Code |
String |
|
Refund code |
|
Codes.RefundCode.Text |
String |
|
Description of refund code |
|
Organization.Id |
String |
|
Id for a organization where
service was done that is basis for an economy transaction. |
|
Organization.TypeOfId |
String |
|
Description of an Id for a
organization where service was done that is basis for an economy transaction. |
|
Organization.ShortNameId |
String |
|
|
|
Organization.Name |
String |
|
|
|
Organization.AdditionalIds. AdditionalId.Id |
String |
|
Additional ids for the organization
unit. |
|
Organization.AdditionalIds. AdditionalId.TypeOfId |
String |
|
Bsed on KITH code standard 8268 + some local types Some of the KITH code types
are: ENH=Off. org.no in Br.sund HER=HER-id RSH=RESH-id NPR= NPR nr LOK= Lokal id XXX=Annet Other Tieto local codes are: For HIS90: LUI=UniqueId |
|
Organization.AdditionalIds. AdditionalId.Description |
String |
|
Description of the id and type |
|
Requesters.Requester.id |
String |
|
Original requester for a service
that is basis for an economy transaction |
|
Requesters.Requester.TypeOfId |
String |
|
Type of Id for an riginal requester that has given a
service that is a basis for an economy transaction |
|
Requesters.Requester.Code |
String |
|
|
|
Requesters.Requester.Name |
String |
|
|
|
Requesters.OtherDeptor.Id |
String |
|
If requester is not the one that
pays the bill then a other deptor might do so. |
|
Requesters.OtherDeptor.TypeOfId |
String |
|
Description of other deptor. |
|
Requesters.OtherDeptor.Code |
String |
|
|
|
Requesters.OtherDeptor.Name |
String |
|
|
|
Resources.ResourceId |
String |
|
Internal Id for resources used for
economy transaction. |
|
Resources.Code |
String |
|
|
|
Resources.Name |
String |
|
|
|
Resources.Property |
String |
|
|
|
Municipality.Code |
String |
|
Code for patients municipality |
|
Municipality.text |
String |
|
Description/name of municipality |
|
FromDate |
date |
|
From date for service. HIS90:
Laboratory – sample verification date, outpatient – visit date, inpatient –
admission date |
|
ToDate |
date |
|
End
date for service. |
|
DebitDate |
date |
|
Registration
date |
|
DebitCredit |
String |
|
Type of transaction. + for debit,
- for credit. If empty then the transaction is a debit ransaction. |
|
Multiplier |
decimal |
|
Gives how of the a cost row/item
is multiplied. As a default the decimal is 1 |
|
Amount.SosialInsurance |
decimal |
|
Part NAV/Sosialincurance pays |
|
Amount.County |
decimal |
|
Part County pays |
|
Amount.PatientPay |
decimal |
|
Patient pays part of amount |
|
Amount.Equipment |
decimal |
|
Cost of equipment as part of the
amount |
|
Debtor.SosialInsurance.Code |
decimal |
|
|
|
Debtor.SosialInsurance.Text |
decimal |
|
|
|
Debtor.County.Code |
decimal |
|
|
|
Debtor.County.Text |
decimal |
|
|
|
Deptor.PatientPay.Code |
decimal |
|
|
|
Deptor.PatientPay.Text |
decimal |
|
|
|
Deptor.Equipment.Code |
decimal |
|
|
|
Deptor.Equipment.Text |
decimal |
|
|
|
PaymentMethod.Code |
String |
|
Method of payments |
|
PaymentMethod.Text |
String |
|
Description of payments method |
|
CashBox.Code |
String |
|
Cash
Box |
|
CashBox.Text |
String |
|
Description of Cash Box |
|
Visit.VisitNumber |
String |
|
Unique visit number. |
|
Registration |
|
|
Set of standard tags for identify
registration of economy transaction |
|
Update |
|
|
Set of standard tags for update of
a selected economy transaction |
|
PrinterId |
String |
|
The id in PAS for the default giro
printer for the user saving the bill. HIS90:
PrinterId is a combinded id PrinterDeptNo|PrinterCode |
|
Schema for GetEconomyTransactions: EconomyWS.xsd
Schema
documentation for GetEconomyTransactions: EconomyWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/EconomyWS/EconomyWS.asmx?op=GetEconomyTransactions
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
ListOrganizations For getting organizationinfo
ListOrganizations2G
For getting organizationinfo
GetOrganization2G For getting organizationinfo
ListCommonCodes For getting cash code and payment
methods
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 form
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.