1.1 MedicalRegistrationWS – Medical registration

Version: 2.1.14296

Web Service with methods to finish and cancel medical registration for a patient’s contact. This is done to close the registration of diagnosis and procedures. After medical registration is finished, registration of diagnosis and procedures are locked.

The MedicalRegistrationWS Web Service contains these methods:

FinishMedicalRegistration
CancelMedicalRegistration

The Web Service reference is: MedicalRegistrationWS.asmx

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

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

1.1.1 FinishMedicalRegistration

Applicable systems for method:

INFOMEDIX

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

INFOMEDIX

1.0

Description:

Finishes the medical registration for at given contact. This means that diagnosis and procedures no longer can be updated.

Syntax:

FinishMedicalRegistration(PatientId, ContactId)

Parameter in	Type	Length byte	Description – Data format – Valid data
PatientId	Number	4	Internal patient id
ContactId	Number	4	Internal contact id

Returned parameter	Type	Length Byte	Description – Comments
None

Web Service Response and Request:

HTTP SOAP Request Envelope for FinishMedicalRegistration

POST /PasLinkWS/MedicalRegistrationWS/MedicalRegistrationWS.asmx HTTP/1.1

Host: localhost

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

Content-Length: length

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

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

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

      <PatientId>int</PatientId>

      <ContactId>int</ContactId>

    </FinishMedicalRegistration>

  </soap:Body>

</soap:Envelope>

HTTP SOAP Response Envelope for FinishMedicalRegistration

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>

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

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