1.1   LinkItemsWS – LinkItems

Version: 2.1.14296

 

Web Service with methods to get and list LinkItemns.

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

 

The OrganizationWS Web Service contains these methods:

 

The Web Service reference is: LinkItemsWS.asmx

 

For more detailed information as the web service WSDL, SOAP request and response see:

https://linkws.service.tieto.com/PasLinkWS/LinkItemsWS/LinkItemsWS.asmx

1.1.1   ListLinkItems

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.0

 

 

 

 

 

 

 

Description:

Lists LinkItems. LinkItem is a named item, with a link to an element in a XML returned from an WebService method.

Syntax:

LinkItem = ListLinkItems(ItemType, ValidDate)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ItemType

String

N/A

Dynamic

Kind of item type

Patient / Contact / Diagnosis /

ValidDate

DateTime

N/A

Dynamic

Date when LinkItem  must be valid

 

Returned parameter

Type

Length Byte

Description – Comments

LinkItem

class

N/A

Dynamic

LinkItem class according to schema LinkItem.xsd

 

Schema for LinkItem LinkItem.xsd

Schema documentation for LinkItem: LinkItem.html

Sample xml file for LinkItem: LinkItem.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Reqeust Envelope for ListLinkItems

 

POST /PasLinkMsSV/LinkItemsWS/LinkItemsWS.asmx HTTP/1.1
Host: alfa1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/ListLinkItems"
 
<?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/PasLink">
      <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>
    <ListLinkItems xmlns="http://healthXML.org/PasLink">
      <ItemType>string</ItemType>
      <ValidDate>dateTime</ValidDate>
    </ListLinkItems>
  </soap:Body>
</soap:Envelope>
 

 

HTTP SOAP Response Envelope for ListLinkItems

 

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/PasLink">
      <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>
    <ListLinkItemsResponse xmlns="http://healthXML.org/PasLink">
      <LinkItem>
        <Type TypeName="string">
          <Items>
            <Item xsi:nil="true" />
            <Item xsi:nil="true" />
          </Items>
        </Type>
        <Type TypeName="string">
          <Items>
            <Item xsi:nil="true" />
            <Item xsi:nil="true" />
          </Items>
        </Type>
      </LinkItem>
    </ListLinkItemsResponse>
  </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   GetLinkItem

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.0

 

 

 

 

 

 

 

Description:

Gets a LinkItem. LinkItem is a named item, with a link to an element in a XML returned from an WebService method.

 

Syntax:

LinkItem = GetLinkItem(ItemId, ValidDate)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ItemId

String

N/A

Dynamic

Item id (name)

ValidDate

DateTime

N/A

Dynamic

Date when LinkItem  must be valid

 

Returned parameter

Type

Length Byte

Description – Comments

LinkItem

class

N/A

Dynamic

LinkItem class according to schema LinkItem.xsd

 

Schema for LinkItem LinkItem.xsd

Schema documentation for LinkItem: LinkItem.html

Sample xml file for LinkItem: LinkItem.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Reqeust Envelope for GetLinkItem

 

POST /PasLinkMsSV/LinkItemsWS/LinkItemsWS.asmx HTTP/1.1
Host: alfa1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/GetLinkItem"
 
<?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/PasLink">
      <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>
    <GetLinkItem xmlns="http://healthXML.org/PasLink">
      <ItemId>string</ItemId>
      <ValidDate>dateTime</ValidDate>
    </GetLinkItem>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for GetLinkItem

 

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/PasLink">
      <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>
    <GetLinkItemResponse xmlns="http://healthXML.org/PasLink">
      <LinkItem>
        <Type TypeName="string">
          <Items>
            <Item xsi:nil="true" />
            <Item xsi:nil="true" />
          </Items>
        </Type>
        <Type TypeName="string">
          <Items>
            <Item xsi:nil="true" />
            <Item xsi:nil="true" />
          </Items>
        </Type>
      </LinkItem>
    </GetLinkItemResponse>
  </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.