1.1   ProcedureWS – Procedure

Version: 2.1.19073

 

Web Service with methods to get. List, save and delete procedures.

All methods require a correct and verified Authentication Block from AuthenticationWS to get any information from the HIS.

 

The Procedure Web Service contains these methods:

 

The Web Service reference is: ProcedureWS.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/ProcedureWS/ProcedureWS.asmx

 

1.1.1   GetContactProcedures

Applicable systems for method:

INFOMEDIX

HIS90

 

 

 

 

 

 

Description:

Gets all procedures for a given patient and contact.

 

Syntax:

ContactProcedures = GetContactProcedures(PatientId, ContactId)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

PatientId

Number

4 byte

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

Required.

ContactId

String

N/A

Dynamic

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

Required.

In His90 ContactId = PatientId|SourceOfServ|SerialNoMeca|SerialNoStay.

To get this id, use the Web Service ContactWS, method GetPatientContacts.

 

Returned parameter

Type

Length Byte

Description – Comments

ContactProcedures

Class

N/A

Dynamic

ContactProcedures collection class according to XML schema ContactProcedures.xsd.

 

 

Definition of the data structure ContactProcedures for getting information from GetContactProcedures

 

Name

Type

Length Byte

Description – Comments

PatientId

Number

4 byte Integer

Patient’s id in the HIS. Format N(9)

ContactId

String

N/A

Dynamic

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

In His90 ContactId = PatientId|SourceOfServ|SerialNoMeca|SerialNoStay

MedicalRegistrationFinis hed

Boolean

  Boolean

= True if medicalregistration is finished.

MedicalRegistrationFinishedSpecified

Booelan

  Boolean

= True if MedicalRegistrationFinished is specified

 ContactActivities * xxx

ContactActivities; the structure below is repeated xxx times.

where xxx is valid from 0 to endless/undetermined

 

 

 

See ContactProcedures.xsd scheme

 

 

 

 

 

 

 

 

 

Schema for ContactProcedures: ContactProcedurest.xsd

Schema documentation for ContactProcedures: ContactProcedures.html

Sample xml file for ContactProcedures: ContactProcedures.xml

 

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/ProcedureWS/ProcedureWS.asmx?op=GetContactProcedures

 

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   SaveContactProcedures

Applicable systems for method:

INFOMEDIX

HIS90

 

 

 

 

 

 

Description:

Save contactactivities and procedures for a patients contact.

 

Syntax:

ContactProcedures = SaveContactProcedures(ContactProcedures)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ContactProcedures

 Class

N/A

Dynamic

ContactProcedures class according to schema ContactProcedures.xsd

If you want to update a ContactActivity or Procedure, use the internal ContactActivity Id or Procedure Id.

If you want to insert a new ContactActivity or Procedure, ContactActivity Id or Procedure Id must be 0 or null.

See below for more details.

 

 

Returned parameter

Type

Length Byte

Description – Comments

ContactProcedures

 Class

N/A

Dynamic

ContactProcedures class according to schema ContactProcedures.xsd

See below for more details.

 

 

Schema for ContactProcedures: ContactProcedurest.xsd

Schema documentation for ContactProcedures: ContactProcedures.html

Sample xml file for ContactProcedures: ContactProcedures.xml

 

 

The following elements in the ContactProcedures class is input parameters to the method SaveContactProcedures, and  can or must be set (see next table for HIS90):

 

Elements marked with a * is required, and elements marked with ** is required and a new value can also be returned from the method.

 

Elementname

Description – Comments

 ContactProcedures

PatientId *

ContactId *

ContactActivities[1..unbounded]

 Id **                                     

            Type.Code *                                                               

            From *

            To

            Emergency                              

            MedicalOrganization.Id *          

            CareOrganization.Id *              

            Procedures[0..unbounded]

            Id **                                      

                                                          

            MainProcedure                         

           

            From *

            To

            ToSpecified                             

            DiagnosisId                             

            DiagnosisIdSpecified                

            Status.Code *                          

            Comment

            Codes[1..unbounded]

                  SequenceNumber **                     

                                                                        

                                                                    

                  MedCode.Id                                  

                                                                          

                                                                         

                                                                         

                  MedCode.Code

                  MedCode.MedRegister.Code

                 MedCode.MedRegister.OfficialCode            

           DoNotCreateEvent

 

 

 

 

=0 if new contactactivity , else a valid internal id

A code of type="TJENTYPE"

 

 

 

=true if Emergency

Valid INFOMEDIX organization id.

Valid INFOMEDIX organization id.

 

= 0 if new procedure, else a valid procedure id if update.

 If new procedure, the allocated id will be returned.

= true if mainprocedure

 

 

 

= true if To is set

= 0/null or a valid diagnosis id .

Must be set = true if DiagnosisId is set.

"PL" / "AV" / "UT" 

 

 

= 1 if maincode else = 0 if additionalcodes.                   If additional codes, the allocated

SequenceNumber will be returned.

If MedCode.Id > 0 , only this will be used.

If MedCode.Id = 0 , MedCode.Code and

