1.1   DECISIONWS – DECISIONS

Version: 2.1.19073

 

The Web Service includes methods related to decisions (psychiatry).

 

The DecisionWS Web Service contains these methods:

 

 

The Web Service reference is: DecisionWS.asmx

Open in a Web Browser for more detailed information about each method.  The Web Service's WSDL, SOAP

 

For more detailed information as the Web Service's WSDL, SOAP request and response see:

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

 

1.1.1   ListPatientDecisions

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

Following method lists either all complaints, or one specific complaint, saved for one patient, contact or decision.

 

Syntax:

ListPatientDecisionsResponse = ListPatientDecisions(ListPatientDecisionsRequest)

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ContactId

String

 

ContactId for a Decision

HIS90: ContactId is not used.

PatientId

String

 

Patient’s id. List all decisions on this patient.

DecisionId

String

 

Combined id representing one single row in the decision table. 

 

HIS90:

Id contains PatientId | SerialNoDeci

DecisionCategory

String

 

Decision category.

List all decisions with a category. If omitted lists all categories.

Valid categories are: H, S and T

Valid categories can be retrieved under AdditionalCodes. AdditionalCode.Code from CommonCodesWS.ListCommonCodes (CommonCodeType = DecisionTypes).

DecisionType

String

 

Type of decision. List all decisions on this type.

 

Valid codes can be retrieved from CommonCodesWS.ListCommonCodes (CommonCodeType = DecisionTypes).

DecisionDate.From

String

 

List decisions valid from given date. If missing, the default date is 01.01.1980.

DecisionDate.To

String

 

List decisions valid to date. If missing, date is set to today.

StatusFilter

String/ Enum

 

Filter for slecectinge decisions with certain statuses.

Valid statuses are:

ALL – All

ACTIVE – Valid at request time(today/now)

DELETED – Deleted

OUTOFDATE – Previous items that has been valid but now is outdated.

If no filter is given(null or blank) then default is ACTIVE

Filter is excluded if excact DecisionId is given.

 

Returned parameter

Type

Length Byte

Description – Comments

PatientId

String

 

Patient’s id.

ContactId

String

 

ContactId for a Decision

HIS90: ContactId is not used.

DecisionId

String

 

Combined id representing one single row in the decision table.

 

HIS90:

Id contains PatientId | SerialNoDeci

DecisionIdParent

String

 

Combined id denoting which decisions this decision is associated with.

 

HIS90:

Id contains PatientId | SerialNoDeciDec.

DecisionGroup.Code

String

 

Decision group

E.g. RUS or PSYK

Valid codes can be found by using CommonCodesWS.ListCommonCodes setting CommonCodeType= DecisionGroup

DecisionGroup.Description

String

 

N/A

Type.Id

String

 

Id of type.

Type.Description

String

 

Description of type.

Category.Id

String

 

Decision category.
Valid categories are: H, S and T

Category.Description

String

 

Description of decision category.

Code

String

 

Decision code.

 

HIS90:

From PAQPACO.

Description

String

 

Description of decision code.

OID

String

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (KITH, HL7, DICOM).

Date

DateTime

 

Date when decision was made.

DateSpecified

Boolean

 

Flag indicating whether decision date is specified.

ValidToDate

DateTime

 

Date the decision is valid to.

HIS90: Not used.

ClosedDate

DateTime

 

Date and time when the decision/paragraph is closed.

RenewalDate

 

 

Date and time when decision has to be renewed, reconfirmed or reevaluated.

If ClosedDate is set then this date is historical.

EvaluationDate

 

 

Date and time when decision has to be evaluated/verified.

If ClosedDate is set then this date is historical.

CompulsoryCare

 

 

Checked/true if this decision has resulted in compulsory care (tvungent vern).

If false the no compulsory care. And if blank the compulsory care to decided.

ComplaintRegistered

 

 

If a complaint is registered for this decision.

 

If null/blank or NOTSET no complaint found or not  decided.

NO -no complaint registered

YES - a complaint has is registered and is in progress

 

In future this field can contain the outcome of the complaint in summary format.

Responsible.Resource.ResourceId

String

 

Responsible resource of decision.

Responsible.Resource.TypeOfId

String

 

Type of oid in ResourceId.

Valide values are: LOC

Responsible.Resource.Code

String

 

Id of responsible resource.

Responsible.Resource.Name

String

 

Name of responsible resource.

Responsible.Resource.Property

String

 

Property for resource.

HIS90: Not used.

Responsible.Resource.Organization.Id

String

 

Id of organization the resource belongs to.

Responsible.Resource.Organization.TypeOfId

String

 

Type of organization.

 

HIS90:

Set to “LAV” by web service.

Responsible.Resource.Organization.ShortNameId

String

 

Short name of organization.

 

HIS90:

Department code.

Responsible.Resource.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Responsible.Organization.Id

String

 

Id of unit responsible for the decision, i.e. the unit the resource belonged to when the decision was made.

Responsible.Organization.TypeOfId

String

 

Type of unit.

 

HIS90:

Set to “LAV” by web service.

Responsible.Organization.ShortNameId

String

 

Unit code.

Responsible.Organization.Name

String

 

Unit name.

ClosingResource.ResourceId

String

 

Resource responsible for closing the decision

ClosingResource.TypeOfId

String

 

Type of ResourceId

Valid values are: LOC

HIS90: Not used.

ClosingResource.Code

String

 

Code for closing resource

HIS90: Not used.

ClosingResource.Name

String

 

Name for closing resource

HIS90: Not used.

ClosingResource.Property

String

 

Property for closing resource

HIS90: Not used.

Tutor.HaveTutor

 

 

