1.1   ExternalOrganizationWS – ExternalOrganization

Version: 2.1.14296

 

Web Service with methods to get and list externalorganizations.

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: ExternalOrganizationWS.asmx

 

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

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

 

1.1.1   ListExternalOrganizations

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.0

 

 

 

 

 

 

 

Description:

Lists external organizations. External organizations are located outside the hospital. Ex: Hospitals, Care centres, Doctors.

Syntax:

SimpleExternalOrganizationCollection = ListExternalOrganizations(InstitutionOrPerson,Type,InternalType,Name,ValidDate,

OnlyAllowanceUnits,County,AllowanceValidDate)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

InstitutionOrPerson

String

N/A

Dynamic

Kind of organization to be listed.

I = Institution, P = Person

Type

String

N/A

Dynamic

Type of external organization

InternalType

String

N/A

Dynamic

Internal type of external organization

ExternalName

String

N/A

Dynamic

Name of external organization

ValidDate

DateTime

N/A

Dynamic

Date when organization must be valid

OnlyAllowanceUnits

Boolean

 

Only list organizations with allowance

County

Number

2

County id

AllowanceValidDate

DateTime

N/A

Dynamic

Date when allowance must ve valid

PostCode

String

N/A

Dynamic

PostCode

Address

String

N/A

Dynamic

Address

OfficialId

String

N/A

Dynamic

OfficialId

MunicipalCode

String

N/A

Dynamic

MunicipalCode

 

Returned parameter

Type

Length Byte

Description – Comments

ExternalOrganizationSimpleCollection

class

N/A

Dynamic

ExternalOrganizationSimple class collection according to schema ExternalOrganizationSimple.xsd

 

Schema for ExternalOrganizations ExternalOrganizationSimple.xsd

Schema documentation for ExternalOrganizations: ExternalOrganizationSimple.html

Sample xml file for ExternalOrganizations: ExternalOrganizationSimple.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Reqeust Envelope for ListExternalOrganizations

POST /paslinkWS/ExternalOrganizationWS/ExternalOrganizationWS.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://healthXML.org/PasLink/ListExternalOrganizations"

 

<?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>

    <ListExternalOrganizations xmlns="http://healthXML.org/PasLink">

      <InstitutionOrPerson>string</InstitutionOrPerson>

      <Type>string</Type>

      <InternalType>string</InternalType>

      <ExternalName>string</ExternalName>

      <ValidDate>dateTime</ValidDate>

      <OnlyAllowanceUnits>boolean</OnlyAllowanceUnits>

      <County>short</County>

      <AllowanceValidDate>dateTime</AllowanceValidDate>

      <PostCode>string</PostCode>

      <Address>string</Address>

      <OfficialId>string</OfficialId>

      <MunicipalCode>string</MunicipalCode>

    </ListExternalOrganizations>

  </soap:Body>

</soap:Envelope>

 

HTTP SOAP Response Envelope for ListOrganization

 

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>

    <ListExternalOrganizationsResponse xmlns="http://healthXML.org/PasLink">

      <ListExternalOrganizationsResult>

        <ExternalOrganizationSimple>

          <InstitutionOrPerson>string</InstitutionOrPerson>

          <Id>int</Id>

          <Code>string</Code>

          <Name>string</Name>

          <Type>string</Type>

          <InternalType>string</InternalType>

          <Addresses>

            <Address1>string</Address1>

            <Address2>string</Address2>

            <PostalAddress xsi:nil="true" />

            <PhoneNumber>string</PhoneNumber>

            <FaxNumber>string</FaxNumber>

            <EMailAddress>string</EMailAddress>

          </Addresses>

          <AllowanceValidPeriod>

            <ValidFrom>date</ValidFrom>

            <ValidTo>date</ValidTo>

          </AllowanceValidPeriod>

          <OfficialId>string</OfficialId>

          <Municipality>

            <Code>string</Code>

            <Name>string</Name>

          </Municipality>

          <RESHId>string</RESHId>

          <HERId>string</HERId>

        </ExternalOrganizationSimple>

        <ExternalOrganizationSimple>

          <InstitutionOrPerson>string</InstitutionOrPerson>

          <Id>int</Id>

          <Code>string</Code>

          <Name>string</Name>

          <Type>string</Type>

          <InternalType>string</InternalType>

          <Addresses>

            <Address1>string</Address1>

            <Address2>string</Address2>

            <PostalAddress xsi:nil="true" />

            <PhoneNumber>string</PhoneNumber>

            <FaxNumber>string</FaxNumber>

            <EMailAddress>string</EMailAddress>

          </Addresses>

          <AllowanceValidPeriod>

            <ValidFrom>date</ValidFrom>

            <ValidTo>date</ValidTo>

          </AllowanceValidPeriod>

          <OfficialId>string</OfficialId>

          <Municipality>

            <Code>string</Code>

            <Name>string</Name>

          </Municipality>

          <RESHId>string</RESHId>

          <HERId>string</HERId>

        </ExternalOrganizationSimple>

      </ListExternalOrganizationsResult>

    </ListExternalOrganizationsResponse>

  </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   GetExternalOrganization

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.0

 

 

 

 

 

 

 

