ExternalOrganizationWS Web Service

ExternalOrganizationWS

Click here for a complete list of operations.

GetExternalOrganization

Gets an external organization. An external organization is located outside the hospital. Ex: Hospital, Care centre, Doctor

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/ExternalOrganizationWS/ExternalOrganizationWS.asmx HTTP/1.1
Host: linkws.service.tieto.com
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/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>

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/ExternalOrganizationWS/ExternalOrganizationWS.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>
    <GetExternalOrganization xmlns="http://healthXML.org/PasLink">
      <Id>int</Id>
      <Type>string</Type>
      <ExternalCode>string</ExternalCode>
      <ExternalName>string</ExternalName>
      <ValidDate>dateTime</ValidDate>
    </GetExternalOrganization>
  </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>
    <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>
  </soap12:Body>
</soap12:Envelope>