If patient have a tutor

True=Have tutor

False=Don't have tutor

Blank/Null = Not decided/Don't know

HIS90:

Mapping to HIS90:

True = J

False = N

Null/Blank = blank

Tutor.TutorName

 

 

Tutors name

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

If Status is missing/null this this is the same as ACTIVE

Registration.Date

DateTime

 

(Information on first registration of this decision instance.)

 

Date and time of first registration.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

Update.Date

String

 

(Information on updated/current decision instance.)

 

Date and time of updating.

Update.Organization.Id

String

 

Code of organization updating contact instance.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

Update.UpdateCount

Integer

 

Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact.

Set to blank/0 if new contact.

CriteriaRegistered

Boolean

 

Truthy if criteria is registered on the decision.

CriteriaCollection

Array

 

See ListCriteria response for definition of criteria elements.

 

Schema for ListPatientDecisions: DecisionWS.xsd

Schema documentation for ListPatientDecisions: DecisionWS.html

 

Web service Response and Request

See: https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=ListPatientDecisions

 

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.

 

HIS90-specific information:

Server used for the method is CWDE01. Service code is 54779. There are no access restrictions for using this method.

 


1.1.2SavePatientDecision

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

 

Description:

Following method registrates a new, or updates an existing decision.

 

Syntax:

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

PatientId

String

 

Patient’s id. Save a new decision on a patient.

ContactId

String

 

ContactId for a Decision

HIS90: ContactId is not used.

DecisionId

String

 

Combined id to update an existing decision.

Required when updating, in which case PatientId can be left out.

 

HIS90:

Id contains PatientId | SerialNoDeci.

DecisionIdPatient

String

 

Id of which decisions this decision is associated with. Not required.

 

HIS90:

Id contains PatientId | SerialNoDeciDec.

DecisionGroup.Code

String

 

Decision group

E.g. RUS or PSYK

Valid codes can be found by using CommonCodesWS.ListCommonCodes setting CommonCodeType= DecisionGroup

DecisionGroup.Description

String

 

N/A

Type.Id

String

 

Id denoting the type of decision. Required.

Examples of types: in paragraph, out paragraph etc.

Use CommonCodesWS.ListCommonCodes (CommonCodeType = DecisonTypes) to list available types.

Type.Description

String

 

Description of type.

Category.Id

String

 

Decision category.

Set to Category.Id together with Code blank to delete an existing decision.

Valid categories are: H, S and T

Valid categories can be retrieved together with Type from CommonCodesWS.ListCommonCodes (CommonCodeType = DecisionTypes).

Category.Description

String

 

Description of decision category.

Code

String

 

Decision code.

Set to Code together with Category.Id blank to delete an existing decision.

Use CommonCodesWS.ListCommonCodes (CommonCodeType = DecisonCodes) to list available codes.

OID

String

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (KITH, HL7, DICOM).

Description

String

 

Description of code. HIS90: Not used in Save.

Date

DateTime

 

Date and time when the decision was made.

ValidDate

DateTime

 

Date the decision is valid to.

HIS90: Not used.

ClosedDate

DateTime

 

Date and time when the decision/paragraph is closed.

 

HIS90:

Not updated by user/external application, as a decision is valid until a new decision is made. Set internally by PAS server.

Responsible.Resource.ResourceId

String

 

Combined id denoting resource responsible for the decision.

 

HIS90:

Id contains DeptNo | ResourceCode.

Responsible.Resource.TypeOfId

String

 

Type of oid in ResourceId.

Valide values are: LOC

Responsible.Resource.Code

String

 

Id of responsible resource.

HIS90: Not used in Save.

Responsible.Resource.Name

String

 

Name of responsible resource.

HIS90: Not used in Save.

Responsible.Resource.Property

String

 

Property for resource.

HIS90: Not used.

Responsible.Organization.Id

String

 

Id denoting organization responsible resource belonged to when the decision was made.

 

Use OrganizationWS.ListOrganizations/ ListOrganizations2G (Units in the resource’s department) or AuthorizationWS.GetUSerUnitAccess (Logged on user units).

Responsible.Organization.TypeOfId

String

 

Type of organization.

 

HIS90:

Must be set to “LAV”.

Responsible.Resource.Organization.ShortNameId

String

 

Short name of organization.

 

HIS90: Not used in Save.

Responsible.Resource.Organization.Name

String

 

Name of organization.

 

HIS90: Not used in Save.

Responsible.Organization.Id

String

 

Id of unit responsible for the decision, i.e. the unit the resource belonged to when the decision was made.

HIS90: Not used in Save.

Responsible.Organization.TypeOfId

String

 

Type of unit.

 

HIS90: Not used in Save.

Responsible.Organization.ShortNameId

String

 

Unit code.

HIS90: Not used in Save.

Responsible.Organization.Name

String

 

Unit name.

HIS90: Not used in Save.

ClosingResource.ResourceId

String

 

Resource responsible for closing the decision

ClosingResource.TypeOfId

String

 

Type of ResourceId

Valid values are: LOC

HIS90: Not used in Save.

ClosingResource.Code

String

 

Code for closing resource

HIS90: Not used in Save.

ClosingResource.Name

String

 

Name for closing resource

HIS90: Not used in Save.

ClosingResource.Property

String

 

Property for closing resource

HIS90: Not used in Save.

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

HIS90: Not used in request for Save

Registration.Date

DateTime

 

(Information on first registration of this decision instance.)

 

Date and time of first registration.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

 

HIS90:

Department id, extracted from ticket (op block) by PAS server program.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Date

String

 

(Information on updated/current decision instance.)

 

Date and time of updating.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Name

String

 

