PatientWS Web Service

PatientWS

Click here for a complete list of operations.

GetPatient

Gets data about one patient. Search can be made using either the internal patient id or the official id.

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

<?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>
    <GetPatient xmlns="http://healthXML.org/PasLink">
      <PatientId>int</PatientId>
      <OfficialId>string</OfficialId>
      <TypeOfId>string</TypeOfId>
    </GetPatient>
  </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>
    <GetPatientResponse xmlns="http://healthXML.org/PasLink">
      <Patient>
        <Id>
          <PatientId>int</PatientId>
          <AdditionalId>
            <Id>int</Id>
          </AdditionalId>
          <AdditionalId>
            <Id>int</Id>
          </AdditionalId>
          <AdditionalIds>
            <Id>string</Id>
            <TypeOfId>string</TypeOfId>
            <FormattedId>string</FormattedId>
          </AdditionalIds>
          <AdditionalIds>
            <Id>string</Id>
            <TypeOfId>string</TypeOfId>
            <FormattedId>string</FormattedId>
          </AdditionalIds>
        </Id>
        <Name>
          <LastName>string</LastName>
          <MiddleName>string</MiddleName>
          <FirstName>string</FirstName>
          <GivenName>string</GivenName>
        </Name>
        <Address>
          <AddressLines>
            <AddressLine xsi:nil="true" />
            <AddressLine xsi:nil="true" />
          </AddressLines>
          <PostalAddress>
            <Code>string</Code>
            <Name>string</Name>
          </PostalAddress>
          <AddressLine1>string</AddressLine1>
          <AddressLine2>string</AddressLine2>
          <COAddress>string</COAddress>
        </Address>
        <AdditonalAddresses>
          <Telephones>
            <TelecomValueTypeCommonWithExt xsi:nil="true" />
            <TelecomValueTypeCommonWithExt xsi:nil="true" />
          </Telephones>
        </AdditonalAddresses>
        <AdditonalAddresses>
          <Telephones>
            <TelecomValueTypeCommonWithExt xsi:nil="true" />
            <TelecomValueTypeCommonWithExt xsi:nil="true" />
          </Telephones>
        </AdditonalAddresses>
        <Economy>
          <EconomicAddress>
            <HouseProperty>string</HouseProperty>
            <District>string</District>
            <BillingDistrict>string</BillingDistrict>
          </EconomicAddress>
          <Freepass>
            <InternalFreepassId>string</InternalFreepassId>
            <Number>string</Number>
            <ValidPeriod xsi:nil="true" />
            <HaveFreepass>boolean</HaveFreepass>
          </Freepass>
          <Asylum>
            <DossierNumber>string</DossierNumber>
            <DossierValidTo>date</DossierValidTo>
            <Applicant>boolean</Applicant>
          </Asylum>
          <InsuranceCollection>
            <Insurance xsi:nil="true" />
            <Insurance xsi:nil="true" />
          </InsuranceCollection>
        </Economy>
        <Telecom>
          <MobilePhoneReservation>boolean</MobilePhoneReservation>
          <EMailReservation>boolean</EMailReservation>
          <MobilePhoneLastChangedDate>dateTime</MobilePhoneLastChangedDate>
          <EMailLastChangedDate>dateTime</EMailLastChangedDate>
        </Telecom>
        <PersonalInformation>
          <AdditionalInformations>
            <AdditionalInformation xsi:nil="true" />
            <AdditionalInformation xsi:nil="true" />
          </AdditionalInformations>
          <CareLivingSituation>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </CareLivingSituation>
          <CareLivingSituation>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </CareLivingSituation>
          <LivingWithPartner>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </LivingWithPartner>
          <LivingWithPartner>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </LivingWithPartner>
          <NeedsTranslator>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </NeedsTranslator>
          <NeedsTranslator>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </NeedsTranslator>
          <EPRInfoTransferConsent>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </EPRInfoTransferConsent>
          <EPRInfoTransferConsent>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </EPRInfoTransferConsent>
          <DocumentLanguage>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </DocumentLanguage>
          <Consentability>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </Consentability>
        </PersonalInformation>
        <CurrentContactStatus>
          <TypeOfCare>
            <Code>string</Code>
            <Text>string</Text>
          </TypeOfCare>
          <MedicalUnit>
            <Id>int</Id>
            <TypeOfId>string</TypeOfId>
            <ShortNameId>string</ShortNameId>
            <Name>string</Name>
            <OfficialId>string</OfficialId>
            <ValidPeriod xsi:nil="true" />
          </MedicalUnit>
          <CareUnit>
            <Id>int</Id>
            <TypeOfId>string</TypeOfId>
            <ShortNameId>string</ShortNameId>
            <Name>string</Name>
            <OfficialId>string</OfficialId>
            <ValidPeriod xsi:nil="true" />
          </CareUnit>
          <Institution>
            <Code>string</Code>
            <Name>string</Name>
          </Institution>
          <Placement>
            <Id>int</Id>
            <Code>string</Code>
            <Name>string</Name>
          </Placement>
          <PreviouslyAdmitted>boolean</PreviouslyAdmitted>
          <LastDateDischarged>dateTime</LastDateDischarged>
          <Confidential>
            <Code>string</Code>
            <Text>string</Text>
          </Confidential>
          <IsUserAuthenticatedForPatientCareUnit>boolean</IsUserAuthenticatedForPatientCareUnit>
        </CurrentContactStatus>
        <UpdateCount>short</UpdateCount>
      </Patient>
    </GetPatientResponse>
  </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>
    <GetPatient xmlns="http://healthXML.org/PasLink">
      <PatientId>int</PatientId>
      <OfficialId>string</OfficialId>
      <TypeOfId>string</TypeOfId>
    </GetPatient>
  </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>
    <GetPatientResponse xmlns="http://healthXML.org/PasLink">
      <Patient>
        <Id>
          <PatientId>int</PatientId>
          <AdditionalId>
            <Id>int</Id>
          </AdditionalId>
          <AdditionalId>
            <Id>int</Id>
          </AdditionalId>
          <AdditionalIds>
            <Id>string</Id>
            <TypeOfId>string</TypeOfId>
            <FormattedId>string</FormattedId>
          </AdditionalIds>
          <AdditionalIds>
            <Id>string</Id>
            <TypeOfId>string</TypeOfId>
            <FormattedId>string</FormattedId>
          </AdditionalIds>
        </Id>
        <Name>
          <LastName>string</LastName>
          <MiddleName>string</MiddleName>
          <FirstName>string</FirstName>
          <GivenName>string</GivenName>
        </Name>
        <Address>
          <AddressLines>
            <AddressLine xsi:nil="true" />
            <AddressLine xsi:nil="true" />
          </AddressLines>
          <PostalAddress>
            <Code>string</Code>
            <Name>string</Name>
          </PostalAddress>
          <AddressLine1>string</AddressLine1>
          <AddressLine2>string</AddressLine2>
          <COAddress>string</COAddress>
        </Address>
        <AdditonalAddresses>
          <Telephones>
            <TelecomValueTypeCommonWithExt xsi:nil="true" />
            <TelecomValueTypeCommonWithExt xsi:nil="true" />
          </Telephones>
        </AdditonalAddresses>
        <AdditonalAddresses>
          <Telephones>
            <TelecomValueTypeCommonWithExt xsi:nil="true" />
            <TelecomValueTypeCommonWithExt xsi:nil="true" />
          </Telephones>
        </AdditonalAddresses>
        <Economy>
          <EconomicAddress>
            <HouseProperty>string</HouseProperty>
            <District>string</District>
            <BillingDistrict>string</BillingDistrict>
          </EconomicAddress>
          <Freepass>
            <InternalFreepassId>string</InternalFreepassId>
            <Number>string</Number>
            <ValidPeriod xsi:nil="true" />
            <HaveFreepass>boolean</HaveFreepass>
          </Freepass>
          <Asylum>
            <DossierNumber>string</DossierNumber>
            <DossierValidTo>date</DossierValidTo>
            <Applicant>boolean</Applicant>
          </Asylum>
          <InsuranceCollection>
            <Insurance xsi:nil="true" />
            <Insurance xsi:nil="true" />
          </InsuranceCollection>
        </Economy>
        <Telecom>
          <MobilePhoneReservation>boolean</MobilePhoneReservation>
          <EMailReservation>boolean</EMailReservation>
          <MobilePhoneLastChangedDate>dateTime</MobilePhoneLastChangedDate>
          <EMailLastChangedDate>dateTime</EMailLastChangedDate>
        </Telecom>
        <PersonalInformation>
          <AdditionalInformations>
            <AdditionalInformation xsi:nil="true" />
            <AdditionalInformation xsi:nil="true" />
          </AdditionalInformations>
          <CareLivingSituation>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </CareLivingSituation>
          <CareLivingSituation>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </CareLivingSituation>
          <LivingWithPartner>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </LivingWithPartner>
          <LivingWithPartner>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </LivingWithPartner>
          <NeedsTranslator>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </NeedsTranslator>
          <NeedsTranslator>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </NeedsTranslator>
          <EPRInfoTransferConsent>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </EPRInfoTransferConsent>
          <EPRInfoTransferConsent>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </EPRInfoTransferConsent>
          <DocumentLanguage>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </DocumentLanguage>
          <Consentability>
            <Status>NotSet or Active or Deleted or OutOfDate</Status>
            <ValidDatePeriod xsi:nil="true" />
            <Id xsi:nil="true" />
          </Consentability>
        </PersonalInformation>
        <CurrentContactStatus>
          <TypeOfCare>
            <Code>string</Code>
            <Text>string</Text>
          </TypeOfCare>
          <MedicalUnit>
            <Id>int</Id>
            <TypeOfId>string</TypeOfId>
            <ShortNameId>string</ShortNameId>
            <Name>string</Name>
            <OfficialId>string</OfficialId>
            <ValidPeriod xsi:nil="true" />
          </MedicalUnit>
          <CareUnit>
            <Id>int</Id>
            <TypeOfId>string</TypeOfId>
            <ShortNameId>string</ShortNameId>
            <Name>string</Name>
            <OfficialId>string</OfficialId>
            <ValidPeriod xsi:nil="true" />
          </CareUnit>
          <Institution>
            <Code>string</Code>
            <Name>string</Name>
          </Institution>
          <Placement>
            <Id>int</Id>
            <Code>string</Code>
            <Name>string</Name>
          </Placement>
          <PreviouslyAdmitted>boolean</PreviouslyAdmitted>
          <LastDateDischarged>dateTime</LastDateDischarged>
          <Confidential>
            <Code>string</Code>
            <Text>string</Text>
          </Confidential>
          <IsUserAuthenticatedForPatientCareUnit>boolean</IsUserAuthenticatedForPatientCareUnit>
        </CurrentContactStatus>
        <UpdateCount>short</UpdateCount>
      </Patient>
    </GetPatientResponse>
  </soap12:Body>
</soap12:Envelope>