1.1   RequesterWS – List Requesters

Version: 2.0

 

Web Service with methods to list requesters in the NSL and NSML database.

 

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

 

The Requester Web Service contains these methods:

 

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

 

 

 

1.1.1   ListRequester

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

2.0

 

 

 

 

 

 

 

Description:

The method list requesters available in the provider(NSL or NSML system). All requesters are listed, also requesters expired on date.

 

Method can be used with NSL and NSML lab systems.

 

Syntax:

Requesters = ListRequesters(LabId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

LabId

Char

N/A

Dynamic

Unique id for the provider/laboratory. Used to identify database and subsystem in WS configuration (ConfigServer).

 

 

Return Requesters from ListRequestersLabSystem is an array with requester.

Details of the data structure Requester:

Returned parameter

Name/Tag

Type

Length

Byte

Description – Comments – Data format – Valid data

Id

String

N/A

Dynamic

Local id (Requester code) for the requester in the provider system.

OfficialId

String

N/A

Dynamic

Official id for requester, HER-id.

InstituitionCode

String

N/A

Dynamic

Institution/Hospital/PAS-system code. Unique code for each PAS system or hospital. E.g. StOlav Trondheim uses TR, Molde uses MO

Name

String

N/A

Dynamic

Requester’s name

ValidFromDate

Date Time

N/A

Dynamic

Date requester is valid from.

Format CCYY-MM-DDThh:mm:ss

ValidToDate

Date Time

N/A

Dynamic

Date requester is valid to.

Format CCYY-MM-DDThh:mm:ss

Schema for Requester.xsd: requester.xsd

Schema documentation for Requester.xsd: Requesters.html

Sample xml file for Requester.xsd: requesters.xml

Schema for Requester.xsd picture:

requesters.png

 

 

Web Service Response and Request:

HTTP SOAP Reqeust Envelope for ListRequester

POST /LabLinkWS/RequesterWS/RequesterWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/LabLink/ListRequester"
 
<?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>
    <RequestHeader xmlns="http://healthXML.org/LabLink">
      <AuthenticationInfo>xml</AuthenticationInfo>
      <UserName>string</UserName>
      <SystemInfo>
        <Version>string</Version>
        <SysName>string</SysName>
      </SystemInfo>
      <ConfigSectionName>string</ConfigSectionName>
      <NextKey>string</NextKey>
    </RequestHeader>
  </soap:Header>
  <soap:Body>
    <ListRequester xmlns="http://healthXML.org/LabLink">
      <LabId>string</LabId>
    </ListRequester>
  </soap:Body>
</soap:Envelope>

HTTP SOAP Response Envelope for ListRequester

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>
    <ResponseHeader xmlns="http://healthXML.org/LabLink">
      <AuthenticationInfo>xml</AuthenticationInfo>
      <ErrorInformation>
        <FunctionName>string</FunctionName>
        <Severity>None or Critical or Warning or Information</Severity>
        <ErrorType>string</ErrorType>
        <ModuleName>string</ModuleName>
        <Description>string</Description>
        <Code>long</Code>
      </ErrorInformation>
      <ProfileInfo>
        <DeptCode>string</DeptCode>
        <SectionCode>string</SectionCode>
        <UnitCode>string</UnitCode>
        <ProfileName>string</ProfileName>
      </ProfileInfo>
      <SystemInformation>
        <Version>string</Version>
        <SysName>string</SysName>
      </SystemInformation>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <ListRequesterResponse xmlns="http://healthXML.org/LabLink">
      <Requesters>
        <Requester>
          <Id>string</Id>
          <OfficialId>string</OfficialId>
          <InstitutionCode>string</InstitutionCode>
          <Name>string</Name>
          <ValidFromDate>dateTime</ValidFromDate>
          <ValidToDate>dateTime</ValidToDate>
        </Requester>
        <Requester>
          <Id>string</Id>
          <OfficialId>string</OfficialId>
          <InstitutionCode>string</InstitutionCode>
          <Name>string</Name>
          <ValidFromDate>dateTime</ValidFromDate>
          <ValidToDate>dateTime</ValidToDate>
        </Requester>
      </Requesters>
    </ListRequesterResponse>
  </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.

 

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   ListRequesterLabSystem

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

2.0

 

 

 

 

 

 

 

Description:

The method list requesters available in the provider(NSL or NSML system). All requesters are listed, also requesters expired on date. LabSystem to use can be specified as in parameter.

 

Method can be used with NSL and NSML lab systems.

 

Syntax:

Requesters = ListRequestersLabSystem(LabId, LabSystem)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

LabId

Char

N/A

Dynamic

Unique id for the provider/laboratory. Used to identify database and subsystem in WS configuration (ConfigServer).

LabSystem

Char

N/A

Dynamic

Lab system to access. CLIN or MBIO. If blank the uses internal logic for choosing lab systems, based on subsystem names.

 

 

Return Requesters from ListRequestersLabSystem is an array with requester.

Details of the data structure Requester:

Returned parameter

Name/Tag

Type

Length

Byte

Description – Comments – Data format – Valid data

Id

String

N/A

Dynamic

Local id (Requester code) for the requester in the provider system.

OfficialId

String

N/A

Dynamic

Official id for requester, HER-id.

InstituitionCode

String

N/A

Dynamic

Institution/Hospital/PAS-system code. Unique code for each PAS system or hospital. E.g. StOlav Trondheim uses TR, Molde uses MO

Name

String

N/A

Dynamic

Requester’s name

ValidFromDate

Date Time

N/A

Dynamic

Date requester is valid from.

Format CCYY-MM-DDThh:mm:ss

ValidToDate

Date Time

N/A

Dynamic

Date requester is valid to.

Format CCYY-MM-DDThh:mm:ss

Schema for Requester.xsd: requester.xsd

Schema documentation for Requester.xsd: Requesters.html

Sample xml file for Requester.xsd: requesters.xml

Schema for Requester.xsd picture:

requesters.png

 

 

Web Service Response and Request:

HTTP SOAP Reqeust Envelope for ListRequester

POST /LabLinkWS/RequesterWS/RequesterWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/LabLink/ListRequesterLabSystem"
 
<?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>
    <RequestHeader xmlns="http://healthXML.org/LabLink">
      <AuthenticationInfo>xml</AuthenticationInfo>
      <UserName>string</UserName>
      <SystemInfo>
        <Version>string</Version>
        <SysName>string</SysName>
      </SystemInfo>
      <ConfigSectionName>string</ConfigSectionName>
      <NextKey>string</NextKey>
    </RequestHeader>
  </soap:Header>
  <soap:Body>
    <ListRequesterLabSystem xmlns="http://healthXML.org/LabLink">
      <LabId>string</LabId>
      <LabSystem>string</LabSystem>
    </ListRequesterLabSystem>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for ListRequester

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>
    <ResponseHeader xmlns="http://healthXML.org/LabLink">
      <AuthenticationInfo>xml</AuthenticationInfo>
      <ErrorInformation>
        <FunctionName>string</FunctionName>
        <Severity>None or Critical or Warning or Information</Severity>
        <ErrorType>string</ErrorType>
        <ModuleName>string</ModuleName>
        <Description>string</Description>
        <Code>long</Code>
      </ErrorInformation>
      <ProfileInfo>
        <DeptCode>string</DeptCode>
        <SectionCode>string</SectionCode>
        <UnitCode>string</UnitCode>
        <ProfileName>string</ProfileName>
      </ProfileInfo>
      <SystemInformation>
        <Version>string</Version>
        <SysName>string</SysName>
      </SystemInformation>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <ListRequesterLabSystemResponse xmlns="http://healthXML.org/LabLink">
      <Requesters>
        <Requester>
          <Id>string</Id>
          <OfficialId>string</OfficialId>
          <InstitutionCode>string</InstitutionCode>
          <Name>string</Name>
          <ValidFromDate>dateTime</ValidFromDate>
          <ValidToDate>dateTime</ValidToDate>
        </Requester>
        <Requester>
          <Id>string</Id>
          <OfficialId>string</OfficialId>
          <InstitutionCode>string</InstitutionCode>
          <Name>string</Name>
          <ValidFromDate>dateTime</ValidFromDate>
          <ValidToDate>dateTime</ValidToDate>
        </Requester>
      </Requesters>
    </ListRequesterLabSystemResponse>
  </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.

 

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.