Name of person updating contact instance.

 

HIS90: N/A

Update.Organization.Id

String

 

Code of organization updating contact instance.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

 

 

Returned parameter

Type

Length Byte

Description – Comments

PatientId

String

 

Patient’s id.

ContactId

String

 

ContactId for a Decision

HIS90: ContactId is not used.

DecisionId

String

 

Combined id representing one single row in the decision table.

 

HIS90:

Id contains PatientId | SerialNoDeci

DecisionIdParent

String

 

Combined id denoting which decisions this decision is associated with.

 

HIS90:

Id contains PatientId | SerialNoDeciDec.

Type.Id

String

 

Id of type.

Type.Description

String

 

Description of type.

Category.Id

String

 

Decision category.
Valid categories are: H, S and T

Category.Description

String

 

Description of decision category.

Code

String

 

Decision code.

 

HIS90:

From PAQPACO.

Description

String

 

Description of decision code.

OID

String

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (KITH, HL7, DICOM).

Date

DateTime

 

Date when decision was made.

DateSpecified

Boolean

 

Flag indicating whether decision date is specified.

ValidToDate

DateTime

 

Date the decision is valid to.

HIS90: Not used.

ClosedDate

DateTime

 

Date and time when the decision/paragraph is closed.

RenewalDate

 

 

Date and time when decision has to be renewed, reconfirmed or reevaluated.

If ClosedDate is set then this date is historical.

EvaluationDate

 

 

Date and time when decision has to be evaluated/verified.

If ClosedDate is set then this date is historical.

CompulsoryCare

 

 

Checked/true if this decision has resulted in compulsory care (tvungent vern).

If false the no compulsory care. And if blank the compulsory care to decided.

ComplaintRegistered

 

 

If a complaint is registered for this decision.

 

If null/blank or NOTSET no complaint found or not  decided.

NO -no complaint registered

YES - a complaint has is registered and is in progress

 

In future this field can contain the outcome of the complaint in summary format.

Responsible.Resource.ResourceId

String

 

Responsible resource of decision.

Responsible.Resource.TypeOfId

String

 

Type of oid in ResourceId.

Valide values are: LOC

Responsible.Resource.Code

String

 

Id of responsible resource.

Responsible.Resource.Name

String

 

Name of responsible resource.

Responsible.Resource.Property

String

 

Property for resource.

HIS90: Not used.

Responsible.Resource.Organization.Id

String

 

Id of organization the resource belongs to.

Responsible.Resource.Organization.TypeOfId

String

 

Type of organization.

 

HIS90:

Set to “LAV” by web service.

Responsible.Resource.Organization.ShortNameId

String

 

Short name of organization.

 

HIS90:

Department code.

Responsible.Resource.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Responsible.Organization.Id

String

 

Id of unit responsible for the decision, i.e. the unit the resource belonged to when the decision was made.

Responsible.Organization.TypeOfId

String

 

Type of unit.

 

HIS90:

Set to “LAV” by web service.

Responsible.Organization.ShortNameId

String

 

Unit code.

Responsible.Organization.Name

String

 

Unit name.

ClosingResource.ResourceId

String

 

Resource responsible for closing the decision

ClosingResource.TypeOfId

String

 

Type of ResourceId

Valid values are: LOC

HIS90: Not used.

ClosingResource.Code

String

 

Code for closing resource

HIS90: Not used.

ClosingResource.Name

String

 

Name for closing resource

HIS90: Not used.

ClosingResource.Property

String

 

Property for closing resource

HIS90: Not used.

Tutor.HaveTutor

 

 

If patient have a tutor

True=Have tutor

False=Don't have tutor

Blank/Null = Not decided/Don't know

HIS90:

Mapping to HIS90:

True = J

False = N

Null/Blank = blank

Tutor.TutorName

 

 

Tutors name

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

If Status is missing/null this this is the same as ACTIVE

Registration.Date

DateTime

 

(Information on first registration of this decision instance.)

 

Date and time of first registration.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

Update.Date

String

 

(Information on updated/current decision instance.)

 

Date and time of updating.

Update.Organization.Id

String

 

Code of organization updating contact instance.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

Update.UpdateCount

Integer

 

Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact.

Set to blank/0 if new contact.

 

Schema for SavePatientDecision: DecisionWS.xsd

Schema documentation for SavePatientDecision: DecisionWS.html

 

Web service Response and Request

See: https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=SavePatientDecision

 

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.

 

HIS90-specific information:

Server used for the method is CWDE01. Service code is 54787. There are no access restrictions for using this method.

 


1.1.3   ListComplaints

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

The following method either lists all complaints, or gets a specific complaint, for one patient, contact or decision.

 

Syntax:

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ContactId

String

 

ContactId for a complaint.

HIS90: ContactId is not used.

DecisionId

String

 

Combined id for listing all complaints on a given decision.

 

HIS90:

Id contains PatientId | SerialNoDeci

 

PatientId – patient identification (integer)

SerialNoDeci – serial number of paragraph (integer)

 

Example:

21000720|1

ComplaintId

String

 

Combined id for getting a single complaint.

 

HIS90:

Id contains PatientId | SerialNoDeci | SerialNoCmpl

 

Example:

21000720|1|1

PatientId

String

 

Unique patient id, to list all complaints on this patient.

Use ListPatient or GetPatient to get patient ids.

StatusFilter

String/ Enum

 

Filter for slecectinge compalint with certain statuses.

Valid statuses are:

ALL – All

ACTIVE – Valid at request time(today/now)

DELETED – Deleted

OUTOFDATE – Previous items that has been valid but now is outdated.

If no filter is given(null or blank) then default is ACTIVE

