1.1   ReportWS – Get Reports from LIS

Version: 2.3.14267

Web Service with methods to get reports from a queue in LIS, and to list and matain report statustes in  the LIS.

 

 

The RequisitionWeb Service contains these methods:

 

 

The Web Service reference is: ReportWS.asmx

 

For more detailed information as the Web Service's WSDL, SOAP request and response see:

https://linkws.service.tieto.com/LabLinkWS/ReportWS/ReportWS.asmx

 

1.1.1   GetNextReport

Applicable LIS for the method:

NSL

NSML

Sympathy

FlexLab

Chemistry

FlexLab Micro

 

 

 

Method can be used in the following LIS:

NSL

NSML

Sympathy

 

 

 

 

 

Description:

NB! The GetNextReport method is only partially available for developers outside Tieto. All use of GetNextReport must be checked with Tieto and the customer before used. The reason for this is that there are central services responsible for getting the reports and distributing them to the receivers. So if you application should need Lab reports it should be added to the services distribution list instead of directly using GetNextReport. Parallel use of GetNextReport can result in loss of lab reports.

 

The method gets the next report available in the LIS based on ServiceProviderId. The reportformat can be decided by a choice of DocumentType in the input.

 

If more report are available this will be shown in the response, and the methods should be called until no more reports exists.

 

Method can be used with NSL and NSML lab systems.

 

Syntax:

GetNextReportResponse = GetNextReport(GetNextReportRequest)

 

Parameter in GetNextReportRequest

Type

Length byte

Description – Data format – Valid data

GetNextReportRequest

Structure

according to

ReportWS.xsd

schema

N/A

Dynamic

Structure containing input parameters.

  .ServiceProviderId

String

 

Unique id for the serviceprovider in the document, same as LabId. Used for routing document to correct database.

This id is used by Lablink to connect to the correct LIS system/database.

For example this wil be the agreed service provider id in Tietos RoS if the LabLink is used with RoS.

HIS90 NSL/NSML: Examples are TR_NSL, MO_SYMPATHY

  .DocumentType

String

 

Type of content format wanted for the returned document.

Valid values are:

KITH1.1

KITH1.3

Future expansion can be:

HL7

  .MessageGUID

String

 

GUID from sender ensuring a result/report can be reproduced. Idempotence identification, to reproduce an earlier report (not implemented).

Only used/supported if LAB system can use it

HIS90 NSL/NSML: Not used

 

 

 

 

 

Returned parameter

Type

Length Byte

Description – Comments

GetNextReportResponse

Structure

according to

ReportWS.xsd

schema

N/A

dynamic

Structure containing the report.

 .ItemsInQueue

Integer

2

Number of more reports in queue.

Can also be an indication whether more reports exist

HIS90 NSL/NSML: Number indicating whether more data is present. ‘1’ = more data exists, ‘0’ = no more data exists.

.Report.LabDocumentId

String

n/a dynamic

Unique id for  LAB and report/request. Must be used for saving report state later.

Can be a combined id from  the LIS.

HIS90 NSL/NSML: Is combined of serviceprovider/labid, sub system, sample year and number.

 .Report.Document

AnyType

XML

n/a dynamic

XML message in KITH format containing the report, or null if no report exists.

HIS90 NSL/NSML: Only KITH v1.1 and KITH 1.3 format is supported.

.Report.MessageGUID

String

n/a dynamic

GUID ensuring a result/report can be reproduced. Idempotence identification, to reproduce an earlier report (not implemented).

Only used/supported if LAB system can use it

HIS90 NSL/NSML: Not used

 

 

Schema for GetNextReport: ReportWS.xsd

Schema documentation for GetNextReport: ReportWS.html

 

 

Web Service Response and Request:

See https://linkws.service.tieto.com/LabLinkWS/ReportWS/ReportWS.asmx?op=GetNextReport

 

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.

 

The return from the method will always have a ResponseHeader, containing Error and System Information. Error Information block must always be checked to determine if any error, warning or information has occurred while processing the methods.

1.1.2   ListReportStatuses

Applicable LIS for the method:

NSL

NSML

 

 

 

 

 

 

Description:

The method saves a requisition based on the ServiceRequestNSL.xsd scheme as input to the database. The method can not update an existing requisition, only add new requisitions.

 

This method can automatically acquire a NSL requisition number and year for requisition if configured in ConfigManager.

 

Method can be used with only NSL lab systems.

 

Syntax:

ListReportStatusesResponse = ListReportStatuses(ListReportStatusesRequest)

 

Parameter in ListReportStatusesRequest

Type

Length byte

Description – Data format – Valid data

ListReportStatusesRequest

Structure

according to

ReportWS.xsd

schema

N/A

Dynamic

Structure containing input parameters.

 .ServiceProviderId

String

N/A

Dynamic

Id for serviceprovider in the document, same as LabId. Used for routing document to correct database.

E.g. TR_NSL, MO_SYMPATHY

 .FromDate

DateTime

N/A

Dynamic

From date to list/filter reports on

 .ToDate

DateTime

N/A

Dynamic

