1.1   PersonWS – Person

Version: 2.1.14296

 

Web Service with methods to search for persons in the national register.

 

The PersonWS Web Service contains these methods:

 

The Web Service reference is: PersonWS.asmx

Open in a Web Browser for more detailed information about each method.  The Web Service's WSDL, SOAP request and response is described.

 

For more detailed information as the Web Service's WSDL, SOAP request and response see:

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

 

1.1.1   ListPersons

Applicable systems for method:

INFOMEDIX

Classic

HIS-90

HL7

 

 

 

 

Description:

Lists persons from the national register according to search criteria like name, sex, birth date and address.

 

Syntax:

 

SimplePersonCollection = ListPersons(BirthDate, LastName, FirstName, Sex, Address, MunicipalityCode, PostalCode, BirthDateTo, MaxRows, UseSoundex)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

BirthDate

DateTime

N/A

Dynamic

The patients birth date.

INFOMEDIX PAS: Exact birtdate, (no date intervals)

HIS90 PAS: Exact birthdate if BirthDateTo is not used/null, or if used with BirthDateTo searh a range of dates.

LastName

 

String

N/A

Dynamic

Persons lastname

INFOMEDIX and CLASSSIC PAS: If soundex is not used, patients with last names that begins with "Last name" will be listed.

HIS90: Part/searchname or whole lastname can be given, if part is given ListPersons will return all persons with lastname starting with part/searchname.

FirstName

String

N/A

Dynamic

Persons firstname

INFOMEDIX and CLASSSIC PAS: If soundex is not used, patients with first names or given names that begins with "First name" will be listed.

HIS90: The whol lastname must be given if firstname is used. Part of both lastname og firstname will return nothing.

Sex

String

N/A

Dynamic

M = male, K = female, blank = both.

Address

String

N/A

Dynamic

Persons address that begins with the address given.

MunicipalityCode

String

N/A

Dynamic

Persons municipality code.

PostalCode

String

N/A

Dynamic

Persons postal code.

BirthDateTo

DateTime

N/A

Dynamic

HIS90 PAS only: Used to search in a date interval. Persons will be listed in the date interval between BirthDate and BirthDateTo.

MaxRows

Int

N/A

Dynamic

HIS90 PAS only: Max records to retrieve. If set to 0, MaxRows is set to 100.

UseSoundex

String

N/A

Dynamic

Infomedix PAS: “True” if name soundex is to be used.

 

Returned parameter

Type

Length Byte

Description – Comments

SimplePersonCollection

 

N/A

Dynamic

Person collection class according to XML schema SimplePerson.xsd.

 

Schema for SimplePatientCollection: SimplePerson.xsd

Schema documentation for SimplePatient: SimplePerson.html

Sample xml file for SimplePatient: SimplePerson.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Request Envelope for ListPersons #HTR ny request

 

POST /PaslinkWS/PersonWS_1/PersonWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/ListPersons"
 
<?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>
    <ListPersons xmlns="http://healthXML.org/PasLink">
      <BirthDate>dateTime</BirthDate>
      <LastName>string</LastName>
      <FirstName>string</FirstName>
      <Sex>string</Sex>
      <Address>string</Address>
      <MunicipalityCode>string</MunicipalityCode>
      <PostalCode>string</PostalCode>
      <BirthDateTo>dateTime</BirthDateTo>
      <MaxRows>int</MaxRows>
    </ListPersons>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for ListPersons

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE SimplePerson.xsd SCHEME FOR FULL DETAILS

 

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>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <ListPersonsResponse xmlns="http://healthXML.org/PasLink/">
      <ListPersonsResult>
        <SimplePerson>
          <Id>
            <OfficialId xsi:nil="true" />
          </Id>
          <Name>
            <FormattedName>string</FormattedName>
          </Name>
          <Address>
            <Municipality xsi:nil="true" />
          </Address>
          <PersonalInformation>
            <BirthDate>date</BirthDate>
            <PersonNumber>integer</PersonNumber>
            <BirthCentury>integer</BirthCentury>
            <Sex xsi:nil="true" />
          </PersonalInformation>
        </SimplePerson>
        <SimplePerson>
          <Id>
            <OfficialId xsi:nil="true" />
          </Id>
          <Name>
            <FormattedName>string</FormattedName>
          </Name>
          <Address>
            <Municipality xsi:nil="true" />
          </Address>
          <PersonalInformation>
            <BirthDate>date</BirthDate>
            <PersonNumber>integer</PersonNumber>
            <BirthCentury>integer</BirthCentury>
            <Sex xsi:nil="true" />
          </PersonalInformation>
        </SimplePerson>
      </ListPersonsResult>
    </ListPersonsResponse>
  </soap:Body>
</soap:Envelope>

 

 

 

Related methods or functions used:

GetUserLogin                   Used to verify a 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 from 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   GetPerson

Applicable systems for method:

INFOMEDIX

Classic

HIS-90

HL7

 

 

 

 

Description:

Gets data about one person from the national register. Search can be made by using the official id.

 

Syntax:

Person = GetPerson(OfficialId, TypeOfId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

OfficialId

String

N/A

Dynamic

The person's official id.

TypeOfId

 

String

N/A

Dynamic

Type of id. Used only for Swedish national register. F = official id, N = emergency number.

 

Returned parameter

Type

Length Byte

Description – Comments

Person

 

N/A

Dynamic

Person class according to schema Person.xsd.

 

Schema for Person: Person.xsd

Schema documentation for Person: Person.html

Sample xml file for Person: Person.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Request Envelope for GetPerson

 

POST /PasLinkWS/PersonWS/PersonWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/GetPerson"
 
<?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>
    </RequestHeader>
  </soap:Header>
  <soap:Body>
    <GetPerson xmlns="http://healthXML.org/PasLink/">
      <OfficialId>string</OfficialId>
      <TypeOfId>string</TypeOfId>
    </GetPerson>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for GetPerson

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE Person.xsd SCHEME FOR FULL DETAILS

 

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>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <GetPersonResponse xmlns="http://healthXML.org/PasLink/">
      <Person>
        <Id>
          <OfficialId>
            <Value>string</Value>
            <TypeOfId>string</TypeOfId>
            <FormattedId>string</FormattedId>
          </OfficialId>
        </Id>
        <Name>
          <LastName>string</LastName>
          <MiddleName>string</MiddleName>
          <FirstName>string</FirstName>
          <GivenName>string</GivenName>
        </Name>
        <Address>
          <County>
            <Code>string</Code>
            <Name>string</Name>
          </County>
          <UrbanNeighbourhood>
            <Code>string</Code>
            <Name>string</Name>
          </UrbanNeighbourhood>
          <HouseProperty>string</HouseProperty>
          <District>string</District>
          <BillingDistrict>string</BillingDistrict>
        </Address>
        <PersonalInformation>
          <PersonSecurity>boolean</PersonSecurity>
        </PersonalInformation>
      </Person>
    </GetPersonResponse>
  </soap:Body>
</soap:Envelope>

 

 

 

Related methods or functions used:

GetUserLogin                   Used to verify a 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 from 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 method.