Filter is excluded if excact ComplaintId is given.

 

Returned parameter

Type

Length Byte

Description – Comments

PatientId

String

 

Unique patient id.

ContactId

String

 

ContactId for a complaint.

HIS90: ContactId is not used.

DecisionId

String

 

Combined id representing one single row in the decision table.

 

HIS90:

Id contains PatientId | SerialNoDeci

 

PatientId – patient identification (integer)

SerialNoDeci – serial number of paragraph (integer)

 

Example:

21000720|1

ComplaintId

String

 

Combined id representing a single complaint instance.

 

HIS90:

Id contains PatientId | SerialNoDeci | SerialNoCmpl

 

Example:

21000720|1|1

Type.Id

String

 

Id of complaint type

Use CommonCodesWS.ListCommonCodes (CommonCodeType = ComplaintType) to list available codes.

Type.Description

String

 

Describes type of complaint. (Complaint type)

OID

String

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (KITH, HL7, DICOM).

Date

DateTime

 

Date and time of the complaint is specified

DateTimeSpecified

Boolean

 

Boolean value describing whether or not DateTime is specified. Valid values are true / false

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

If Status is missing/null this this is the same as ACTIVE

Registration.Date

DateTime

 

(Information on first registration of this complaint instance.)

 

Date and time of first registration.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

Update.Date

String

 

(Information on updated/current complaint instance.)

 

Date and time of updating.

Update.Organization.Id

String

 

Code of organization updating contact instance.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

Update.UpdateCount

Integer

 

Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact.

Set to blank/0 if new contact.

 

 

Schema for ListComplaints: DecisionWS.xsd

Schema documentation for ListComplaints: DecisionWS.html

 

Web service Response and Request

See: https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=ListComplaints

 

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.

 

HIS90-specific information:

Server used for the method is CWCM01. Service code is 54788. There are no access restrictions for using this method.

 


1.1.4   SaveComplaint

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

 

Description:

The following method saves, updates or deletes a complaint on a patient, contact or decision.

 

Syntax:

 

Parameter in

Type

Length byte

Description – Data format – Valid data

PatientId

String

 

Unique patient id, to save a new complaint on this patient.

Use ListPatient or GetPatient to get patient ids.

ContactId

String

 

ContactId for a complaint.

HIS90: ContactId is not used.

DecisionId

String

 

Combined id representing a single row in the decision table. Save a new complaint on a decision.

 

HIS90:

Id contains PatientId | SerialNoDeci

 

PatientId – patient identification (integer)

SerialNoDeci – serial number of paragraph (integer)

 

Example:

21000720|1

ComplaintId

String

 

Combined id representing a single row in the complaint table. Update an existing complaint.

 

HIS90:

Id contains PatientId | SerialNoDeci | SerialNoCmpl.

 

PatientId – patient identification (integer)

SerialNoDeci – serial number of paragraph (integer)
SerialNoCmpl – serial number of complaint

 

Example:

21000720|1|1

Type.id

String

 

Id of complaint type.

Use CommonCodesWS.ListCommonCodes (CommonCodeType = ComplaintType) to list available codes.

Type.Description

String

 

Describes type of complaint.

 

OID

String

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (KITH, HL7, DICOM).

Date

DateTime

 

Date and time of the complaint.

DateSpecified

Boolean

 

Boolean value describing whether or not datetime is specified. Valid values are true / false

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

HIS90: Not used in request for save.

Registration.Date

DateTime

 

(Information on first registration of this complaint instance.)

 

Date and time of first registration.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

 

HIS90:

Department id, extracted from ticket (op block) by PAS server program.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Date

String

 

(Information on updated/current complaint instance.)

 

Date and time of updating.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Name

String

 

Name of person updating contact instance.

 

HIS90: N/A

Update.Organization.Id

String

 

Code of organization updating contact instance.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.UpdateCount

Integer

 

Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact.

Set to blank/0 if new contact.

 

Returned parameter

Type

Length Byte

Description – Comments

PatientId

String

 

Unique patient id.

ContactId

String

 

ContactId for a complaint.

HIS90: ContactId is not used.

DecisionId

String

 

Combined id representing one single row in the decision table.

 

HIS90:

Id contains PatientId | SerialNoDeci

 

PatientId – patient identification (integer)

SerialNoDeci – serial number of paragraph (integer)

 

Example:

21000720|1

ComplaintId

String

 

Combined id representing a single complaint instance.

 

HIS90:

Id contains PatientId | SerialNoDeci | SerialNoCmpl

 

Example:

21000720|1|1

Type.Id

String

 

Id of complaint type

Type.Description

String

 

Describes type of complaint. (Complaint type)

Use CommonCodesWS.ListCommonCodes (CommonCodeType = ComplaintType) to list available codes.

OID

String

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (KITH, HL7, DICOM).

Date

DateTime

 

Date and time of the complaint is specified

DateTimeSpecified

Boolean

 

Boolean value describing whether or not DateTime is specified. Valid values are true / false

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

If Status is missing/null this this is the same as ACTIVE

Registration.Date

DateTime

 

(Information on first registration of this complaint instance.)

 

Date and time of first registration.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

Update.Date

String

 

(Information on updated/current complaint instance.)

 

Date and time of updating.

Update.Organization.Id

String

 

Code of organization updating contact instance.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

Update.UpdateCount

Integer

 

Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact.

Set to blank/0 if new contact.

 

Schema for SaveComplaint: DecisionWS.xsd

Schema documentation for SaveComplaint: DecisionWS.html

 

 

XSD schema for method

DecisionWS.xsd

 

Web service Response and Request

See: https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=SaveComplaint

 

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.

 

