PatientWS Web Service

PatientWS

Click here for a complete list of operations.

ListPatientsById

Lists patients according to patient id's.

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/ListPatientsById"

<?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>
    <ListPatientsById xmlns="http://healthXML.org/PasLink">
      <PatientIdSearch>
        <Id>
          <Id>
            <PatientId>int</PatientId>
            <AdditionalId xsi:nil="true" />
            <AdditionalId xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
          </Id>
          <Id>
            <PatientId>int</PatientId>
            <AdditionalId xsi:nil="true" />
            <AdditionalId xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
          </Id>
        </Id>
      </PatientIdSearch>
    </ListPatientsById>
  </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>
    <ListPatientsByIdResponse xmlns="http://healthXML.org/PasLink">
      <ListPatientsByIdResult>
        <Patient>
          <Id>
            <PatientId>int</PatientId>
            <AdditionalId xsi:nil="true" />
            <AdditionalId xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
          </Id>
          <Name>
            <LastName>string</LastName>
            <MiddleName>string</MiddleName>
            <FirstName>string</FirstName>
            <GivenName>string</GivenName>
          </Name>
          <Address>
            <AddressLines xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <COAddress>string</COAddress>
          </Address>
          <AdditonalAddresses>
            <Telephones xsi:nil="true" />
          </AdditonalAddresses>
          <AdditonalAddresses>
            <Telephones xsi:nil="true" />
          </AdditonalAddresses>
          <Economy>
            <EconomicAddress xsi:nil="true" />
            <Freepass xsi:nil="true" />
            <Asylum xsi:nil="true" />
            <InsuranceCollection xsi:nil="true" />
          </Economy>
          <Telecom>
            <MobilePhoneReservation>boolean</MobilePhoneReservation>
            <EMailReservation>boolean</EMailReservation>
            <MobilePhoneLastChangedDate>dateTime</MobilePhoneLastChangedDate>
            <EMailLastChangedDate>dateTime</EMailLastChangedDate>
          </Telecom>
          <PersonalInformation>
            <AdditionalInformations xsi:nil="true" />
            <CareLivingSituation xsi:nil="true" />
            <CareLivingSituation xsi:nil="true" />
            <LivingWithPartner xsi:nil="true" />
            <LivingWithPartner xsi:nil="true" />
            <NeedsTranslator xsi:nil="true" />
            <NeedsTranslator xsi:nil="true" />
            <EPRInfoTransferConsent xsi:nil="true" />
            <EPRInfoTransferConsent xsi:nil="true" />
            <DocumentLanguage xsi:nil="true" />
            <Consentability xsi:nil="true" />
          </PersonalInformation>
          <CurrentContactStatus>
            <TypeOfCare xsi:nil="true" />
            <MedicalUnit xsi:nil="true" />
            <CareUnit xsi:nil="true" />
            <Institution xsi:nil="true" />
            <Placement xsi:nil="true" />
            <PreviouslyAdmitted>boolean</PreviouslyAdmitted>
            <LastDateDischarged>dateTime</LastDateDischarged>
            <Confidential xsi:nil="true" />
            <IsUserAuthenticatedForPatientCareUnit>boolean</IsUserAuthenticatedForPatientCareUnit>
          </CurrentContactStatus>
          <UpdateCount>short</UpdateCount>
        </Patient>
        <Patient>
          <Id>
            <PatientId>int</PatientId>
            <AdditionalId xsi:nil="true" />
            <AdditionalId xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
          </Id>
          <Name>
            <LastName>string</LastName>
            <MiddleName>string</MiddleName>
            <FirstName>string</FirstName>
            <GivenName>string</GivenName>
          </Name>
          <Address>
            <AddressLines xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <COAddress>string</COAddress>
          </Address>
          <AdditonalAddresses>
            <Telephones xsi:nil="true" />
          </AdditonalAddresses>
          <AdditonalAddresses>
            <Telephones xsi:nil="true" />
          </AdditonalAddresses>
          <Economy>
            <EconomicAddress xsi:nil="true" />
            <Freepass xsi:nil="true" />
            <Asylum xsi:nil="true" />
            <InsuranceCollection xsi:nil="true" />
          </Economy>
          <Telecom>
            <MobilePhoneReservation>boolean</MobilePhoneReservation>
            <EMailReservation>boolean</EMailReservation>
            <MobilePhoneLastChangedDate>dateTime</MobilePhoneLastChangedDate>
            <EMailLastChangedDate>dateTime</EMailLastChangedDate>
          </Telecom>
          <PersonalInformation>
            <AdditionalInformations xsi:nil="true" />
            <CareLivingSituation xsi:nil="true" />
            <CareLivingSituation xsi:nil="true" />
            <LivingWithPartner xsi:nil="true" />
            <LivingWithPartner xsi:nil="true" />
            <NeedsTranslator xsi:nil="true" />
            <NeedsTranslator xsi:nil="true" />
            <EPRInfoTransferConsent xsi:nil="true" />
            <EPRInfoTransferConsent xsi:nil="true" />
            <DocumentLanguage xsi:nil="true" />
            <Consentability xsi:nil="true" />
          </PersonalInformation>
          <CurrentContactStatus>
            <TypeOfCare xsi:nil="true" />
            <MedicalUnit xsi:nil="true" />
            <CareUnit xsi:nil="true" />
            <Institution xsi:nil="true" />
            <Placement xsi:nil="true" />
            <PreviouslyAdmitted>boolean</PreviouslyAdmitted>
            <LastDateDischarged>dateTime</LastDateDischarged>
            <Confidential xsi:nil="true" />
            <IsUserAuthenticatedForPatientCareUnit>boolean</IsUserAuthenticatedForPatientCareUnit>
          </CurrentContactStatus>
          <UpdateCount>short</UpdateCount>
        </Patient>
      </ListPatientsByIdResult>
    </ListPatientsByIdResponse>
  </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>
    <ListPatientsById xmlns="http://healthXML.org/PasLink">
      <PatientIdSearch>
        <Id>
          <Id>
            <PatientId>int</PatientId>
            <AdditionalId xsi:nil="true" />
            <AdditionalId xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
          </Id>
          <Id>
            <PatientId>int</PatientId>
            <AdditionalId xsi:nil="true" />
            <AdditionalId xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
          </Id>
        </Id>
      </PatientIdSearch>
    </ListPatientsById>
  </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>
    <ListPatientsByIdResponse xmlns="http://healthXML.org/PasLink">
      <ListPatientsByIdResult>
        <Patient>
          <Id>
            <PatientId>int</PatientId>
            <AdditionalId xsi:nil="true" />
            <AdditionalId xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
          </Id>
          <Name>
            <LastName>string</LastName>
            <MiddleName>string</MiddleName>
            <FirstName>string</FirstName>
            <GivenName>string</GivenName>
          </Name>
          <Address>
            <AddressLines xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <COAddress>string</COAddress>
          </Address>
          <AdditonalAddresses>
            <Telephones xsi:nil="true" />
          </AdditonalAddresses>
          <AdditonalAddresses>
            <Telephones xsi:nil="true" />
          </AdditonalAddresses>
          <Economy>
            <EconomicAddress xsi:nil="true" />
            <Freepass xsi:nil="true" />
            <Asylum xsi:nil="true" />
            <InsuranceCollection xsi:nil="true" />
          </Economy>
          <Telecom>
            <MobilePhoneReservation>boolean</MobilePhoneReservation>
            <EMailReservation>boolean</EMailReservation>
            <MobilePhoneLastChangedDate>dateTime</MobilePhoneLastChangedDate>
            <EMailLastChangedDate>dateTime</EMailLastChangedDate>
          </Telecom>
          <PersonalInformation>
            <AdditionalInformations xsi:nil="true" />
            <CareLivingSituation xsi:nil="true" />
            <CareLivingSituation xsi:nil="true" />
            <LivingWithPartner xsi:nil="true" />
            <LivingWithPartner xsi:nil="true" />
            <NeedsTranslator xsi:nil="true" />
            <NeedsTranslator xsi:nil="true" />
            <EPRInfoTransferConsent xsi:nil="true" />
            <EPRInfoTransferConsent xsi:nil="true" />
            <DocumentLanguage xsi:nil="true" />
            <Consentability xsi:nil="true" />
          </PersonalInformation>
          <CurrentContactStatus>
            <TypeOfCare xsi:nil="true" />
            <MedicalUnit xsi:nil="true" />
            <CareUnit xsi:nil="true" />
            <Institution xsi:nil="true" />
            <Placement xsi:nil="true" />
            <PreviouslyAdmitted>boolean</PreviouslyAdmitted>
            <LastDateDischarged>dateTime</LastDateDischarged>
            <Confidential xsi:nil="true" />
            <IsUserAuthenticatedForPatientCareUnit>boolean</IsUserAuthenticatedForPatientCareUnit>
          </CurrentContactStatus>
          <UpdateCount>short</UpdateCount>
        </Patient>
        <Patient>
          <Id>
            <PatientId>int</PatientId>
            <AdditionalId xsi:nil="true" />
            <AdditionalId xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
            <AdditionalIds xsi:nil="true" />
          </Id>
          <Name>
            <LastName>string</LastName>
            <MiddleName>string</MiddleName>
            <FirstName>string</FirstName>
            <GivenName>string</GivenName>
          </Name>
          <Address>
            <AddressLines xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <COAddress>string</COAddress>
          </Address>
          <AdditonalAddresses>
            <Telephones xsi:nil="true" />
          </AdditonalAddresses>
          <AdditonalAddresses>
            <Telephones xsi:nil="true" />
          </AdditonalAddresses>
          <Economy>
            <EconomicAddress xsi:nil="true" />
            <Freepass xsi:nil="true" />
            <Asylum xsi:nil="true" />
            <InsuranceCollection xsi:nil="true" />
          </Economy>
          <Telecom>
            <MobilePhoneReservation>boolean</MobilePhoneReservation>
            <EMailReservation>boolean</EMailReservation>
            <MobilePhoneLastChangedDate>dateTime</MobilePhoneLastChangedDate>
            <EMailLastChangedDate>dateTime</EMailLastChangedDate>
          </Telecom>
          <PersonalInformation>
            <AdditionalInformations xsi:nil="true" />
            <CareLivingSituation xsi:nil="true" />
            <CareLivingSituation xsi:nil="true" />
            <LivingWithPartner xsi:nil="true" />
            <LivingWithPartner xsi:nil="true" />
            <NeedsTranslator xsi:nil="true" />
            <NeedsTranslator xsi:nil="true" />
            <EPRInfoTransferConsent xsi:nil="true" />
            <EPRInfoTransferConsent xsi:nil="true" />
            <DocumentLanguage xsi:nil="true" />
            <Consentability xsi:nil="true" />
          </PersonalInformation>
          <CurrentContactStatus>
            <TypeOfCare xsi:nil="true" />
            <MedicalUnit xsi:nil="true" />
            <CareUnit xsi:nil="true" />
            <Institution xsi:nil="true" />
            <Placement xsi:nil="true" />
            <PreviouslyAdmitted>boolean</PreviouslyAdmitted>
            <LastDateDischarged>dateTime</LastDateDischarged>
            <Confidential xsi:nil="true" />
            <IsUserAuthenticatedForPatientCareUnit>boolean</IsUserAuthenticatedForPatientCareUnit>
          </CurrentContactStatus>
          <UpdateCount>short</UpdateCount>
        </Patient>
      </ListPatientsByIdResult>
    </ListPatientsByIdResponse>
  </soap12:Body>
</soap12:Envelope>