1.1   DOCUMENTWS – DOCUMENT

Version: 2.1.14296

 

The web service includes methods related to document templates.

 

The DocumentWS Web Service contains these methods:

 

 

Web service reference: DocumentWS.asmx

 

For more detailed information on the web service's WSDL, SOAP request and response, see:

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

 

1.1.1   GetDocumentInfo

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

Gets information about letter information(@-codes) for a document according to search criteria.

This is information that is uses for substitution in a document template to create a document.

 

Syntax:

 

GetDocumentInfoResponse = GetDocumentInfo(GetDocumentInfoRequest)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

GetDocumentInfo­­Request

 

N/A Dynamic

Request class according to XML schema in DocumentWS.xsd

Description:

 

 

 

DocumentInfoTypeCode

Document­Info­Types

N/A Dynamic

Document info type enumerator.

Valid enums are: Booking

DocumentInfoTypeName

String

N/A

Dynamic

Document info type free text.

Id collection

 

 

 

Id valid for the document info type. E.g., for Booking it is BookingId

Id.IdType

 

IdTypes

N/A

Dynamic

Optional attribute: IdType can be used for setting type of id.  E.g. BookingId.

Id.Value

 

String

N/A

Dynamic

Value of id.

 

Returned parameter

Type

Length Byte

Description – Comments

GetDocumentInfo­­Response

 

N/A

Dynamic

Response class according to XML schema DocumentWS.xsd.

Description:

 

 

 

DocumentInfoTypeCode

DocumentInfo­Types

N/A

Dynamic

Document info type enumerator.

Valid enums are: Booking

DocumentInfoTypeName

String

N/A

Dynamic

Document info type free text.

Id collection

 

 

 

Id valid for the document info type. E.g., for Booking it is BookingId

Id.IdType

 

IdTypes

N/A

Dynamic

Optional attribute: IdType can be used for setting type of id.  E.g. BookingId.

Id.Value

 

String

N/A

Dynamic

Value of id.

DocumentCode­Values

 

 

N/A

Dynamic

Document codes and values.

 

HIS90:

Alfa codes.

Code

 

String

N/A

Dynamic

The code name for the value.

 

HIS90:

Alfa code name, e.g. @AVD for department

Name

 

String

N/A

Dynamic

The name for the code

CodeValue

 

String

N/A

Dynamic

The value for the code.

Optional attribute ValueType can be used for setting type of value.

Examples: String, Date, DateTime, Integer

 

Schema for GetDocumentInfoResponse: DocumentWS.xsd

Schema documentation for DocumentWS: DocumentWS.html

 

 

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/DocumentWS/DocumentWS.asmx?op=GetDocumentInfo

 

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 the Authentication web service.

 

In return from the method there will always be a ResponseHeader, which contains Error Information and System Information. The Error Information block must always be checked to determine whether any error has occurred while processing the methods.

1.1.2   ListTemplates

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

Lists templates(letters templates in HIS90) by organization.

 

Syntax:

 

ListTemplatesResponse = ListTemplates(ListTemplatesRequest)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ListTemplatesRequest

 

N/A

Dynamic

Request class according to XML schema in DocumentWS.xsd

Description:

 

 

 

OrganizationUnit

 

N/A

Dynamic

Which users/uses the template is valid for.

OrganizationUnit.Type

String

N/A

Dynamic

NAT = Nasjonal

REG = Region

HF = Helseforetak

LIN = Institusjon

LAV = Avdeling

LEN = Enhet

LBR = Bruker

OrganizationUnit.Id

String

N/A

Dynamic

Id for type.

Used with LAV, LEN og LBR.

LAV = DeptNo

LEN = UnitNo

LBR = brukerid/f.nr

 

Returned parameter

Type

Length Byte

Description – Comments

ListTemplatesResponse

 

N/A

Dynamic

Response class according to XML schema DocumentWS.xsd.

Description:

 

 

 

Template collection

 

 

 

Template.TemplateId

String

N/A

Dynamic

Internal id for Template.

 

HIS90:

Combined id TemplateId

Format: DeptNo|TypeOfId|LetterCode

TypeOfId must be ’LAV’