HIS90-specific information:

Server used for the method is CWCM01. Service code is 54804. There are no access restrictions for using this method.

 

 


1.1.5   ListCriteria

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

Depending on input, lists all criteria on a patient, or on a contact, or on a decision or a unique criteria instance.

 

Syntax:

ListCriteriaResponse ListCriteria(ListCriteriaRequest)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ListCriteriaRequest

 

N/A

Dynamic

Request class according to XML schema in DecisionWS.xsd.

Description:

 

 

 

 

 

 

One of PatientId, DecisionId or CriteriaId is mandatory.

ContactId

String

 

ContactId for a criteria.

HIS90: ContactId is not used.

DecisionId

string

 

Combined id to specify a unique criteria instance. Lists all criteria for specified decision (paragraph).

 

HIS90:

Id contains PatientId | SerialNoDeci

 

PatientId – patient identification (integer)

SerialNoDeci – serial number of paragraph (integer)

 

Example:

21000720|1

CriteriaId

string

 

Combined id to specify a unique criteria instance. Lists one criteria for specified decision and criteria.

 

HIS90:

Id contains PatientId | SerialNoDeci | SerialNoCrit

 

PatientId – patient identification (integer)

SerialNoDeci – serial number of paragraph (integer)

SerialNoCrit – serial number of criteria (integer)

 

Example:

21000720|2|1

PatientId

integer

 

Unique Patient id. Lists all criteria on a patient.

Patient id’s can be found by using PatientWS.ListPatients or PatientWS.GetPatient.

 

Example:

21000720

StatusFilter

String/ Enum

 

Filter for slecectinge critera with certain statuses.

Valid statuses are:

ALL – All

ACTIVE – Valid at request time(today/now)

DELETED – Deleted

OUTOFDATE – Previous items that has been valid but now is outdated.

If no filter is given(null or blank) then default is ACTIVE

Filter is excluded if excact CriteriaId is given.

 

Returned parameter

Type

Length Byte

Description – Comments

ListCriteriaResponse

 

N/A

Dynamic

Response class according to XML schema in DecisionWS.xsd.

Collection of criteria according to input values.

Description:

 

 

 

 PatientId

integer

 

Patient id

 ContactId

String

 

ContactId for a criteria.

HIS90: ContactId is not used.

 DecisionId

string

 

Combined id identifying the first returned criteria and decision, if any.

 

HIS90:

Id contains PatientId | SerialNoDeci

CriteriaId

string

 

Combined id identifying the first returned criteria, decision with criteria, if any.

 

HIS90:

Id contains PatientId | SerialNoDeci | SerialNoCrit

Type.Id

string

 

Criteria type id for this criteria instance.

Use CommonCodesWS.ListCommonCodes (CommonCodeType = CriteriaType) to list available codes.

Type.Description

string

 

Textual description of criteria type.

OID

string

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (HL7, DICOM).

 

HIS90: N/A

DateTime

DateTime

 

Date and time of when the criteria is valid.

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

If Status is missing/null this this is the same as ACTIVE

Registration.Date

DateTime

 

(Information on first registration of this criteria instance.)

 

Date and time of first registration.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

Update.Date

String

 

(Information on updated/current criteria instance.)

 

Date and time of updating.

Update.Organization.Id

String

 

Code of organization updating contact instance.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

Update.UpdateCount

Integer

 

Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact.

Set to blank/0 if new contact.

 

Schema for ListCriteria: DecisionWS.xsd

Schema documentation for ListCriteria: DecisionWS.html

 

 

Web service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=ListCriteria

 

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.

 

HIS90-specific information:

Server used for the method is CWCR01 and service PWS0880. There are no access restrictions for users using this method.

 


1.1.6   SaveCriteria

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

Depending on input, saves or updates a specific criteria on a patient, or on a contact, or on a decision or a unique criteria instance. Lists first criteria according to input in the response.

 

Tip for use:

When updating a criteria, first list it with the ListCriteria method.

 

Syntax:

SaveCriteriaResponse SaveCriteria(SaveCriteriaRequest)

 

Parameter in

Type

Length byte

Description – Data format – Valid data

SaveCriteriaRequest

 

N/A

Dynamic

Request class according to XML schema in DecisionWS.xsd.

Description:

 

 

 

 

 

 

One of PatientId, DecisionId or CriteriaId is mandatory.

PatientId

Integer

 

Unique patient id.

 

HIS90: N/A

DecisionId

String

 

Combined id identifying decision with which the criteria is associated. Required when creating a new criteria.

 

HIS90:

Id contains PatientId | SerialNoDeci

CriteriaId

String

 

Combined id to specify a unique criteria instance. Required when updating a critieria, in which case DecisionId is not used.

 

HIS90: Id contains PatientId | SerialNoDeci | SerialNoCrit

 

PatientId – patient identification (integer)

SerialNoDeci – serial number of paragraph (integer)

SerialNoCrit – serial number of criteria (integer)

 

Example:

21000720|1|2|1|2|1

Type.Id

String

 

Criteria type id for this criteria instance; CommonCodesWS.ListCommonCodes (CommonCodeType = CriteriaTypes) to list available codes. Required.

Type.Description

String

 

Criteria type description.

 

HIS90: N/A

OID

String

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (HL7, DICOM).

 

HIS90: N/A

DateTime

DateTime

 

Date and time of when the criteria is valid.

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

HIS90: Not used in request for save.

Registration.Date

DateTime

 

(Information on first registration of this criteria instance.)

 

Date and time of first registration.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

 

HIS90:

Department id, extracted from ticket (op block) by PAS server program.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Date

String

 

(Information on updated/current criteria instance.)

 