To date to list/filter reports on

.Status

Enum

N/A

Dynamic

Staus to list/filter reports on.

Valid values are:

-       NotSet

-       Ok

-       Resend

-       ReadyForSend

-       Processing

.Receiver.Id

String

N/A

Dynamic

Receiver/requestr for list/filter reports on.

.Receiver.TypeOfId

String

N/A

Dynamic

Type id id give in id above.

Valid values are:

LRC=Local Requester code

Empty/LOC = Unkown lLocal id in PAS

.Receiver.Code

String

N/A

Dynamic

HIS90 NSL/NSML: Not used

.Receiver.Name

String

N/A

Dynamic

HIS90 NSL/NSML: Not used

 

Returned parameter

Type

Length Byte

Description – Comments

ListReportStatusesResponse

Structure

according to

ReportWS.xsd

schema

N/A

dynamic

Structure containing the report.

ReportStatuses

Structure

 

 

ReportStatus

List/Array

 

List/array of reports

.ReportStatuses

String

n/a dynamic

Unique id for  LAB and report/request.

Can be a combined id.

.ReportingDate

String

n/a dynamic

Report date/time when report was sent, or if provider does not av sent date then last date/time when report was updated.

.Status

AnyType

XML

n/a dynamic

Status for the reports

Valid values are:

-       NotSet

-       Ok

-       Resend

-       ReadyForSend

-       Processing

.Message

String

n/a dynamic

Status message from report receiver with warning or error text regarding delivery of the report.

.Receivers.Id

String

N/A

Dynamic

Receiver/requester id

.Receivers.TypeOfId

String

N/A

Dynamic

Type id id give in id above.

Set to LRC=Local Requester code by the WS

.Receivers.Code

String

N/A

Dynamic

Receiver/requester code

.Receivers.Name

String

N/A

Dynamic

Receiver/requester name

.Receivers.ReceiverType

String

N/A

Dynamic

Receiver/requester type

P = Primary Receiver/requester

C = Copy Receiver/requester

.LabType

String

N/A

Dynamic

Lab type. E.g. CLIN, MBIO .....

.ReportYear

String

N/A

Dynamic

Report year, normmaly year for request

.ReportNumber

String

N/A

Dynamic

Report number, normmaly number given for request or at request time.

.ProviderSystem

String

N/A

Dynamic

E.g. SubSystem in NSL/NSML

.ExternalId

String

N/A

Dynamic

External id from requester. e.g. ActivityGUID in RoS

.ExternalLID

String

N/A

Dynamic

External LID from requester. e.g. Sampleyear/No from RoS

 

 

Schema for ListReportStatuses: ReportWS.xsd

Schema documentation for ListReportStatuses: ReportWS.html

 

Web Service Response and Request:

See https://linkws.service.tieto.com/LabLinkWS/ReportWS/ReportWS.asmx?op=ListReportStatuses

 

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.

 

The return from the method will always have a ResponseHeader, containing Error and System Information. Error Information block must always be checked to determine if any error, warning or information has occurred while processing the methods.

 

1.1.3   SaveReportStatus

Applicable LIS for the method:

NSL

NSML

FlexLab

Chemistry

FlexLab Micro

 

 

 

Description:

Methods is used to set or reset the status on a given report.

A LabDocumentId is required as input to the method, this can be found with ListReportStatuses or GetNextReport.

The LabDocumentId contains enough information so the method can find the correct LIS, database and report to update status on.

 

Syntax:

SaveReportStatusResponse = SaveReportStatus(SaveReportStatusRequest)

 

Parameter in SaveReportStatusRequest

Type

Length byte

Description – Data format – Valid data

SaveReportStatusRequest

Structure

according to

ReportWS.xsd

schema

N/A

Dynamic

Structure containing input parameters.

  .LabDocumentId

String

 

Unique id for  LAB and report/request.

Can be a combined id.

  .Status

String

 

Status to set for the report

Valid values are:

-       NotSet

-       Ok

-       Resend

-       ReadyForSend

-       Processing

  .Message

String

 

Message from reciever to be saved in LAB/LIS

HIS90 NSL/NSML: Not save to LIS, only logged on LabLinkWS logs for HIS90 LIS

  .DocumentSent

AnyType

 

The document/report that is sent and status should be updated for.

This document is provided by GetNextReportResponse.Report.Document tag if needed.

Not all LIS has implemented support for receiving the report in this tag.

 

 

 

 

 

Returned parameter

Type

Length Byte

Description – Comments

SaveReportStatusResponse

Structure

according to

ReportWS.xsd

schema

N/A

dynamic

Structure containing the report.

 

 

Schema for SaveReportStatus: ReportWS.xsd

Schema documentation for SaveReportStatus: ReportWS.html

 

Web Service Response and Request:

See https://linkws.service.tieto.com/LabLinkWS/ReportWS/ReportWS.asmx?op=SaveReportStatus

 

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.

 

The return from the method will always have a ResponseHeader, containing Error and System Information. Error Information block must always be checked to determine if any error, warning or information has occurred while processing the methods.