1.1 SampleWS – Updates or Delete Samples/Requisitions

Version: 2.0

Web Service with methods to update and delete samlpes and sample comments .

All methods require a correct and verified Authentication Block from AuthenticationWS to get any information from the HIS.

The SampleWeb Service contains these methods:

UpdateSample
DeleteSample

The Web Service reference is: SampleWS.asmx

Open in a Web Browser for more detailed information about each method. The Web Service's WSDL, SOAP request and response is described.

The result of SampleWS.asmx presented in a browser:

1.1.1 UpdateSample

Method can be used in the following versions of the Web Service:

1.0

2.0

Description:

This method updates sample with information given in SampleUpdate. The method also updates sample comments if comments is given in the SampleUpdate, or deletes all sample comments if DeleteComments is true.

Method can be used with only NSL lab systems.

Syntax:

TechObject = UpdateSample(SampleUpdate)

Parameter in

Type

Length byte

Description – Data format – Valid data

SampleUpdate

Datastructure

according to

sample.xsd

scheme

N/A

Dynamic

Keeps sample update information.

See sample.xsd scheme

Required.

Definition of the data structure SampleUpdate

Name	Type	Length Byte	Description – Comments
LabId	String		Required. Laboratory identificator. Unique for the laboratory, used by Web Service to detrmine which server, database and subsystem to use. This value is confugred in ConfigManager for the Web Service to match the input in the scheme.
RequisitionNo	String		Requisition number. 8 digits, format NNNNNNNN Required.
RequisitionYear	String		Requisition year. 4 digits, format YYYY or YY Required.
CollectionDateTime	DateTime		Collection date and time Applies to standard XML datetime format Format YYYY-MM-DDThh:mm:ss.tttt+/-GMThh:GMTmm
CollectionSignature	String		Collection signature. If not given signature will be collected from the AuthenticationInfo. Maximum four characters long.
Accreditation	Boolean		Indicates whether the sample is accredited or not.
CollectionRound	String		Collection round. If collection round is given it will override collection time (in CollectionDateTime). Format hh:mm og hhmm
DeleteAllComments	Boolean		If true, all sample comments on the sample will be deleted.
Comments	Datastructure according to sample.xsd scheme	N/A Dynamic	An array with comment-objects. All sample comments on the sample will be deleted and replaced with comments in this array. If empty, no updates will be done.
- Text	String		Comment text
- AccessFlagg	String		Access flagg, valid ' ', 'E','I','S'

Schema for SampleUpdate: SampleUpdate.xsd

Schema for SampleUpdate picture:

Schema documentation for SampleUpdate: SampleUpdate.html

Sample xml file for SampleUpdate: SampleUpdate.xml

Returned parameter

Type

Length Byte

Description – Comments

TehcObject

N/A

Dynamic

Used for error handling.

ResponseHeader.ErrorInformation for warning and errors.

ResponseHeader.ErrorInformation.Code is <> 0 then error.

Else warning or information - ResponseHeader.ErrorInformation.Severity contain message level.

Web Service Response and Request:

HTTP SOAP Reqeust Envelope for UpdateSample

POST /LabLinkWS/SampleWS/SampleWS.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://healthXML.org/LabLink/UpdateSample"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Header>

<UserName>string</UserName>

<Version>string</Version>

<SysName>string</SysName>

</SystemInfo>

<ConfigSectionName>string</ConfigSectionName>

<NextKey>string</NextKey>

</RequestHeader>

</soap:Header>

<soap:Body>

<LabId>string</LabId>

<RequisitionNo>string</RequisitionNo>

<RequisitionYear>string</RequisitionYear>

<CollectionDateTime>dateTime</CollectionDateTime>

<CollectionRound>string</CollectionRound>

<CollectionSignature>string</CollectionSignature>

<Accreditation>boolean</Accreditation>

<Comment>string</Comment>

</CommentInfo>

<Comment>string</Comment>

</CommentInfo>