Date and time of updating.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Name

String

 

Name of person updating contact instance.

 

HIS90: N/A

Update.Organization.Id

String

 

Code of organization updating contact instance.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

 

HIS90:

Extracted from ticket (op block) by PAS server program.

 

Returned parameter

Type

Length Byte

Description – Comments

 

SaveCriteriaResponse

 

N/A

Dynamic

Response class according to XML schema in DecisionWS.xsd.

 

Description:

 

 

 

 PatientId

integer

 

Patient id

 ContactId

String

 

ContactId for a criteria.

HIS90: ContactId is not used.

 DecisionId

string

 

Combined id identifying the first returned criteria and decision, if any.

 

HIS90:

Id contains PatientId | SerialNoDeci

CriteriaId

string

 

Combined id identifying the first returned criteria, decision with criteria, if any.

 

HIS90:

Id contains PatientId | SerialNoDeci | SerialNoCrit

Type.Id

string

 

Criteria type id for this criteria instance.

Use CommonCodesWS.ListCommonCodes (CommonCodeType = CriteriaType) to list available codes.

Type.Description

string

 

Textual description of criteria type.

OID

string

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (HL7, DICOM).

 

HIS90: N/A

DateTime

DateTime

 

Date and time of when the criteria is valid.

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the querytime.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

If Status is missing/null this this is the same as ACTIVE

Registration.Date

DateTime

 

(Information on first registration of this criteria instance.)

 

Date and time of first registration.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

Update.Date

String

 

(Information on updated/current criteria instance.)

 

Date and time of updating.

Update.Organization.Id

String

 

Code of organization updating contact instance.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

Update.UpdateCount

Integer

 

Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact.

Set to blank/0 if new contact.

 

Schema for SaveCriteria: DecisionWS.xsd

Schema documentation for SaveCriteria: DecisionWS.html

 

Web service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=SaveCriteria

 

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.

 

HIS90-specific information:

Server used for the method is CWCR01. Service code for the method is 54812. There are no access restrictions for users using this method.

 

1.1.7   ListDecisionsByOrg

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

Following method lists decisions for as resource or responsible medical/care unit or follow up medical/care units.

 

Syntax:

ListDecisionsByOrgResponse = ListDecisionsByOrg(ListDecisionsByOrgRequest)

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

ResponsibleResource.ResourceId

String

 

Id to resource responsible for the decision.

One of these combinations must be used in request:

·         ResponsibleResource.ResourceId

·         ResponsibleUnit.MedicalUnit.Id/ ResponsibleUnit.CareUnit.Id or

·         ResponsibleFollowUpUnit.MedicalUnit.Id/ ResponsibleFollowUpUnit.CareUnit.Id

ResponsibleResource.TypeOfId

String

 

Type of Id above.

LRC is only valid value.

ResponsibleResource.Code

String

 

Not used in request, only for response.

ResponsibleResource.Name

String

 

Not used in request, only for response.

ResponsibleResource.Property

String

 

Not used in request, only for response.

ResponsibleUnit.MedicalUnit.Id

String

 

Medical unit responsible for the decision.

One of these combinations must be used in request:

·         ResponsibleResource.ResourceId

·         ResponsibleUnit.MedicalUnit.Id/ ResponsibleUnit.CareUnit.Id or

·         ResponsibleFollowUpUnit.MedicalUnit.Id/ ResponsibleFollowUpUnit.CareUnit.Id

ResponsibleUnit.MedicalUnit.TypeOfId

String

 

Type of Id above.

LAV is only valid value.

ResponsibleUnit.MedicalUnit.ShortNameId

String

 

Not used in request, only for response.

ResponsibleUnit.MedicalUnit.Name

String

 

Not used in request, only for response.

ResponsibleUnit.CareUnit.Id

String

 

Care unit responsible for the decision.

One of these combinations must be used in request:

·         ResponsibleResource.ResourceId

·         ResponsibleUnit.MedicalUnit.Id/ ResponsibleUnit.CareUnit.Id or

·         ResponsibleFollowUpUnit.MedicalUnit.Id/ ResponsibleFollowUpUnit.CareUnit.Id

ResponsibleUnit.CareUnit.TypeOfId

String

 

Type of Id above.

LEN is only valid value.

ResponsibleUnit.CareUnit.ShortNameId

String

 

Not used in request, only for response.

ResponsibleUnit.CareUnit.Name

String

 

Not used in request, only for response.

ResponsibleFollowUpUnit.MedicalUnit.Id

String

 

Medical unit responsible for follow up the decision.

One of these combinations must be used in request:

·         ResponsibleResource.ResourceId

·         ResponsibleUnit.MedicalUnit.Id/ ResponsibleUnit.CareUnit.Id or

·         ResponsibleFollowUpUnit.MedicalUnit.Id/ ResponsibleFollowUpUnit.CareUnit.Id

ResponsibleFollowUpUnit.MedicalUnit.TypeOfId

String

 

Type of Id above.

LAV is only valid value.

ResponsibleFollowUpUnit.MedicalUnit.ShortNameId

String

 

Not used in request, only for response.

ResponsibleFollowUpUnit.MedicalUnit.Name

String

 

Not used in request, only for response.

ResponsibleFollowUpUnit.CareUnit.Id

String

 

Care unit responsible for follow up the decision.

One of these combinations must be used in request:

·         ResponsibleResource.ResourceId

·         ResponsibleUnit.MedicalUnit.Id/ ResponsibleUnit.CareUnit.Id or

·         ResponsibleFollowUpUnit.MedicalUnit.Id/ ResponsibleFollowUpUnit.CareUnit.Id

