1.1 InvestigationWS – List or Get Investigations

Version: 2.0

Web Service with methods to get an investigation, listing investigations and investigation groups.

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

InvestigationWS is only available for the NSL Laboratory system.

The InvestigationWeb Service contains these methods:

ListInvestigations
GetInvestigation
ListInvestigationGroups

The Web Service reference is: InvestigationWS.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 InvestigationWS.asmx presented in a browser:

1.1.1 ListInvestigations

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

1.0

2.0

Description:

The method returns all investigations for a given laboratory.

Method can be used with only NSL lab systems.

Syntax:

InvestigationCollection= ListInvestigation(LabId)

Parameter in

Type

Length byte

Description – Data format – Valid data

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 confugres in ConfigManager for the Web Service to match the input in the scheme.

Returned parameter

Type

Length Byte

Description – Comments

InvestigationCollection

Datastructure

according to

investigation.xsd

scheme

N/A

Dynamic

An array with a collection of Investigation.

The return data is a collection of all investigations for a given laboratory.

The data structure is dynamic and can return from 0 to undetermined number of records with Investigation.

Definition of the data structure InvestigationCollection for getting information from ListInvestigation

Name

Type

Length Byte

Description – Comments

InvestigationCollection

Collection of Investigation type

Investigation * xxx

Investigation ; the structure below is repeated xxx times.

where xxx is valid from 0 to endless/undetermined

See investigation.xsd scheme

See Definition of the data structure Investigation under GetInvestigation.

Schema for InvestigationCollection: Investigation.xsd

Schema for SampleUpdate picture:

Schema documentation for InvestigationCollection: Investigation.html

Sample xml file for InvestigationCollection: InvestigationCollection.xml

Web Service Response and Request:

HTTP SOAP Reqeust Envelope for ListInvestigation

POST /LabLinkWS/InvestigationWS/InvestigationWS.asmx HTTP/1.1

Host: localhost

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

Content-Length: length

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

<?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>

</ListInvestigations>

</soap:Body>

HTTP SOAP Response Envelope for ListInvestigation

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE investigation.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>

</ResponseHeader>

</soap:Header>

<soap:Body>

<Code>string</Code>

<Name>string</Name>

<ShortName>string</ShortName>

<PreName>string</PreName>

<ExpiresDate>dateTime</ExpiresDate>

<ProviderId>string</ProviderId>

<HCDInvestigationCode>string</HCDInvestigationCode>

<AvailableForRequester>boolean</AvailableForRequester>

<FormVisible>boolean</FormVisible>

<Comment>string</Comment>

<CommentToLabel>string</CommentToLabel>

<RequireUrinCollectionTime>boolean</RequireUrinCollectionTime>

<RequirePasLengthAndWeigth>boolean</RequirePasLengthAndWeigth>

<RequireDiagnostic>boolean</RequireDiagnostic>

<MsgToRequester>string</MsgToRequester>

<AltAnswerText>string</AltAnswerText>

<AnswerType>string</AnswerType>

</Investigation>

<Code>string</Code>

<Name>string</Name>

<ShortName>string</ShortName>

<PreName>string</PreName>

<ExpiresDate>dateTime</ExpiresDate>

<ProviderId>string</ProviderId>

<HCDInvestigationCode>string</HCDInvestigationCode>

<AvailableForRequester>boolean</AvailableForRequester>

<FormVisible>boolean</FormVisible>

<Comment>string</Comment>

<CommentToLabel>string</CommentToLabel>

<RequireUrinCollectionTime>boolean</RequireUrinCollectionTime>

<RequirePasLengthAndWeigth>boolean</RequirePasLengthAndWeigth>

<RequireDiagnostic>boolean</RequireDiagnostic>

<MsgToRequester>string</MsgToRequester>

<AltAnswerText>string</AltAnswerText>

<AnswerType>string</AnswerType>

</Investigation>

</ListInvestigationResult>

</ListInvestigationResponse>

</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 GetInvestigation

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

1.0

2.0

Description:

The method returns details about an investigation.

Method can be used with only NSL lab systems.

Syntax:

Investigation = GetInvestigation(InvestigationSearch)

Parameter in

Type

Length byte

Description – Data format – Valid data

InvestigationSearch

Datastructure

according to

investigation.xsd

scheme

N/A

Dynamic

Inparameter is InvestigationSearch.

Definition of the data structure InvestigationSearch for getting information from GetInvestigation

Name

Type

Length Byte

Description – Comments

InvestigationCode

String

Required.

Investigation code.

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 confugres in ConfigManager for the Web Service to match the input in the scheme.

Schema for InvestigationSearch: Investigation.xsd

Schema for SampleUpdate picture:

Schema documentation for InvestigationSearch: Investigation.html

Sample xml file for InvestigationSearch: InvestigationSearch.xml

Returned parameter

Type

Length Byte

Description – Comments

Investigation

Datastructure

according to

investigation.xsd

scheme

N/A

Dynamic

Definition of the data structure Investigation for getting information from GetInvestigation