Description:

Gets detailed information about a specified external organization.

 

Syntax:

ExternalOrganization = GetExternalOrganization(OrganizationUnitId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

Id

Number

4 byte Integer

Organization id in the HIS. Format N(9)

Required.

Type

String

N/A

Dynamic

Type og external organization

ExternalCode

String

N/A

Dynamic

Shortname of external organization

ExternalName

String

N/A

Dynamic

Name of external organization

ValidDate

DateTime

N/A

Dynamic

Date when organization should be valid

 

Returned parameter

Type

Length Byte

Description – Comments

ExternalOrganization

class

N/A

Dynamic

ExternalOrganization class according to schema ExternalOrganization.xsd

 

Schema for ExternalOrganization: ExternalOrganization.xsd

Schema documentation for ExternalOrganization: ExternalOrganization.html

Sample xml file for ExternalOrganization: ExternalOrganization.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Reqeust Envelope for GetExternalOrganization

 

POST /paslinkWS/ExternalOrganizationWS/ExternalOrganizationWS.asmx HTTP/1.1

Host: localhost

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://healthXML.org/PasLink/GetExternalOrganization"

 

<?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>

    <GetExternalOrganization xmlns="http://healthXML.org/PasLink">

      <Id>int</Id>

      <Type>string</Type>

      <ExternalCode>string</ExternalCode>

      <ExternalName>string</ExternalName>

      <ValidDate>dateTime</ValidDate>

    </GetExternalOrganization>

  </soap:Body>

</soap:Envelope>

 

HTTP SOAP Response Envelope for GetExternalOrganization

 

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>

    <GetExternalOrganizationResponse xmlns="http://healthXML.org/PasLink">

      <ExternalOrganization>

        <InstitutionOrPerson>string</InstitutionOrPerson>

        <Id>int</Id>

        <Code>string</Code>

        <Name>string</Name>

        <OfficialId>string</OfficialId>

        <AreaOfMedicalResponsibilty>string</AreaOfMedicalResponsibilty>

        <RegisterOrigin>string</RegisterOrigin>

        <Type>

          <Code>string</Code>

          <Text>string</Text>

        </Type>

        <InternalType>

          <Code>string</Code>

          <Text>string</Text>

        </InternalType>

        <RegionalInfo>

          <HealthRegion>

            <Code>string</Code>

            <Name>string</Name>

          </HealthRegion>

          <County>

            <Code>string</Code>

            <Name>string</Name>

          </County>

          <Municipality>

            <Code>string</Code>

            <Name>string</Name>

          </Municipality>

        </RegionalInfo>

        <Addresses>

          <Address1>string</Address1>

          <Address2>string</Address2>

          <PhoneNumber>string</PhoneNumber>

          <FaxNumber>string</FaxNumber>

          <EMailAddress>string</EMailAddress>

          <PostalAddress>

            <Code>string</Code>

            <Name>string</Name>

          </PostalAddress>

        </Addresses>

        <ValidPeriod>

          <ValidFrom>date</ValidFrom>

          <ValidTo>date</ValidTo>

        </ValidPeriod>

        <AllowanceValidPeriod>

          <ValidFrom>date</ValidFrom>

          <ValidTo>date</ValidTo>

        </AllowanceValidPeriod>

        <CareUnitOfHospital>boolean</CareUnitOfHospital>

        <HealthServiceSector>string</HealthServiceSector>

        <HealthEnterpriseId>string</HealthEnterpriseId>

        <TypeOfCare>

          <Code>string</Code>

          <OfficialCode>string</OfficialCode>

          <Text>string</Text>

        </TypeOfCare>

        <NameDetail>

          <Name1>string</Name1>

          <Name2>string</Name2>

          <Name3>string</Name3>

        </NameDetail>

        <RESHId>string</RESHId>

        <HERId>string</HERId>

      </ExternalOrganization>

    </GetExternalOrganizationResponse>

  </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.