ResponsibleFollowUpUnit.CareUnit.TypeOfId

String

 

Type of Id above.

LEN is only valid value.

ResponsibleFollowUpUnit.CareUnit.ShortNameId

String

 

Not used in request, only for response.

ResponsibleFollowUpUnit.CareUnit.Name

String

 

Not used in request, only for response.

DecisionDates.From

String

 

List decisions valid from given date. If missing, the default date is 01.01.1980.

DecisionDates.To

String

 

List decisions valid to date. If missing, date is set to today.

Type.Id

String

 

Type of decision. List all decisions on this type.

Set to null/blank to list all types of decisions.

Valid codes can be retrieved from CommonCodesWS.ListCommonCodes (CommonCodeType = DecisionTypes).

Registration.From

DateTime

 

Search on registration date from

Registration.To

DateTime

 

Search on registration date to

Registration.Unit.Id

String

 

Medical unit who registred the decision.

Registration.Unit.TypeOfId

String

 

Type of Id above.

LAV is only valid value.

Registration.Unit.ShortNameId

String

 

Not used in request, only for response.

Registration.Unit.Name

String

 

Not used in request, only for response.

 

Returned parameter

Type

Length Byte

Description – Comments

PatientId

String

 

Patient’s id.

ContactId

String

 

ContactId for a Decision

HIS90: ContactId is not used.

DecisionId

String

 

Combined id representing one single row in the decision table.

 

HIS90:

Id contains PatientId | SerialNoDeci

DecisionIdParent

String

 

Combined id denoting which decisions this decision is associated with.

 

HIS90:

Id contains PatientId | SerialNoDeciDec.

DecisionGroup.Code

String

 

Decision group

E.g. RUS or PSYK

Valid codes can be found by using CommonCodesWS.ListCommonCodes setting CommonCodeType= DecisionGroup

DecisionGroup.Description

String

 

N/A

Type.Id

String

 

Id of type.

Type.Description

String

 

Description of type.

Category.Id

String

 

Decision category.
Valid categories are: H, S and T

Category.Description

String

 

Description of decision category.

Code

String

 

Decision code.

 

HIS90:

From PAQPACO.

Description

String

 

Description of decision code.

OID

String

 

Globally unique identifier for individual information objects and references to code systems and data element dictionaries (KITH, HL7, DICOM).

Date

DateTime

 

Date when decision was made.

DateSpecified

Boolean

 

Flag indicating whether decision date is specified.

ValidToDate

DateTime

 

Date the decision is valid to.

HIS90: Not used.

ClosedDate

DateTime

 

Date and time when the decision/paragraph is closed.

RenewalDate

 

 

Date and time when decision has to be renewed, reconfirmed or reevaluated.

If ClosedDate is set then this date is historical.

EvaluationDate

 

 

Date and time when decision has to be evaluated/verified.

If ClosedDate is set then this date is historical.

CompulsoryCare

 

 

Checked/true if this decision has resulted in compulsory care (tvungent vern).

If false the no compulsory care. And if blank the compulsory care to decided.

ComplaintRegistered

 

 

If a complaint is registered for this decision.

 

If null/blank or NOTSET no complaint found or not  decided.

NO -no complaint registered

YES - a complaint has is registered and is in progress

 

In future this field can contain the outcome of the complaint in summary format.

Responsible.Resource.ResourceId

String

 

Responsible resource of decision.

Responsible.Resource.TypeOfId

String

 

Type of oid in ResourceId.

Valid values are: LOC

Responsible.Resource.Code

String

 

Id of responsible resource.

Responsible.Resource.Name

String

 

Name of responsible resource.

Responsible.Resource.Property

String

 

Property for resource.

HIS90: Not used.

Responsible.Resource.Organization.Id

String

 

Id of organization the resource belongs to.

Responsible.Resource.Organization.TypeOfId

String

 

Type of organization.

 

HIS90:

Set to “LAV” by web service.

Responsible.Resource.Organization.ShortNameId

String

 

Short name of organization.

 

HIS90:

Department code.

Responsible.Resource.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Responsible.Organization.Id

String

 

Id of unit responsible for the decision, i.e. the unit the resource belonged to when the decision was made.

Responsible.Organization.TypeOfId

String

 

Type of unit.

 

HIS90:

Set to “LAV” by web service.

Responsible.Organization.ShortNameId

String

 

Unit code.

Responsible.Organization.Name

String

 

Unit name.

ClosingResource.ResourceId

String

 

Resource responsible for closing the decision

ClosingResource.TypeOfId

String

 

Type of ResourceId

Valid values are: LOC

HIS90: Not used.

ClosingResource.Code

String

 

Code for closing resource

HIS90: Not used.

ClosingResource.Name

String

 

Name for closing resource

HIS90: Not used.

ClosingResource.Property

String

 

Property for closing resource

HIS90: Not used.

Tutor.HaveTutor

 

 

If patient have a tutor

True=Have tutor

False=Don't have tutor

Blank/Null = Not decided/Don't know

HIS90:

Mapping to HIS90:

True = J

False = N

Null/Blank = blank

Tutor.TutorName

 

 

Tutors name

Status

Enum

 

Status for the item/data.

Valid values are:

ACTIVE – Active/Valid data at the query time.

DELETED – Data is deleted

OUTOFDATE – Data is out of date at the query time.

 

If Status is missing/null this this is the same as ACTIVE

Registration.Date

DateTime

 

(Information on first registration of this decision instance.)

 

Date and time of first registration.

Registration.Name

String

 

Name of person responsible for registration of the row.

 

HIS90: N/A

Registration.Organization.Id

String

 

Code of organization that first registered this contact.

