PatientWS Web Service

PatientWS

Click here for a complete list of operations.

GetPatientOverview

Get patient overview (chronology data) specified by filters and search criteria.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /PasLinkWS/PatientWS/PatientWS.asmx HTTP/1.1
Host: linkws.service.tieto.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/GetPatientOverview"

<?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>
    <GetPatientOverview xmlns="http://healthXML.org/PasLink">
      <patientOverviewRequest>
        <Period>
          <ValidFrom>date</ValidFrom>
          <ValidTo>date</ValidTo>
        </Period>
        <Filters>
          <Filter>
            <Name>string</Name>
            <Value>string</Value>
          </Filter>
          <Filter>
            <Name>string</Name>
            <Value>string</Value>
          </Filter>
        </Filters>
        <PatientId>int</PatientId>
        <OfficialPatientId>string</OfficialPatientId>
        <OfficialPatientIdType>string</OfficialPatientIdType>
        <BirthYear>int</BirthYear>
      </patientOverviewRequest>
    </GetPatientOverview>
  </soap:Body>
</soap:Envelope>

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>
        <SubCode>long</SubCode>
        <RecoverableError>boolean</RecoverableError>
        <SubModuleName>string</SubModuleName>
      </ErrorInformation>
      <ProfileInfo>
        <DeptCode>string</DeptCode>
        <SectionCode>string</SectionCode>
        <UnitCode>string</UnitCode>
        <ProfileName>string</ProfileName>
      </ProfileInfo>
      <SystemInformation>
        <DatabaseInformation>string</DatabaseInformation>
        <DatabaseServer>string</DatabaseServer>
        <DatabaseName>string</DatabaseName>
      </SystemInformation>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <GetPatientOverviewResponse xmlns="http://healthXML.org/PasLink">
      <PatientOverview>
        <ModuleName>string</ModuleName>
        <Generated>dateTime</Generated>
        <Overviews>
          <Overview>
            <Keys xsi:nil="true" />
            <Dates xsi:nil="true" />
            <Type>string</Type>
            <DataType>string</DataType>
            <Header>string</Header>
            <Data>string</Data>
            <Script>string</Script>
            <Types xsi:nil="true" />
          </Overview>
          <Overview>
            <Keys xsi:nil="true" />
            <Dates xsi:nil="true" />
            <Type>string</Type>
            <DataType>string</DataType>
            <Header>string</Header>
            <Data>string</Data>
            <Script>string</Script>
            <Types xsi:nil="true" />
          </Overview>
        </Overviews>
        <Commands>
          <Command>
            <Module />
            <Parameters xsi:nil="true" />
            <Parameters xsi:nil="true" />
            <Command />
            <Data />
          </Command>
          <Command>
            <Module />
            <Parameters xsi:nil="true" />
            <Parameters xsi:nil="true" />
            <Command />
            <Data />
          </Command>
        </Commands>
      </PatientOverview>
    </GetPatientOverviewResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /PasLinkWS/PatientWS/PatientWS.asmx HTTP/1.1
Host: linkws.service.tieto.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12: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>
  </soap12:Header>
  <soap12:Body>
    <GetPatientOverview xmlns="http://healthXML.org/PasLink">
      <patientOverviewRequest>
        <Period>
          <ValidFrom>date</ValidFrom>
          <ValidTo>date</ValidTo>
        </Period>
        <Filters>
          <Filter>
            <Name>string</Name>
            <Value>string</Value>
          </Filter>
          <Filter>
            <Name>string</Name>
            <Value>string</Value>
          </Filter>
        </Filters>
        <PatientId>int</PatientId>
        <OfficialPatientId>string</OfficialPatientId>
        <OfficialPatientIdType>string</OfficialPatientIdType>
        <BirthYear>int</BirthYear>
      </patientOverviewRequest>
    </GetPatientOverview>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12: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>
        <SubCode>long</SubCode>
        <RecoverableError>boolean</RecoverableError>
        <SubModuleName>string</SubModuleName>
      </ErrorInformation>
      <ProfileInfo>
        <DeptCode>string</DeptCode>
        <SectionCode>string</SectionCode>
        <UnitCode>string</UnitCode>
        <ProfileName>string</ProfileName>
      </ProfileInfo>
      <SystemInformation>
        <DatabaseInformation>string</DatabaseInformation>
        <DatabaseServer>string</DatabaseServer>
        <DatabaseName>string</DatabaseName>
      </SystemInformation>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap12:Header>
  <soap12:Body>
    <GetPatientOverviewResponse xmlns="http://healthXML.org/PasLink">
      <PatientOverview>
        <ModuleName>string</ModuleName>
        <Generated>dateTime</Generated>
        <Overviews>
          <Overview>
            <Keys xsi:nil="true" />
            <Dates xsi:nil="true" />
            <Type>string</Type>
            <DataType>string</DataType>
            <Header>string</Header>
            <Data>string</Data>
            <Script>string</Script>
            <Types xsi:nil="true" />
          </Overview>
          <Overview>
            <Keys xsi:nil="true" />
            <Dates xsi:nil="true" />
            <Type>string</Type>
            <DataType>string</DataType>
            <Header>string</Header>
            <Data>string</Data>
            <Script>string</Script>
            <Types xsi:nil="true" />
          </Overview>
        </Overviews>
        <Commands>
          <Command>
            <Module />
            <Parameters xsi:nil="true" />
            <Parameters xsi:nil="true" />
            <Command />
            <Data />
          </Command>
          <Command>
            <Module />
            <Parameters xsi:nil="true" />
            <Parameters xsi:nil="true" />
            <Command />
            <Data />
          </Command>
        </Commands>
      </PatientOverview>
    </GetPatientOverviewResponse>
  </soap12:Body>
</soap12:Envelope>