</Comments>

<DeleteAllComments>boolean</DeleteAllComments>

</SampleUpdate>

</UpdateSample>

</soap:Body>

</soap:Envelope>

HTTP SOAP Response Envelope for UpdateSample

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE sample.xsd SCHEME FOR FULL DETAILS

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Header>

<FunctionName>string</FunctionName>

<Severity>None or Critical or Warning or Information</Severity>

<ErrorType>string</ErrorType>

<ModuleName>string</ModuleName>

<Description>string</Description>

</ErrorInformation>

<DeptCode>string</DeptCode>

<SectionCode>string</SectionCode>

<UnitCode>string</UnitCode>

<ProfileName>string</ProfileName>

</ProfileInfo>

<Version>string</Version>

<SysName>string</SysName>

</SystemInformation>

<NextKey>string</NextKey>

</ResponseHeader>

</soap:Header>

<soap:Body>

</UpdateSampleResponse>

</soap:Body>

</soap:Envelope>

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.

1.1.2 DeleteSample

Method can be used in the following versions of the Web Service:

1.0

2.0

Description:

The method deletes a sample.

Method can be used with only NSL lab systems.

Syntax:

TechObject = DeleteSample(SampleDelete)

Parameter in

Type

Length byte

Description – Data format – Valid data

SampleDelete

Datastructure

according to sample.xsd

scheme

N/A

Dynamic

Inparameter is SampleDelete.

Definition of the data structure SampleDelete.

Name	Type	Length Byte	Description – Comments
LabId	String		Required. Laboratory identificator. Unique for the laboratory, used by Web Service to detrmine which server, database and subsystem to use. This value is confugred in ConfigManager for the Web Service to match the input in the scheme.
RequisitionNo	String		Requisition number. 8 digits NNNNNNNN Required.
RequisitionYear	String		Requisition year. 4 digits, format YYYY or YY Required.

Schema for SampleDelete: SampleUpdate.xsd

Schema for SampleDelete picture:

Schema documentation for SampleDelete: SampleUpdate.html

Sample xml file for SampleDelete: SampleDelete.xml

Returned parameter

Type

Length Byte

Description – Comments

TehcObject

N/A

Dynamic

Used for error handling.

ResponseHeader.ErrorInformation for warning and errors.

ResponseHeader.ErrorInformation.Code is <> 0 then error.

Else warning or information - ResponseHeader.ErrorInformation.Severity contain message level.

Web Service Response and Request:

HTTP SOAP Reqeust Envelope for DeleteSample

POST /LabLinkWS/SampleWS/SampleWS.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://healthXML.org/LabLink/DeleteSample"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Header>

<UserName>string</UserName>

<Version>string</Version>

<SysName>string</SysName>

</SystemInfo>

<ConfigSectionName>string</ConfigSectionName>

<NextKey>string</NextKey>

</RequestHeader>

</soap:Header>

<soap:Body>

<LabId>string</LabId>

<RequisitionNo>string</RequisitionNo>

<RequisitionYear>string</RequisitionYear>

</SampleDelete>

</DeleteSample>

</soap:Body>

</soap:Envelope>

HTTP SOAP Response Envelope for DeleteSample

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE sample.xsd SCHEME FOR FULL DETAILS

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Header>

<FunctionName>string</FunctionName>

<Severity>None or Critical or Warning or Information</Severity>

<ErrorType>string</ErrorType>

<ModuleName>string</ModuleName>

<Description>string</Description>

</ErrorInformation>

<DeptCode>string</DeptCode>

<SectionCode>string</SectionCode>

<UnitCode>string</UnitCode>

<ProfileName>string</ProfileName>

</ProfileInfo>

<Version>string</Version>

<SysName>string</SysName>

</SystemInformation>

<NextKey>string</NextKey>

</ResponseHeader>

</soap:Header>

<soap:Body>

</DeleteSampleResponse>

</soap:Body>

</soap:Envelope>

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.