Registration.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Registration.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Registration.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Registration.SignedBy

String

 

Initials of person who originally created this contact.

Update.Date

String

 

(Information on updated/current decision instance.)

 

Date and time of updating.

Update.Organization.Id

String

 

Code of organization updating contact instance.

Update.Organization.TypeOfId

String

 

Type of organization id.

 

Valid values:

Empty/LOC = Unknown/local id in PAS

LIN = Local institution id

LAV = Local medical unit/department id

LEN = Local care unit id

LUI = Local unique id

HER = HER id

 

HIS90:

Set to “LAV” by web service.

Update.Organization.ShortNameId

String

 

Short name/code of organization.

 

HIS90:

Department code.

Update.Organization.Name

String

 

Name of organization.

 

HIS90:

Department name.

Update.SignedBy

String

 

Initials of person updating contact instance.

Update.UpdateCount

Integer

 

Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact.

Set to blank/0 if new contact.

Patient.PatientId

 

 

Internal patient id for the HIS

Patient.FormattedName

 

 

The person's names formatted in one string according to national rules.

Patient.BirthDate

 

 

Birthdate including century

Patient.Dead.DeathDate

 

 

Only set with death date if patient is dead. Else null/missing

Patient.Sex.Code

 

 

Patient’s sex. Internal code in PAS.

HIS90:

M = male, K = female, U=Unknown

Patient.Sex.OfficialCode

 

 

Patient’s sex. Official values.

1=Male, 2=Female, 9=Unknown

Patient.Sex.Text

 

 

Description of patients sex

Patient.Municipality.Code

 

 

Municipality code the patient belongs to.

HIS90:

Economic Municipality

Patient.Municipality.Name

 

 

Municipality name the patient belongs to.

 

Patient.PostalAddress.Code

 

 

Postal code/address for the patient.

Patient.PostalAddress.Name

 

 

Postal code/address for the patient.

Patient.Telecom.MobilePhoneNumber

 

 

Patient mobile telephone number, only if set. Else null/blank.

Patient.Telecom.MobilePhoneReservation

 

 

If patients has reserved for use if his/hers mobile telephone number.

True = Mobile telephone use is reserved

False/Null/Blank = No reservation

Patient.OfficialId.Value

 

 

Patient official value.

The value of the official id as it is stored in the database, ie. the Norwegian number 01013356789.

Patient.OfficialId.TypeOfId

 

 

Type of official id given.

F = official id, N = Emergency number, K = Catastrophe number, U = Non-human number

Patient.OfficialId.FormattedId

 

 

The official id formatted to be used for viewing the number, ie. the Norwegian number 010133 56789.

CriteriaRegistered

Boolean

 

Truthy if criteria is registered on the decision.

CriteriaCollection

Array

 

See ListCriteria response for definition of criteria elements.

 

Schema for ListDecisionsByOrg: DecisionWS.xsd

Schema documentation for ListDecisionsByOrg: DecisionWS.html

 

Web service Response and Request

See: https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=ListDecisionsByOrg

 

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.

 

HIS90-specific information:

Server used for the method is CWDE01. Service code is 54779. There are no access restrictions for using this method.

 

1.1.8   ListDecisionExecutions

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

Following method lists executions on a decisions or a patient, or gets a specific DecisionExecutions.

 

Syntax:

ListDecisionExecutionsResponse = ListDecisionExecutions(ListDecisionExecutionsRequest)

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

See XSD schema or schema documentation below for request into WS method

 

 

 

 

 

Returned parameter

Type

Length Byte

Description – Comments

See XSD schema or schema documentation below for response from WS method

 

 

 

 

 

Schema for ListDecisionExecutions: DecisionWS.xsd

Schema documentation for ListDecisionExecutions: DecisionWS.html

 

Web service Response and Request

See: https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=ListDecisionExecutions

 

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.

 

HIS90-specific information:

Server used for the method is CWDE03

There are no access restrictions for using this method.

 

1.1.9   SaveDecisionExecution

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

The method inserst or updates a execution on a given decision.

 

Syntax:

SaveDecisionExecutionResponse = SaveDecisionExecution(SaveDecisionExecutionRequest)

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

See XSD schema or schema documentation below for request into WS method

 

 

 

 

 

Returned parameter

Type

Length Byte

Description – Comments

See XSD schema or schema documentation below for response from WS method

 

 

 

 

 

Schema for SaveDecisionExecution: DecisionWS.xsd

Schema documentation for SaveDecisionExecution: DecisionWS.html

 

Web service Response and Request

See: https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=SaveDecisionExecution

 

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.

 

HIS90-specific information:

Server used for the method is CWDE04

There are no access restrictions for using this method.

 

1.1.10               DeleteDecisionExecution

Applicable systems for method:

HIS90

 

 

 

 

 

 

 

Description:

The method delete a specific execution on a decision.

 

Syntax:

DeleteDecisionExecutionResponse = DeleteDecisionExecution(DeleteDecisionExecutionRequest)

 

 

Parameter in

Type

Length byte

Description – Data format – Valid data

See XSD schema or schema documentation below for request into WS method

 

 

 

 

 

Returned parameter

Type

Length Byte

Description – Comments

See XSD schema or schema documentation below for response from WS method

 

 

 

 

 

Schema for DeleteDecisionExecution: DecisionWS.xsd

Schema documentation for DeleteDecisionExecution: DecisionWS.html

 

Web service Response and Request

See: https://linkws.service.tieto.com/PasLinkWS/DecisionWS/DecisionWS.asmx?op=DeleteDecisionExecution

 

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.

 

HIS90-specific information:

Server used for the method is CWDE04

There are no access restrictions for using this method.