MedCode.MedRegister.Code or

MedCode.MedRegister.OfficialCode must be specified.

                                                                         

                                     

 

Flag for not creating evente on inserting/changing procedures

 

 

 

 

The following elements in the ContactProcedures class is input parameters to the method SaveContactProcedures, and  can or must be set for HIS90:

 

Elements marked with a * is required, and elements marked with ** is required and a new value can also be returned from the method.

 

Elementname

Description – Comments

 ContactProcedures

PatientId *

ContactId *

 

 

ContactActivities[1..1]

Procedures[1..unbounded]

Id **

 

 

 

 

MainProcedure

 

 

 

 

ProcedureTypeType

 

 

From *

To

ToSpecified

DiagnosisId

 

 

 

OperationId

 

 

 

 

ExecutedBy[1..3]

OrganizationUnit.Id

OrganizationUnit.ShortNameId

Rescource.Id

 

Codes[1..1]*

MedCode.Id

 

 

 

 

MedCode.Code

MedCode.MedRegister.Code

 

PercentAddition *

UpdateCount *

 

 

ContactId = PatientId|SourceOfServ|SerialNoMeca|SerialNoStay

To get this id, use the Web Service ContactWS, method GetPatientContacts.

 

 

= 0 if new procedure, else a valid procedure id if update.

If new procedure, the allocated id will be returned.

ProcedureId = SerialNoMeca|SerialNoStay|SourceOfServ|SerialNoServ. To get this id, use the method GetContactProcedure in this Web Service.

MainProcedure is not used input parameter for HIS90.

Se ProcedureTypeType. In method response MainProcedure will be true if the procedure is the main procedure but false if the procedure is sup procedure or undecided.

 

Valid input is blank, H (for main procedure) or B (for sub procedure)

 

Only for inpatient.

Only for inpatient.

Must be set = true if To is set

= 0/null/”” or a valid diagnosis id. 0 or “” removes the diagnosis connection. To get this id, use the Web Service DiagnosisWS, method GetContactsDiagnosis.

 

= 0/null/”” or a valid operation id. 0 or “” removes the operation connection.

To get this id, use the method GetContactProcedure in this web service.

 

Only for inpatient.

Only in ExecutedBy[0]

Only in ExecutedBy[0]

TreadedBy in ExecutedBy[0], Assisten1 in ExecutedBy[1] and Assistant2 in ExecutedBy[2]

 

If MedCode.Id <> 0 and <> “” , only this will be used.

MedCodeId = MedRegister.Id|S|MedCode.MedRegister.Code| MedCode.Code. To get this id, use the Web Service CommonCodesWS, method ListMedicalCodes.

 

If MedCode.Id = 0 or “”, MedCode.Code and

MedCode.MedRegister.Code must be specified.

 

Only for outpatient.

= 0 if new, else UpdateCount to the procedure before image.

PatientDocuments

PrintGiroToPatient

 

 

 

 

 

 

 

 

 

 

 

 

 

PrinterAddress

Info about patient information and/or documents

Set if giro should be printed and how it should be printed.

In request set if system/database should print giro/doucment.

In respoense it is set client/applicationshould print the giro/document.

Valid values for PrintGiroToPatient are:

NotSet = Not choose, PAS system handles printing by internal rules if needed.

PrintGiroOnServer = Always print giro by database/main server if needed.

PrintGiroOnClient = Applications client prints the giro by itself if needed.

GiroPrintedOK = Sataus back in response if giro printed ok on server.

 

Address to printer, either specific printercode code in database/server, DNS of IP address.

If omitted in system print then the system will use either default system giro printer of users default giro printer.

HIS90: Use UserConfigurationWS to get users default giro printer.

 

 

 

 

 

 

 

 

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/ProcedureWS/ProcedureWS.asmx?op=SaveContactProcedures

 

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.

 

HIS90 Specified information:

For using the SaveContactProcedures method the user must have BOSE access level equal to or larger than 4. This restriction is implemented in the PAS server.

 

1.1.3   DeleteContactProcedures

Applicable systems for method:

INFOMEDIX

HIS90

 

 

 

 

 

 

Description:

Delete a procedure for a given patient.

 

Syntax:

DeleteContactProcedures(PatientId, ProcedureId )

 

Parameter in

Type

Length byte

Description – Data format – Valid data

PatientId

Number

4 byte

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

Required.

ProcedureId

String

N/A

Dynamic

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

Required.

 

In His90 ProcedureId = SerialNoMeca|SerialNoStay|SourceOfServ|SerialNoServ. To get this id, use the method GetContactProcedure in this web service.

 

ContactId

String

N/A

Dynamic

Contact id for the procedure to delete

 

Returned parameter

Type

Length Byte

Description – Comments

Nothing returned

 

 

 

 

 

 

Web Service Response and Request:

 

HTTP SOAP Reqeust Envelope for DeleteContactProcedures

See https://linkws.service.tieto.com/PasLinkWS/ProcedureWS/ProcedureWS.asmx?op=DeleteContactProcedures

 

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.