Template.Code

String

N/A

Dynamic

Letter/template/document code.

 

HIS90:

PAQLETT.CODE

Template.Description

String

N/A

Dynamic

 

Template.Organization­Unit

 

N/A

Dynamic

Where/Who the template is valid for.

Template. OrganizationUnit.Type

String

N/A

Dynamic

NO = Nasjonal

RHF = Region

HF = Helseforetak

LIN = Institusjon

LAV = Avdeling

LEN = Enhet

LBR = Bruker

Template. OrganizationUnit.Id

String

N/A

Dynamic

Id for type.

Used with LAV, LEN og LBR.

LAV = DeptNo

LEN = UnitNo

LBR = brukerid/f.nr

Template.ValidPeriod.From

DateTime

N/A

Dynamic

 

Template.ValidPeriod.To

DateTime

N/A

Dynamic

 

 

Schema for templates: DocumentWS.xsd

Schema documentation for templates: DocumentWS.html

 

 

Web Service Response and Request:

See http://imx-test.tehc.no/PasLink/DocumentWS/DocumentWS.asmx?op=ListTemplates

 

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 the Authentication web service.

 

In return from the method there will always be a ResponseHeader, which contains Error Information and System Information. The Error Information block must always be checked to determine whether any error has occurred while processing the methods.

1.1.3   GetTemplate

 

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

The method is used for getting a template by id.

 

ListTemplates can be used to find templates.

 

Syntax:

 

GetTemplateResponse = GetTemplate(GetTemplateRequest)

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

GetTemplateRequest

 

N/A

Dynamic

Request class according to XML schema in DocumentWS.xsd

Description:

 

 

 

TemplateId

 

 

Internal id for Template.

 

HIS90:

Combined id TemplateId.

Format: DeptNo|TypeOfId|LetterCode

TypeOfId must be ’LAV’

 

 

Returned parameter

Type

Length Byte

Description – Comments

GetTemplateResponse

 

N/A

Dynamic

Response class according to XML schema in DocumentWS.xsd

Description:

 

 

 

Template.TemplateId

String

N/A

Dynamic

Internal id for Template.

 

HIS90:

Format: DeptNo|TypeOfId|LetterCode

Template.Code

String

N/A

Dynamic

Letter/template/document code.

 

HIS90:

PAQLETT.CODE

Template.Description

String

N/A

Dynamic

 

Template.Organization­Unit

 

N/A

Dynamic

Where/Who the template is valid for.

Template. OrganizationUnit.Type

String

N/A

Dynamic

NAT = Nasjonal

REG = Region

HF = Helseforetak

LIN = Institusjon

LAV = Avdeling

LEN = Enhet

LBR = Bruker

Template. OrganizationUnit.Id

String

N/A

Dynamic

Id for type.

Used with LAV, LEN og LBR.

LAV = DeptNo

LEN = UnitNo

LBR = brukerid/f.nr

Template.ValidPeriod.From

DateTime

N/A

Dynamic

 

Template.ValidPeriod.To

DateTime

N/A

Dynamic

 

Template.TemplateText

AnyType

N/A

Dynamic

HIS90:

Brevteksten

 

 

Schema for GetTemplate: DocumentWS.xsd

Schema documentation for GetTemplate: DocumentWS.html

 

 

 

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/DocumentWS/DocumentWS.asmx?op=GetTemplate

 

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 the Authentication web service.

 

In return from the method there will always be a ResponseHeader, which contains Error Information and System Information. The Error Information block must always be checked to determine whether any error has occurred while processing the methods.

 

HIS90 specific information:

Server used for the method is CWLE01 and service PWS1203.

There is no restriction regarding user access for this method.

1.1.4   SaveTemplate

 

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

The method is used for saving or updating a template.

 

ListTemplates can be used to find valid templates.

 

Syntax:

 

SaveTemplateResponse = SaveTemplate(SaveTemplateRequest)

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

SaveTemplateRequest

 

N/A

Dynamic

Request class according to XML schema in DocumentWS.xsd

Description:

 

 

 

Template.TemplateId

String

N/A

Dynamic

Internal id for Template.

 

HIS90:

Combined id TemplateId

Format: DeptNo|TypeOfId|LetterCode

TypeOfId must be ’LAV’

Template.Code

String

N/A

Dynamic

Letter/template/document code.

 

HIS90:

PAQLETT.CODE

Template.Description

String

N/A

Dynamic

 

Template.Organization­Unit

 

N/A

Dynamic

Where/Who the template is valid for.

Template. OrganizationUnit.Type

String

N/A

Dynamic

NAT = Nasjonal

REG = Region

HF = Helseforetak

LIN = Institusjon

LAV = Avdeling

LEN = Enhet

LBR = Bruker

Template. OrganizationUnit.Id

String

N/A

Dynamic

Id for type.

Used with LAV, LEN og LBR.

LAV = DeptNo

LEN = UnitNo

LBR = brukerid/f.nr

Template.ValidPeriod.From

DateTime

N/A

Dynamic

 

Template.ValidPeriod.To

DateTime

N/A

Dynamic

 

Template.TemplateText

AnyType

N/A

Dynamic

 

HIS90:

Brevteksten

 

 

Returned parameter

Type

Length Byte

Description – Comments

SaveTemplateResponse

 

N/A

Dynamic

Response class according to XML schema in DocumentWS.xsd

Description:

 

 

 

Template.TemplateId

String

N/A

Dynamic

Internal id for Template.

 

HIS90:

Combined id TemplateId

Format: DeptNo|TypeOfId|LetterCode

Template.Code

String

N/A

Dynamic

Letter/template/document code.

 

HIS90:

PAQLETT.CODE

Template.Description

String

N/A

Dynamic

 

Template.Organization­Unit

 

N/A

Dynamic

Where/Who the template is valid for.

Template. OrganizationUnit.Type

String

N/A

Dynamic

NAT = Nasjonal

REG = Region

HF = Helseforetak

LIN = Institusjon

LAV = Avdeling

LEN = Enhet

LBR = Bruker

Template. OrganizationUnit.Id

String

N/A

Dynamic

Id for type.

Used with LAV, LEN og LBR.

LAV = DeptNo

LEN = UnitNo

LBR = brukerid/f.nr

Template.ValidPeriod.From

DateTime

N/A

Dynamic

 

Template.ValidPeriod.To

DateTime

N/A

Dynamic

 

Template.TemplateText

AnyType

N/A

Dynamic

 

HIS90:

Brevteksten

 

 

Schema for SaveTemplate: DocumentWS.xsd

Schema documentation for SaveTemplate: DocumentWS.html

 

 

 

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/DocumentWS/DocumentWS.asmx?op=SaveTemplate

 

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 the Authentication web service.

 

In return from the method there will always be a ResponseHeader, which contains Error Information and System Information. The Error Information block must always be checked to determine whether any error has occurred while processing the methods.

 

HIS90 specific information:

Server used for the method is CWLE01 and service PWS1204.

There is no restriction regarding user access for this method.

1.1.5   DeleteTemplate

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

Deletes a template by id. Use ListTemplates to get valid templates.

 

Syntax:

 

DeleteTemplateResponse = DeleteTemplate(DeleteTemplateRequest)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

DeleteTemplate­Request

 

N/A

Dynamic

Request class according to XML schema in DocumentWS.xsd

Description:

 

 

 

TemplateId

String

N/A

Dynamic

Internal id for Template.

 

HIS90:

Combined id TemplateId.

Format: DeptNo|TypeOfId|LetterCode

TypeOfId must be ’LAV’

 

Returned parameter

Type

Length Byte

Description – Comments

DeleteTemplate­­Request

 

N/A

Dynamic

Response class according to XML schema in DocumentWS.xsd

Description:

 

 

 

result

 

N/A

Dynamic

 

 

Schema for DeleteTemplate: DocumentWS.xsd

Schema documentation for DeleteTemplate: DocumentWS.html

 

 

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/DocumentWS/DocumentWS.asmx?op=DeleteTemplate

 

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 the Authentication web service.

 

In return from the method there will always be a ResponseHeader, which contains Error Information and System Information. The Error Information block must always be checked to determine whether any error has occurred while processing the methods.