Name	Type	Length Byte	Description – Comments
Code	String		Investigation short code
ProviderId	String		Provider id
Name	String		Investigation name.
ShortName	String		Investigation short name.
PreName	String		Investigation pre name.
ValidationDateTime	DateTime		Validation data and time for the invstigation
ExpiresDateTime	DateTime		Expiration date and time for the invetigation
HCDInvestigationCode	String		Type of code library LO = Local codes EU = NKKKL code
RDU	Int		The maximum legal degree of urgency 7 = immediate help 5 = answer today 4 = ordinary
InvestigationGroupId	Int		Investigation group in RoS requisition. 0-999 Default = 0 (no group)
PositionOnForm	Int		The position of the investigation, within the investigation group in the request form. 0-999 Default 0 (no fixed place).
Position	Int		The position in the accumulated list (Akkumulertliste). 0-999 Default 0 (no fixed place).
AvailableForRequester	Bool		Indicates if available for the requester in the requisition or just in "answer investigation".
FormVisible	Bool		Indicates whether the investigation is visible in the request form or only by search in the investigation list.
Comment	String		Comment to the requester given under a requisition.
CommentToLabel	String		Comment to the label.
RequireComments	Bool		Indicates whether the investigation requires investigation comments from the requester or not.
RequireUrinCollectionTime	Bool		Indicates whether the investigation requires urin collection and time or not.
RequirePasLengthAndWeigth	Bool		Indicates whether the investigation requires pasient length and weigth or not.
RequireDiagnostic	Bool		Indicates whether the investigation requires diagnostic or not.
MsgToRequester	String		Dialog heading when requester has to give supplementary information
MsgType	Int		Indicates the type of message. 1: Yes/No answer 2: Information, text information registered as investigation comment. 3: Input, text information derived from the text in the "Ledetekst-feltet".
AltAnswerText	String		Returns the label to the dialog, indicates the type of input the dialog requires.
AnswerType	Int		Answer type, values empty, 1, 2 or 3.

Schema for Investigation: Investigation.xsd

Schema for SampleUpdate picture: Investigation.png

Schema documentation for Investigation: : Investigation.html

Sample xml file for Investigation: InvestigationCollection.xml

Web Service Response and Request:

HTTP SOAP Reqeust Envelope for GetInvestigation

POST /LabLinkWS/InvestigationWS/InvestigationWS.asmx HTTP/1.1

Host: localhost

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

Content-Length: length

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

<?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>

</RequestHeader>

</soap:Header>

<soap:Body>

<InvestigationCode>string</InvestigationCode>

<ProviderId>string</ProviderId>

</InvestigationSearch>

</GetInvestigation>

</soap:Body>

</soap:Envelope>

HTTP SOAP Response Envelope for GetInvestigation

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE investigation.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>

</ResponseHeader>

</soap:Header>

<soap:Body>

<Code>string</Code>

<Name>string</Name>

<ShortName>string</ShortName>

<PreName>string</PreName>

<ExpiresDate>dateTime</ExpiresDate>

<ProviderId>string</ProviderId>

<HCDInvestigationCode>string</HCDInvestigationCode>

<AvailableForRequester>boolean</AvailableForRequester>

<FormVisible>boolean</FormVisible>

<Comment>string</Comment>

<CommentToLabel>string</CommentToLabel>

<RequireUrinCollectionTime>boolean</RequireUrinCollectionTime>

<RequirePasLengthAndWeigth>boolean</RequirePasLengthAndWeigth>

<RequireDiagnostic>boolean</RequireDiagnostic>

<MsgToRequester>string</MsgToRequester>

<AltAnswerText>string</AltAnswerText>

<AnswerType>string</AnswerType>

</Investigation>

</GetInvestigationResponse>

</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.

1.1.3 ListInvestigationGroups

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

1.0

2.0

Description:

The method returns a list of all investigation groups for a laboratory.

Method can be used with only NSL lab systems.

Syntax:

InvestigationGroupCollection = ListInvestigationGroups(LabId)

Parameter in

Type

Length byte

Description – Data format – Valid data

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 confugres in ConfigManager for the Web Service to match the input in the scheme.

Returned parameter

Type

Length Byte

Description – Comments

InvestigationGroupCollection

Datastructure

according to

investigationgroup.xsd

scheme

N/A

Dynamic

An array with a collection of InvestigationGroup.

The return data is a collection of all investigation groups for a given laboratory.

The data structure is dynamic and can return from 0 to undetermined number of records with InvestigationGroup.

Definition of the data structure InvestigationGroupCollection for getting information from ListInvestigationGroups

Name	Type	Length Byte	Description – Comments
InvestigationGroupCollection			Collection of InvestigationGroup type
InvestigationGroup * xxx	InvestigationGroup; the structure below is repeated xxx times. where xxx is valid from 0 to endless/undetermined See InvestigationGroup.xsd scheme
InvestigationGroup			An investigation group
- Code	String		Internal code for investigation group in the system.
- Name	String	N/A Dynamic	Name of investigation group.
- Type	String		Type of investigation group.
- Order	Int		Investigation group sequence/order

Schema for InvestigationGroupCollection: InvestigationGroup.xsd

Schema for SampleUpdate picture:

Schema documentation for InvestigationGroupCollection: InvestigationGroup.html

Sample xml file for InvestigationGroupCollection: InvestigationGroupCollection.xml

Web Service Response and Request:

HTTP SOAP Reqeust Envelope for ListInvestigationGroups

POST /LabLinkWS/InvestigationWS/InvestigationWS.asmx HTTP/1.1

Host: localhost

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

Content-Length: length

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

<?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>

</RequestHeader>

</soap:Header>

<soap:Body>

<ProviderId>string</ProviderId>

</ListInvestigationGroups>

</soap:Body>

</soap:Envelope>

HTTP SOAP Response Envelope for ListInvestigationGroups

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE investigationGroups.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>

</ResponseHeader>

</soap:Header>

<soap:Body>

<Code>short</Code>

<Name>string</Name>

<Type>string</Type>

<Order>short</Order>

</InvestigationGroup>

<Code>short</Code>

<Name>string</Name>

<Type>string</Type>

<Order>short</Order>

</InvestigationGroup>

</ListInvestigationGroupsResult>

</ListInvestigationGroupsResponse>

</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.