1.1   ImportantMedicalFactsWS – Important Medical facts

Version: 2.1.14296

 

The Web Service includes methods that handles important medical facts about a patient. New IMF can be inserted/updated, read and deleted for a selected patient.

 

The ImportantMedicalFactsWS Web Service contains these methods:

 

The Web Service reference is: ImportantMedicalFactsWS.asmx

 

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

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

 

 

 

1.1.1   GetIMF

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.0

 

 

 

 

 

 

 

Description:

Get one important medical facts like cave and infections for a specified patient.

 

Syntax:

ImportantMedicalFacts = GetIMF(PatientId, IMFId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

PatientId

Numeric

N/A

Dynamic

Internal patient id.

IMFId

Numeric

N/A

Dynamic

Internal IMF id.

 

Returned parameter

Type

Length Byte

Description – Comments

ImportantMedicalFacts

 

N/A

Dynamic

Class according to XML schema importantmedicalfacts.xsd

 

Schema for ImportantMedicalFacts: importantmedicalfacts.xsd

Schema documentation for ImportantMedicalFacts: ImportantMedicalFacts.html

Sample xml file for ImportantMedicalFacts: ImportantMedicalFacts.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Request Envelope for GetIMF

 

POST /PasLinkWS/ImportantMedicalFactsWS/ImportantMedicalFactsWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/GetIMF"
 
<?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>
    <GetIMF xmlns="http://healthXML.org/PasLink/">
      <PatientId>int</PatientId>
      <IMFId>int</IMFId>
    </GetIMF>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for GetIMF

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE importantmedicalfacts.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>
    <GetIMFResponse xmlns="http://healthXML.org/PasLink/">
      <ImportantMedicalFacts>
        <PatientId>int</PatientId>
        <Started>
          <ResponsibleId>int</ResponsibleId>
          <Comment>string</Comment>
          <Journal>
            <Id>int</Id>
            <Version>int</Version>
          </Journal>
          <Date>date</Date>
        </Started>
        <Closed>
          <ResponsibleId>int</ResponsibleId>
          <Comment>string</Comment>
          <Journal>
            <Id>int</Id>
            <Version>int</Version>
          </Journal>
          <Date>date</Date>
        </Closed>
        <ChangedBy>string</ChangedBy>
        <ChangedDate>date</ChangedDate>
        <Type>string</Type>
      </ImportantMedicalFacts>
    </GetIMFResponse>
  </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   SaveIMF

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.0

 

 

 

 

 

 

 

Description:

Insert or update one important medical facts like cave and infections for a specified patient.

 

Syntax:

ImportantMedicalFacts = SaveIMF(ImportantMedicalFacts)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ImportantMedicalFacts

 

N/A

Dynamic

Class according to XML schema importantmedicalfacts.xsd

 

Returned parameter

Type

Length Byte

Description – Comments

ImportantMedicalFacts

 

N/A

Dynamic

Class according to XML schema importantmedicalfacts.xsd

 

For details and specification about importantmedicalfacts.xsd see GetIMF

 

 

Web Service Response and Request:

 

HTTP SOAP Request Envelope for SaveIMF

 

POST /PasLinkWS/ImportantMedicalFactsWS/ImportantMedicalFactsWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/SaveIMF"
 
<?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>
    <SaveIMF xmlns="http://healthXML.org/PasLink/">
      <ImportantMedicalFacts>
        <PatientId>int</PatientId>
        <Started>
          <ResponsibleId>int</ResponsibleId>
          <Comment>string</Comment>
          <Journal>
            <Id>int</Id>
            <Version>int</Version>
          </Journal>
          <Date>date</Date>
        </Started>
        <Closed>
          <ResponsibleId>int</ResponsibleId>
          <Comment>string</Comment>
          <Journal>
            <Id>int</Id>
            <Version>int</Version>
          </Journal>
          <Date>date</Date>
        </Closed>
        <ChangedBy>string</ChangedBy>
        <ChangedDate>date</ChangedDate>
        <Type>string</Type>
      </ImportantMedicalFacts>
    </SaveIMF>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for SaveIMF

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE importantmedicalfacts.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>
    <SaveIMFResponse xmlns="http://healthXML.org/PasLink/">
      <ImportantMedicalFacts>
        <PatientId>int</PatientId>
        <Started>
          <ResponsibleId>int</ResponsibleId>
          <Comment>string</Comment>
          <Journal>
            <Id>int</Id>
            <Version>int</Version>
          </Journal>
          <Date>date</Date>
        </Started>
        <Closed>
          <ResponsibleId>int</ResponsibleId>
          <Comment>string</Comment>
          <Journal>
            <Id>int</Id>
            <Version>int</Version>
          </Journal>
          <Date>date</Date>
        </Closed>
        <ChangedBy>string</ChangedBy>
        <ChangedDate>date</ChangedDate>
        <Type>string</Type>
      </ImportantMedicalFacts>
    </SaveIMFResponse>
  </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.3   DeleteIMF

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.0

 

 

 

 

 

 

 

Description:

Delete one important medical facts for a specified patient.

 

Syntax:

DeleteIMF(PatientId, IMFId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

PatientId

Numeric

N/A

Dynamic

Internal patient id.

IMFId

Numeric

N/A

Dynamic

Internal IMF id.

 

Returned parameter

Type

Length Byte

Description – Comments

Returns nothing

 

 

 

 

Web Service Response and Request:

 

HTTP SOAP Request Envelope for DeleteIMF

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

 

POST /PasLinkWS/ImportantMedicalFactsWS/ImportantMedicalFactsWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/DeleteIMF"
 
<?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>
    <DeleteIMF xmlns="http://healthXML.org/PasLink/">
      <PatientId>int</PatientId>
      <IMFId>int</IMFId>
    </DeleteIMF>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for DeleteIMF

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE importantmedicalfacts.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>
    <DeleteIMFResponse 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.4   ListIMFToSign

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.8

 

 

 

 

 

 

 

Description:

Lists important medical facts to be signed by the the calling user.

 

Syntax:

ImportantMedicalFactsCollection ListIMFToSign(PatientId, OrganizationUnitId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

PatientId

Numeric

4 byte

Internal patient id.

Required.

OrganizationUnitId

Numeric

4 byte

Organization's id in the HIS. Format N(9)

 

Returned parameter

Type

Length Byte

Description – Comments

ImportantMedicalFactsCollection

 

N/A

Dynamic

ImportantMedicalFacts collection Class according to XML schema ImportantMedicalFacts.xsd

 

Schema for ImportantMedicalFacts type in ImportantMedicalFactsCollection : importantmedicalfacts.xsd

Schema documentation for ImportantMedicalFacts: ImportantMedicalFacts.html

Sample xml file for ImportantMedicalFacts: ImportantMedicalFacts.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Request Envelope for ListIMFToSign

 

POST /PaslinkWS/ImportantMedicalFactsWS/ImportantMedicalFactsWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/ListIMFToSign"
 
<?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>
    <ListIMFToSign xmlns="http://healthXML.org/PasLink">
      <PatientId>int</PatientId>
      <OrganizationUnitId>int</OrganizationUnitId>
    </ListIMFToSign>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for ListIMFToSign

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE importantmedicalfacts.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>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <ListIMFToSignResponse xmlns="http://healthXML.org/PasLink">
      <ListIMFToSignResult>
        <ImportantMedicalFacts>
          <PatientId>int</PatientId>
          <PatientName>string</PatientName>
          <PatientOfficialId>string</PatientOfficialId>
          <Started>
            <ResponsibleId>int</ResponsibleId>
            <ResponsibleRoleId>int</ResponsibleRoleId>
            <ResponsibleAccessTemplateId>int</ResponsibleAccessTemplateId>
            <ResponsibleName>string</ResponsibleName>
            <Comment>string</Comment>
            <Journal xsi:nil="true" />
            <Date>date</Date>
          </Started>
          <Closed>
            <ResponsibleId>int</ResponsibleId>
            <ResponsibleRoleId>int</ResponsibleRoleId>
            <ResponsibleAccessTemplateId>int</ResponsibleAccessTemplateId>
            <ResponsibleName>string</ResponsibleName>
            <Comment>string</Comment>
            <Journal xsi:nil="true" />
            <Date>date</Date>
          </Closed>
          <ChangedBy>string</ChangedBy>
          <ChangedDate>date</ChangedDate>
          <ChangedStatus>string</ChangedStatus>
          <ChangedStatusCode>string</ChangedStatusCode>
          <Type>string</Type>
          <Version>int</Version>
        </ImportantMedicalFacts>
        <ImportantMedicalFacts>
          <PatientId>int</PatientId>
          <PatientName>string</PatientName>
          <PatientOfficialId>string</PatientOfficialId>
          <Started>
            <ResponsibleId>int</ResponsibleId>
            <ResponsibleRoleId>int</ResponsibleRoleId>
            <ResponsibleAccessTemplateId>int</ResponsibleAccessTemplateId>
            <ResponsibleName>string</ResponsibleName>
            <Comment>string</Comment>
            <Journal xsi:nil="true" />
            <Date>date</Date>
          </Started>
          <Closed>
            <ResponsibleId>int</ResponsibleId>
            <ResponsibleRoleId>int</ResponsibleRoleId>
            <ResponsibleAccessTemplateId>int</ResponsibleAccessTemplateId>
            <ResponsibleName>string</ResponsibleName>
            <Comment>string</Comment>
            <Journal xsi:nil="true" />
            <Date>date</Date>
          </Closed>
          <ChangedBy>string</ChangedBy>
          <ChangedDate>date</ChangedDate>
          <ChangedStatus>string</ChangedStatus>
          <ChangedStatusCode>string</ChangedStatusCode>
          <Type>string</Type>
          <Version>int</Version>
        </ImportantMedicalFacts>
      </ListIMFToSignResult>
    </ListIMFToSignResponse>
  </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.5   ListPatientsWithIMFToSign

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.10

 

 

 

 

 

 

 

Description:

List patients with important medical facts to be signed by the  calling user.

 

Syntax:

ImportantMedicalFactsCollection ListPatientsWithIMFToSign(OrganizationUnitId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

OrganizationUnitId

Numeric

4 bytes

Organization id in the HIS. Format N(9)

 

Returned parameter

Type

Length Byte

Description – Comments

ImportantMedicalFactsCollection

 

N/A

Dynamic

ImportantMedicalFacts collection Class according to XML schema ImportantMedicalFacts.xsd

 

Schema for ImportantMedicalFacts type in ImportantMedicalFactsCollection: importantmedicalfacts.xsd

Schema documentation for ImportantMedicalFacts: ImportantMedicalFacts.html

Sample xml file for ImportantMedicalFacts: ImportantMedicalFacts.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Request Envelope for ListPatientsWithIMFToSign

 

POST /PaslinkWS/ImportantMedicalFactsWS/ImportantMedicalFactsWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/ListPatientsWithIMFToSign"
 
<?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>
    <ListPatientsWithIMFToSign xmlns="http://healthXML.org/PasLink">
      <OrganizationUnitId>int</OrganizationUnitId>
    </ListPatientsWithIMFToSign>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for ListPatientsWithIMFToSign

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE importantmedicalfacts.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>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <ListPatientsWithIMFToSignResponse xmlns="http://healthXML.org/PasLink">
      <ListPatientsWithIMFToSignResult>
        <ImportantMedicalFacts>
          <PatientId>int</PatientId>
          <PatientName>string</PatientName>
          <PatientOfficialId>string</PatientOfficialId>
          <Started>
            <ResponsibleId>int</ResponsibleId>
            <ResponsibleRoleId>int</ResponsibleRoleId>
            <ResponsibleAccessTemplateId>int</ResponsibleAccessTemplateId>
            <ResponsibleName>string</ResponsibleName>
            <Comment>string</Comment>
            <Journal xsi:nil="true" />
            <Date>date</Date>
          </Started>
          <Closed>
            <ResponsibleId>int</ResponsibleId>
            <ResponsibleRoleId>int</ResponsibleRoleId>
            <ResponsibleAccessTemplateId>int</ResponsibleAccessTemplateId>
            <ResponsibleName>string</ResponsibleName>
            <Comment>string</Comment>
            <Journal xsi:nil="true" />
            <Date>date</Date>
          </Closed>
          <ChangedBy>string</ChangedBy>
          <ChangedDate>date</ChangedDate>
          <ChangedStatus>string</ChangedStatus>
          <ChangedStatusCode>string</ChangedStatusCode>
          <Type>string</Type>
          <Version>int</Version>
        </ImportantMedicalFacts>
        <ImportantMedicalFacts>
          <PatientId>int</PatientId>
          <PatientName>string</PatientName>
          <PatientOfficialId>string</PatientOfficialId>
          <Started>
            <ResponsibleId>int</ResponsibleId>
            <ResponsibleRoleId>int</ResponsibleRoleId>
            <ResponsibleAccessTemplateId>int</ResponsibleAccessTemplateId>
            <ResponsibleName>string</ResponsibleName>
            <Comment>string</Comment>
            <Journal xsi:nil="true" />
            <Date>date</Date>
          </Started>
          <Closed>
            <ResponsibleId>int</ResponsibleId>
            <ResponsibleRoleId>int</ResponsibleRoleId>
            <ResponsibleAccessTemplateId>int</ResponsibleAccessTemplateId>
            <ResponsibleName>string</ResponsibleName>
            <Comment>string</Comment>
            <Journal xsi:nil="true" />
            <Date>date</Date>
          </Closed>
          <ChangedBy>string</ChangedBy>
          <ChangedDate>date</ChangedDate>
          <ChangedStatus>string</ChangedStatus>
          <ChangedStatusCode>string</ChangedStatusCode>
          <Type>string</Type>
          <Version>int</Version>
        </ImportantMedicalFacts>
      </ListPatientsWithIMFToSignResult>
    </ListPatientsWithIMFToSignResponse>
  </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.6   ListIMFVersions

Applicable systems for method:

INFOMEDIX

 

 

 

 

 

 

 

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

INFOMEDIX

1.8

 

 

 

 

 

 

 

Description:

List all versions of an important medical fact.

Syntax:

IMFVersions ListIMFVersions(int IMFId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

IMFId

Numeric

4 bytes

Internal IMF id.

 

Returned parameter

Type

Length Byte

Description – Comments

IMFVersions

 

N/A

Dynamic

Class according to XML schema IMFVersions.xsd

 

Schema for IMFVersions: imfversions.xsd

Schema documentation for IMFVersions: IMFVersions.html

Sample xml file for IMFVersions: IMFVersions.xml

 

 

Web Service Response and Request:

 

HTTP SOAP Request Envelope for ListIMFVersions

 

POST /PaslinkWS/ImportantMedicalFactsWS/ImportantMedicalFactsWS.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://healthXML.org/PasLink/ListIMFVersions"
 
<?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>
    <ListIMFVersions xmlns="http://healthXML.org/PasLink">
      <IMFId>int</IMFId>
    </ListIMFVersions>
  </soap:Body>
</soap:Envelope>

 

HTTP SOAP Response Envelope for ListIMFVersions

NOT POSSIBLE TO DISPLAY CORRECT DUE TO TAGS/STRUCTURE ARE OPTIONAL/NULLABLE. SEE importantmedicalfacts.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>
      <NextKey>string</NextKey>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <ListIMFVersionsResponse xmlns="http://healthXML.org/PasLink">
      <IMFVersions>
        <IMFVersion>
          <ChangedDate>dateTime</ChangedDate>
          <Version>int</Version>
          <ChangedStatus>string</ChangedStatus>
          <ChangedBy>string</ChangedBy>
        </IMFVersion>
        <IMFVersion>
          <ChangedDate>dateTime</ChangedDate>
          <Version>int</Version>
          <ChangedStatus>string</ChangedStatus>
          <ChangedBy>string</ChangedBy>
        </IMFVersion>
      </IMFVersions>
    </ListIMFVersionsResponse>
  </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.