Version: 2.1.19073
CommonCodesWS
contains a set of methods to retrieve and save information from/in code tables.
All methods
require a correct and verified authentication block from AuthenticationWS to
get/update any information from/in the HIS. System codes are described in
INFOMEDIX SysAdm.
The
CommonCodesWS Web Service contains these methods:
The Web Service reference is: CommonCodesWS.asmx
For more
detailed information as the web service WSDL, SOAP request and response see:
https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx
Applicable
systems for method:
|
INFOMEDIX |
|
|
|
|
|
|
Description:
Lists
system codes. The codes are listed according to a type.
Syntax:
SystemCodes = ListSystemCodes(Type1,
Type2, SubType, Code, Reference1, Reference2, Rule1, Rule2, ValidDate,
OrganizationUnitId, InstitutionId)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
Type1 |
String |
|
Type
of systemcode. (System codes are described in INFOMEDIX SysAdm) Two
types of the systemcode can be specified (Type1/Type2) |
|
Type2 |
String |
|
Type
of systemcode |
|
SubType |
String |
|
Subtype
of systemcode |
|
Code |
String |
|
Systemcode |
|
Reference1 |
String |
|
Systemcode
reference 1 |
|
Reference2 |
String |
|
Systemcode
reference 2 |
|
Rule1 |
String |
|
Systemcode
rule1 |
|
Rule2 |
String |
|
Systemcode
rule2 |
|
ValidDate |
DateTime |
N/A Dynamic |
Valid
date for systemcode |
|
OrganizationId |
Number |
4 bytes |
=
0 if all systemcodes shall be listed. =
An internal organizationid if only systemcodes for this organization unit shall be listed. This
parameter will not be used if InstitutionId is not null or 0. |
|
InstitutionId |
Number |
4 bytes |
=
An internal organizationid if all global systemcodes and all systemcodes for
organizations belonging to the specified Institution shall be listed. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
SystemCodes |
Datastructure according to SystemCode.xsd scheme |
N/A Dynamic |
A
collection of SystemCode. The
data structure is dynamic and can return from 0 to undetermined number of
records with MyClass. |
Definition
of the data structure SystemCodes for getting information from ListSystemCodes
|
Name |
Type |
Length Byte |
Description
– Comments |
|
SystemCode* xxx |
SystemCode; the structure below is repeated xxx times. where xxx is valid from 0 to
endless/undetermined |
||
|
|
|
|
See
SystemCode.xsd scheme |
Schema for SystemCode: SystemCode.xsd
Schema
documentation for SystemCode: SystemCode.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListSystemCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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 ResponseHeader
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.
Applicable
systems for method:
|
INFOMEDIX |
HIS-90 |
|
|
|
|
|
Description:
Lists
medical codes for a given medical register. Search can be done by giving the
code, part of the code or part of the text.
Syntax:
MedicalCodes = ListMedicalCodes(RegisterId,
MedicalCode, SearchString1, SearchString2, ValidDate)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
RegisterId |
Number |
4 byte Integer |
Internal register id. |
|
MedicalCode |
String |
|
Medical
code, either complete code or first part of the code. E.g. A04 will give all
code starting with A04 HIS90: The
search is case sensitive. Maximum 10 characters can be used. |
|
SearchString1 |
String |
|
Search on the medical code description if
description contain the search string. HIS90: The
search is case sensitive. Maximum 10 characters can be used. If both SearchString1 and SearchString2 is used this
is an AND logikk, description must contain bothe SearchString1 and
SearchString2 |
|
SearchString2 |
String |
|
Search on the medical code description if
description contain the search string. HIS90: The
search is case sensitive. Maximum 10 characters can be used. If both SearchString1 and SearchString2 is used this
is an AND logikk, description must contain bothe SearchString1 and
SearchString2 |
|
ValidDate |
DateTime |
N/A Dynamic |
Valid
date for a medical code, if blank/null/omitted the now/current date/time will
be used in the search (E.g. only codes valid now). |
|
SearchAxxis |
String |
|
Search on the axis the medicla code is active on. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
MedicalCodes |
Datastructure according to MedicalCode.xsd scheme |
N/A Dynamic |
A
collection of MedicalCode. The
data structure is dynamic and can return from 0 to undetermined number of
records with MedicalCode. |
Schema for MedicalCode: MedicalCode.xsd
Schema
documentation for MedicalCode: MedicalCode.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListMedicalCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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 ResponseHeader
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.
Applicable
systems for method:
|
INFOMEDIX |
|
|
|
|
|
|
Description:
Lists rules
used for given medical code.
Syntax:
MedicalCodeRules= ListMedicalCodeRules(MedicalCodeId)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
MedicalCodeId |
Number |
4 byte Integer |
Internal medicalcodeid. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
MedicalCodeRules |
Datastructure according to MedicalCodeRule.xsd scheme |
N/A Dynamic |
A
collection of MedicalCodeRule. The
data structure is dynamic and can return from 0 to undetermined number of
records with MedicalCodeRule. |
Schema for MedicalCodeRule: MedicalCodeRule.xsd
Schema
documentation for MedicalCodeRule:
MedicalCodeRule.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListMedicalCodeRules
Related
methods or functions used:
GetUserLogin Used
to verify user and 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 ResponseHeader
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.
Applicable
systems for method:
|
INFOMEDIX |
HIS-90 |
|
|
|
|
|
Description:
Lists
medical registers. Medical registers are grouped together in registers for
diagnosis, for procedures etc. All registers can be listed. Medical register
ex: ICD10, NCSP
Syntax:
MedicalRegisters= ListMedicalRegisters(RegisterType,
RegisterCode, OrganizationUnitId, ValidDate)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
RegisterType |
String |
|
|
|
RegisterCode |
String |
|
|
|
OrganizationUnitId |
Number |
4 byte Integer |
|
|
ValidDate |
DateTime |
N/A Dynamic |
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
MedicalRegisters |
Datastructure according to MedicalRegister.xsd scheme |
N/A Dynamic |
A
collection of MedicalRegister. The
data structure is dynamic and can return from 0 to undetermined number of
records with MedicalRegister. |
Schema for MedicalRegister: MedicalRegister.xsd
Schema
documentation for MedicalRegister:
MedicalRegister.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListMedicalRegisters
Related
methods or functions used:
GetUserLogin Used
to verify user and 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 ResponseHeader
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.
Applicable
systems for method:
|
INFOMEDIX |
|
|
|
|
|
|
Description:
Lists roles
used for authentication.
Syntax:
Roles= ListRoles(Role)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
Role |
String |
|
Rolename |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
Roles |
Datastructure according to Role.xsd scheme |
N/A Dynamic |
A
collection of Role. The
data structure is dynamic and can return from 0 to undetermined number of
records with Role. |
Schema for Role: Role.xsd
Schema
documentation for Role: Role.html
Sample xml
file for Role: Role.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListRoles
Related
methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists
municipality codes.
Syntax:
MunicipalityCodes
= ListMunicipalityCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListMunicipalityCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists
nationality codes.
Syntax:
NationalityCodes
= ListNationalityCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
|
|
|
|
|
Schema
documentation for CommonCodes: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListNationalityCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists post
codes.
Syntax:
PostCodes= ListPostCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
PostCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of PostCodeType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
|
|
|
|
|
Schema
documentation for PostCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListPostCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists language
codes.
Syntax:
LanguageCodes = ListLanguageCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListLanguageCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists
letter codes.
Syntax:
LetterCodes = ListLetterCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListLetterCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists VDGR
codes.
Syntax:
VDGRCodes = ListVDGRCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
VDGRCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of VDGRType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for VDGRCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListVDGRCodes
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists VHDG
codes.
Syntax:
VHDGCodes = ListVHDGCodes ()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListVHDGCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists
priority codes.
Syntax:
PriorityCodes = ListPriorityCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListPriorityCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists
cancel reason codes.
Syntax:
CancelReasonCodes = ListCancelReasonCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListCancelReasonCodes
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists
clinical area group codes.
Syntax:
ClinicalAreaGroupCodes = ListClinicalAreaGroupCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists Free
codes.
Syntax:
FreeCodes = ListFreeCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListFreeCodes
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists cach
codes.
Syntax:
CashCodes = ListCashCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListCashCodes
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists
payment method codes.
Syntax:
PaymentMethodCodes = ListPaymentMethodCodes ()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists
refound codes.
Syntax:
RefoundCodes = ListRefoundCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListRefundCodes
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists all
requester codes with the name for the requester.
Syntax:
RefoundCodes = ListReqrCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListReqrCodes
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
List all
admit codes and the description for the code.
Syntax:
RefoundCodes = ListAdmitCodes()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema documentation
for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListAdmitCodes
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Lists all
rates codes and descriptions.
Syntax:
RefoundCodes = ListRates()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
|
|
|
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
CommonCodeCollection |
Datastructure according to commoncodes.xsd scheme |
N/A Dynamic |
A
collection of CodeTextType. The
data structure is dynamic and can return from 0 to undetermined number of
records with CodeTextType. |
Schema
documentation for CommonCodeCollection: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListRates
Related methods or functions used:
GetUserLogin Used
to verify user and 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.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
The method
gets information about selected service. The information includes listing off
associated rates for selected service.
Syntax:
GetServiceCodeResponse =
GetGetServiceCode(GetServiceCodeRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
GetServiceCodeRequest: |
Structure that includes following: |
|
|
|
ServiceType |
string |
HIS90: 1 |
Type of service. HIS90: Part of primary key. PAQSECO.SERV_TYPE |
|
ServiceCode |
string |
HIS90: 10 |
Service. HIS90: Part of primary key. PAQSECO.SERV_CODE |
|
Date |
DateTime |
|
Querydate defaulted to current date if no
other date is in input. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
GetServiceCodeResponse |
Structure that includes following: |
|
|
|
ServiceType |
string |
HIS90: 1 |
Type of service. HIS90: Part of primary key. PAQSECO.SERV_TYPE |
|
ServiceCode |
string |
HIS90: 10 |
Service. HIS90: Part of primary key. PAQSECO.SERV_CODE |
|
Occurs: |
|
|
HIS90: Occurs are maximized to 10 occurs |
|
ServiceInformation.ServiceGroupCode |
string |
HIS90:4 |
Service group code. HIS90: Valid codes can be
found in PAQSEQR. Service group code is used for grouping services into
service groups. PAQSECO.SERV_GROUP_CODE |
|
ServiceInformation.Description |
string |
HIS90: 80 |
Service and rate description. HIS90: PAQSECO.SERV_DESC |
|
ServiceInformation.RateCode |
string |
HIS90: 5 |
Rate. HIS90: Rate code associated to service.
A service is or can be created using multible rates. Valid rate codes can be
found in PAQRTVA. |
|
ServiceInformation.Periode.FromDate |
TimeDate |
HIS90: 8 |
From date for service/rate valid periode.
HIS90: PAQSECO.FROM_DATE |
|
ServiceInformation.Periode.ToDate |
TimeDate |
HIS90: 8 |
To date for service/rate valid periode.
HIS90: Part of primary key. PAQSECO.TO_DATE |
Schema
documentation for CommonCodes: CommonCodes.html
Sample xml
file for GetServiceCodeRequest: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=GetServiceCode
Related methods or functions used:
GetUserLogin Used
to verify user and 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:
This is a
working version of the method and it is assumed that the method will be
modified future.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Method for
listing common codes used in PasLink web service methods.
The method
provides several common code types.
Syntax:
ListCommonCodesResponse = ListCommonCodes(ListCommonCodesRequest)
Request:
|
Parameter
in ListCommonCodesRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
CommonCodeTypes.CommonCodeType |
|
|
Type of codes codes which can be requested. See parameter table for more details
about avlid common code type, usage and valid values. Valid common code types are: RequesterCode AdmitCode Rate MunicipalityCode NationalityCode PostCode LanguageCode LetterCode VDGRCode VHDGCode PriorityCode CancelReasonCode ClinicalAreaGroupCode FreeCode CashCode PaymentMethodCode RefundCode MaritialCode UrbanNeighbourhoodCode ContactAdmittedFromCode EECDocumentationCode ContactGategoryCode ContactGroupCode ContactDischargeCode ContactFinishedCode TransportationCode ContactAdmittedToCode ContactDischargedToCode ContactMeasurementCode ContactParticipantCode ContactTreaterType ContactTreatmentCode DecisionCode DecisionType ComplaintType ComplainResultType CriteriaType PatientAdditionalInformationCode PatientAdditionalInformationType WaitingListStatusCode WaitingListGuaranteeCode CarePeriodStatusCode ContactAccidentCode ContactStatusCode AppointmentType TypeOfCareCode MetaInformationCode OrganizationTypeCode MessageTypeCode DocumentPhrases SystemPrintersCode PatientLeaveCode CareTypeCodes IndividualPlanRoleCodes IndividualPlanStatusCodes EvaluationPriorityCode GenericCodeSets GenericCodeValues AdmSex AdmYesNo AdmYesNoUnknown DrugOpioid DrugLivingConditions DrugSyringeUse DrugSyringeFrequency DrugSyringeNeedleSharing DrugMentalHealth DrugFrequencyOfUse DrugType DrugIngestionMethod DrugLivesWith DrugLivingChildrenU18 DrugAgeChildrenU18 DrugBloodVirusTested DrugBloodVirusType DrugFollowUp DrugTreatmentEnding DecisionGroup DrugIngestionMethod DrugLivesWith DrugLivingChildrenU18 DrugAgeChildrenU18 DrugBloodVirusTested DrugBloodVirusType DrugFollowUp DrugTreatmentEnding DecisionGroup UpdatableCommonCodes AdmTreatmentTime PatientClassificationCode HelfoNotificationStatus PsychosocialAspects PsychosocialFunctionLevel PsychosocialFunctionType WaitTimeEndCode ReferralReasonChildCond ReferralReasonChildEnv ChildWelfareRole CarePeriodInfoGroupCodes PatientRelationRole CareLivingSituation PatientTranslatorNeed EPRInfoTransferConsent PatientLivingWithPartner PatientEthnicAffiliation PatientCaregiverRelations AddressPostalTypes AddressTelephoneTypes AddressEmailTypes AddressLineTypes ContactAdditionalInfoType CollInstanceServiceTypes RoomAttributeTypes CarePeriodResourceType WaitingListAdditionalInfoType DocumentLanguageCodes ContactActivityTypeCodes |
|
Code |
String |
|
Code used in search If Code is blank or null then all codes are
listed. |
|
Types.Types.Type |
String |
|
Type of codes to search for(filtering all
codes for on Type), only used when Code is not blank/null. If Type is blank or null then all codes for
alle types are listed. See parameter table for more details
about usage and valid values. |
|
Types.Types.TypeOfType |
String |
|
Type description of Type above See parameter table for more details
about usage and valid values. |
|
Valid.Valid.AllCodes |
Boolean |
|
If true list all codes, if false list only
valid codes (at time of request) Default if not specificed is True, listing
all valid codes |
|
Valid.Valid.AllCodesSpecified |
Boolean |
|
Boolean value describing if Valid.Valid.AllCodes
above is specified |
|
InvalidateCache |
Boolean |
|
Flag to invalidate/clear the cache in the
method. Only to be used with admin functions to
update the common codes by Tieto. Never to be used or set by any other
developers than Tieto. Null/missing or False - Keep cache/do nothing True - Invalidate/clear cache |
Example of
returned parameters in ListCommonCodesResponse:
|
Returned
parameter ListCommonCodesResponse |
Type |
Length
Byte |
Description
– Comments |
|
Code |
String |
|
Returned
code, e.g. AD for nationality codes. Code and text are mandatory in reply for
all methods |
|
Text |
String |
|
Returned
text, e.g. |
|
CodeSystemOID |
String/OID |
|
OID
identificator Used
by: ContactMeasurementCodes ContactParticipantTypes ContactTreaterTypes ContactTreatmentCodes DecisionCodes DecisionTypes ComplaintTypes CriteriaTypes PatientAdditionalInformationCodes GenericCodeSets GenericCodeValues AdmSex AdmYesNo AdmYesNoUnknown DrugOpioid DrugLivingConditions DrugSyringeUse DrugSyringeFrequency DrugSyringeNeedleSharing DrugMentalHealth DrugFrequencyOfUse DrugType DrugIngestionMethod DrugLivesWith DrugLivingChildrenU18 DrugAgeChildrenU18 DrugBloodVirusTested DrugBloodVirusType DrugFollowUp DrugTreatmentEnding DecisionGroup UpdatableCommonCodes AdmTreatmentTime PatientClassificationCode HelfoNotificationStatus PsychosocialAspects PsychosocialFunctionLevel PsychosocialFunctionType WaitTimeEndCode ReferralReasonChildCond ReferralReasonChildEnv ChildWelfareRole CarePeriodInfoGroupCodes PatientRelationRole CareLivingSituation PatientTranslatorNeed EPRInfoTransferConsent PatientLivingWithPartner PatientEthnicAffiliation PatientCaregiverRelations AddressPostalTypes AddressTelephoneTypes AddressEmailTypes AddressLineTypes ContactAdditionalInfoType CollInstanceServiceTypes RoomAttributeTypes CarePeriodResourceType WaitingListAdditionalInfoType DocumentLanguageCodes ContactActivityTypeCodes |
|
CodedValue |
KITH:CV |
|
Code
represented in KITH’s CV format with attributes: V = “Type”, S = “OID” and DN
= “Text”. |
|
AdditionalCodes.AdditionalCode.Code |
String |
|
Additional
codes or type description for the code See parameter table for more details
about usage and valid values. |
|
AdditionalCodes.AdditionalCode.TypeOfCode |
String |
|
Type
description for AdditionalCode.Code See parameter table for more details
about usage and valid values. |
|
AdditionalCodes.AdditionalCode.CodeSystemOID |
String |
|
OID
code Used
by: UrbanNeighbourhoodCodes PatientAdditionalInformationCodes
|
|
AdditionalCodes.AdditionalCode.Text |
String |
|
Description
of OID code Used
by: UrbanNeighbourhoodCodes PatientAdditionalInformationCodes |
|
AdditionalCodes.AdditionalCode.CodedValue |
KITH:CV |
|
Code
represented in KITH’s CV format with attributes: V = “Type”, S = “OID” and DN
= “Text”. |
|
ValidPeriod.From |
DateTime |
|
From
date of when code is valid |
|
ValidPeriod.To |
DateTime |
|
To
date of when code is no longer valid |
|
RefInterval.Low |
String |
|
Description: Lowest
value that can be registered on code Used
by: ContactMeasurementCodes |
|
RefInterval.High |
String |
|
Highest
value that can be registered on code Used
by: ContactMeasurementCodes |
|
CodeId |
String |
|
Internal
Id for the code. Used to
get or update the one spesific code. E.g.
Common code id. CommonCodeId
is a combined id with delimiter | (pipe) HIS90:
Minimum
values in id is: CommonCodeType, Code and ValidToDate Addition
values like Type of Category are added after ToDate |
|
TypeOfCodeId |
String |
|
Type
of code id given i CodeId. This will give the WS to use to get details. CCID
=Common code id - use CommonCodesWS LRC=
Local requester code - use RequesterWS |
|
CodeType |
Enum |
|
Common
Code type for each code. Only
present if codes from multiple codes sets are returned in same response. Usually
same as CommonCodeType in request, but for some listings multiple code sets
can be returned. |
Valid parameters in Request to ListCommonCodes:
|
CommonCodeType (Only
CommonCodeType paramter is required in request) |
Code |
Types.Type |
Types. TypeOfType |
Valid.AllCodes |
Comments |
|
RequesterCode |
(X) |
N/A |
N/A |
(X) |
|
|
AdmitCode |
(X) |
N/A |
N/A |
(X) |
|
|
Rate |
(X) |
N/A |
N/A |
(X) |
|
|
MunicipalityCode |
(X) |
N/A |
N/A |
(X) |
|
|
NationalityCode |
(X) |
N/A |
N/A |
(X) |
|
|
PostCode |
(X) |
(X) |
MUNIC COUNTY |
(X) |
Muncipality or county code can be set in Type to
filter post codes belonging to on municipality or county. Valid municipalities can be listed by using CommonCodesWS.ListCommonCodes
with MunicipalityCode |
|
LanguageCode |
(X) |
N/A |
N/A |
(X) |
|
|
LetterCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set in Type to get Letter
Codes for on department. Valid departments can be listed by using OrganixationWS.ListOrganizations
or OrganixationWS.ListOrganizations2G |
|
VDGRCode |
(X) |
(X) |
VHDG |
(X) |
VHDG code can be set in Type to get VDGR codes
for one VHDG code. Valid VHDG codes can be listed by using CommonCodesWS.ListCommonCodes
with VHDGCode |
|
VHDGCode |
(X) |
N/A |
N/A |
(X) |
|
|
PriorityCode |
(X) |
N/A |
N/A |
(X) |
|
|
CancelReasonCode |
(X) |
N/A |
N/A |
(X) |
|
|
ClinicalAreaGroupCode |
(X) |
N/A |
N/A |
(X) |
|
|
FreeCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set in Type to get Free
Codes for on department. Valid departments can be listed by using OrganixationWS.ListOrganizations
or OrganixationWS.ListOrganizations2G |
|
CashCode |
(X) |
N/A |
N/A |
(X) |
|
|
PaymentMethodCode |
(X) |
N/A |
N/A |
(X) |
|
|
RefundCode |
(X) |
N/A |
N/A |
(X) |
|
|
MaritialCode |
(X) |
N/A |
N/A |
(X) |
|
|
UrbanNeighbourhoodCode |
(X) |
(X) |
MUNIC COUNTY |
(X) |
Muncipality or county code can be set in Type to
filter urban heighbourhood codes belonging to on municipality or county. Valid municipalities can be listed by using CommonCodesWS.ListCommonCodes
with MunicipalityCode |
|
AdmissionFromCode |
(X) |
N/A |
N/A |
(X) |
|
|
EECDocumentationCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactCategoryCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactGroupCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactDischargeReasonCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactFinishedCode |
(X) |
N/A |
N/A |
(X) |
|
|
TransportationCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactAdmittedToCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactDischargedToCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactMeasurementCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactParticipantCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactTreaterType |
(X) |
N/A |
N/A |
(X) |
|
|
ContactTreatmentCode |
(X) |
N/A |
N/A |
(X) |
|
|
DecisionCode |
(X) |
(X) |
CATEGORY ----------- Only in response types: VALID-NUMBER-OF-DAYS ----------- DAYS-BETWEEN-REVIEW |
(X) |
Decision Category can be set in Type to filter
Decsion codes. Valid Categories are: H S T -------------------------------- Number of day a decision is valid for. -------------------------------- Number of days between review of the decisions. |
|
DecisionType |
(X) |
(X) |
CATEGORY |
(X) |
Decision Category can be set in Type to filter
Decsion types. Valid Categories are: H S T |
|
ComplaintType |
(X) |
N/A |
N/A |
(X) |
|
|
CriteriaType |
(X) |
N/A |
N/A |
(X) |
|
|
PatientAdditionalInformationCode |
(X) |
(X) |
TYPE |
(X) |
Type can contain type of Additional information
codes Valid types can be listed by using CommonCodesWS.ListCommonCodes
with PatientAdditionalInformationType
(See below) |
|
PatientAdditionalInformationType |
(X) |
N/A |
N/A |
(X) |
Some valid types are: BA = Live alone OE = Care of own children PS = Patient consent |
|
PatientConfidentialCode |
(X) |
N/A |
N/A |
(X) |
Confidential codes for a patient (Info: XML code set file) |
|
WaitingListStatusCode |
(X) |
N/A |
N/A |
(X) |
Status codes on waitinglists (Info: XML code set file) |
|
WaitingListGuaranteeCode |
(X) |
N/A |
N/A |
(X) |
Waiting list guarantee codes (Info: XML code set file) |
|
CarePeriodStatusCode |
(X) |
N/A |
N/A |
(X) |
Status codes on care periods (Info: XML code set file) |
|
ContactAccidentCode |
(X) |
N/A |
N/A |
(X) |
Accodent codes (Info: XML code set file) |
|
ContactStatusCode |
(X) |
(X) |
TYPE |
(X) |
Contact status codes Valid types are: <Blank> = All I = Inpatients types P = Outpatients types (Info: XML code set file) |
|
AppointmentType |
(X) |
N/A |
N/A |
(X) |
Appointment types (Info: XML code set file) |
|
TypeOfCareCode |
(X) |
(X) |
TYPE |
(X) |
Type of care codes Valid types are: <Blank> = All CONT = Codes for ContactWS WAIT = Codes for WaitingListWS (Info: XML code set file) |
|
MetaInformationCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for DocumentMessagingWS |
|
OrganizationTypeCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for DocumentMessagingWS |
|
MessageTypeCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for DocumentMessagingWS |
|
DocumentPhrases |
N/A |
N/A |
N/A |
N/A |
Not in use, for DocumentMessagingWS |
|
ComplaintResultType |
(X) |
N/A |
N/A |
(X) |
Codes/Types for complaint result. |
|
SystemPrintersCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set in Type to get Letter
Codes for on department. Valid departments can be listed by using OrganixationWS.ListOrganizations
or OrganixationWS.ListOrganizations2G |
|
PatientLeaveCode |
X |
N/A |
N/A |
X |
|
|
CareTypeCodes |
X |
N/A |
N/A |
X |
|
|
IndividualPlanRoleCodes |
X |
N/A |
N/A |
X |
|
|
IndividualPlanStatusCodes |
X |
N/A |
N/A |
X |
|
|
EvaluationPriorityCode |
X |
N/A |
N/A |
X |
|
|
GenericCodeSets |
X |
N/A |
N/A |
X |
|
|
GenericCodeValues |
X |
(X) |
TYPE |
X |
TYPE
kodeverk kan angis. Gyldig verdier hentes med GenericCodeSets |
|
AdmSex |
X |
N/A |
N/A |
X |
|
|
AdmYesNo |
X |
N/A |
N/A |
X |
|
|
AdmYesNoUnknown |
X |
N/A |
N/A |
X |
|
|
DrugOpioid |
X |
N/A |
N/A |
X |
|
|
DrugLivingConditions |
X |
N/A |
N/A |
X |
|
|
DrugSyringeUse |
X |
N/A |
N/A |
X |
|
|
DrugSyringeFrequency |
X |
N/A |
N/A |
X |
|
|
DrugSyringeNeedleSharing |
X |
N/A |
N/A |
X |
|
|
DrugMentalHealth |
X |
N/A |
N/A |
X |
|
|
DrugFrequencyOfUse |
X |
N/A |
N/A |
X |
|
|
DrugType |
X |
N/A |
N/A |
X |
|
|
DrugIngestionMethod |
X |
N/A |
N/A |
X |
|
|
DrugLivesWith |
X |
N/A |
N/A |
X |
|
|
DrugLivingChildrenU18 |
X |
N/A |
N/A |
X |
|
|
DrugAgeChildrenU18 |
X |
N/A |
N/A |
X |
|
|
DrugBloodVirusTested |
X |
N/A |
N/A |
X |
|
|
DrugBloodVirusType |
X |
N/A |
N/A |
X |
|
|
DrugFollowUp |
X |
N/A |
N/A |
X |
|
|
DrugTreatmentEnding |
X |
N/A |
N/A |
X |
|
|
DecisionGroup |
X |
N/A |
N/A |
X |
XML
File codes |
|
UpdatableCommonCodes |
X |
N/A |
N/A |
X |
XML
File codes |
|
AdmTreatmentTime |
X |
N/A |
N/A |
X |
|
|
PatientClassificationCod |
X |
N/A |
N/A |
X |
|
|
HelfoNotificationStatus |
X |
N/A |
N/A |
X |
|
|
PsychosocialAspects |
X |
N/A |
N/A |
X |
|
|
PsychosocialFunctionLeve |
X |
N/A |
N/A |
X |
|
|
PsychosocialFunctionType |
X |
N/A |
N/A |
X |
|
|
ReferralReasonChildCond |
X |
N/A |
N/A |
X |
|
|
ReferralReasonChildEnv |
X |
N/A |
N/A |
X |
|
|
ChildWelfareRole |
X |
N/A |
N/A |
X |
|
|
CarePeriodInfoGroupCodes |
X |
N/A |
N/A |
X |
|
|
PatientRelationRole |
|
|
|
|
|
|
CareLivingSituation |
X |
N/A |
N/A |
X |
|
|
PatientTranslatorNeed |
X |
N/A |
N/A |
X |
|
|
EPRInfoTransferConsent |
X |
N/A |
N/A |
X |
|
|
PatientLivingWithPartner |
X |
N/A |
N/A |
X |
|
|
PatientEthnicAffiliation |
X |
N/A |
N/A |
X |
|
|
PatientCaregiverRelations |
X |
N/A |
N/A |
X |
|
|
AddressPostalTypes |
X |
N/A |
N/A |
X |
XML
File codes |
|
AddressTelephoneTypes |
X |
N/A |
N/A |
X |
XML
File codes |
|
AddressEmailTypes |
X |
N/A |
N/A |
X |
XML
File codes |
|
AddressLineTypes |
X |
N/A |
N/A |
X |
XML
File codes |
|
ContactAdditionalInfoType |
X |
N/A |
N/A |
X |
XML
File codes |
|
CollInstanceServiceTypes |
X |
N/A |
N/A |
X |
|
|
RoomAttributeTypes |
X |
N/A |
N/A |
X |
|
|
CarePeriodResourceType |
X |
N/A |
N/A |
X |
|
|
WaitingListAdditionalInfoType |
X |
N/A |
N/A |
X |
XML
File codes |
|
DocumentLanguageCodes |
X |
N/A |
N/A |
X |
|
|
ContactActivityTypeCodes |
X |
N/A |
N/A |
X |
|
Schema for ListCommonCodes: CommonCodesWS.xsd
Schema documentation
for CommonCodes: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=ListCommonCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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 system name is also required.
An error will result if any of these are missing.
A valid authentication block for RequestHeader can be retrieved by using the
method GetUserLogin in the Authentication web service.
In the return from the method there will always
be a ResponseHeader, which contains Error Information and System Information. The Error
Information block must always be examined to determine if any error has
occurred during execution of the method.
Applicable systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Method for getting a common code used in
PasLink web service methods.
The method gets all details of a code and must
be used before an update.
Syntax:
GetCommonCodeResponse = GetCommonCode(GetCommonCodeRequest)
Request:
|
Parameter in GetCommonCodeRequest |
Type |
Length byte |
Description – Data format – Valid
data |
|
CodeId |
String |
|
Internal id of
the code. Used to get or update one specific code. E.g., common code id. CommonCodeId
is a combined id, delimited with pipe (|). HIS90: Minimum value
in id is: CommonCodeType, Code and ValidToDate. Additional values like Type
of Category are added after ToDate. |
|
TypeOfCodeId |
String |
|
Type of code
id given i CodeId. This determines which web service must be used to get details. CCID = Common
code id - use CommonCodesWS LRC = Local
requester code - use RequesterWS |
Valid parameters in GetCommonCode
request:
|
CommonCodeType (Only CommonCodeType parameter is required in
request) |
Code |
Types.Type |
Types.
TypeOfType |
Valid.AllCodes |
Comments |
|
RequesterCode |
(X) |
N/A |
N/A |
(X) |
|
|
AdmitCode |
(X) |
N/A |
N/A |
(X) |
|
|
Rate |
(X) |
N/A |
N/A |
(X) |
|
|
MunicipalityCode |
(X) |
N/A |
N/A |
(X) |
|
|
NationalityCode |
(X) |
N/A |
N/A |
(X) |
|
|
PostCode |
(X) |
(X) |
MUNIC COUNTY |
(X) |
Muncipality or county
code can be set in Type to filter post codes belonging to on municipality or
county. Valid municipalities can
be listed by using CommonCodesWS.GetCommonCode with MunicipalityCode |
|
LanguageCode |
(X) |
N/A |
N/A |
(X) |
|
|
LetterCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set
in Type to get Letter Codes for on department. Valid departments can be
listed by using OrganixationWS.ListOrganizations or OrganixationWS.ListOrganizations2G |
|
VDGRCode |
(X) |
(X) |
VHDG |
(X) |
VHDG code can be set in
Type to get VDGR codes for one VHDG code. Valid VHDG codes can be
listed by using CommonCodesWS.GetCommonCode with VHDGCode |
|
VHDGCode |
(X) |
N/A |
N/A |
(X) |
|
|
PriorityCode |
(X) |
N/A |
N/A |
(X) |
|
|
CancelReasonCode |
(X) |
N/A |
N/A |
(X) |
|
|
ClinicalAreaGroupCode |
(X) |
N/A |
N/A |
(X) |
|
|
FreeCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set
in Type to get Free Codes for on department. Valid departments can be
listed by using OrganixationWS.ListOrganizations or OrganixationWS.ListOrganizations2G |
|
CashCode |
(X) |
N/A |
N/A |
(X) |
|
|
PaymentMethodCode |
(X) |
N/A |
N/A |
(X) |
|
|
RefundCode |
(X) |
N/A |
N/A |
(X) |
|
|
MaritialCode |
(X) |
N/A |
N/A |
(X) |
|
|
UrbanNeighbourhoodCode |
(X) |
(X) |
MUNIC COUNTY |
(X) |
Muncipality or county
code can be set in Type to filter urban heighbourhood codes belonging to on
municipality or county. Valid municipalities can
be listed by using CommonCodesWS.GetCommonCode with MunicipalityCode |
|
AdmissionFromCode |
(X) |
N/A |
N/A |
(X) |
|
|
EECDocumentationCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactCategoryCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactGroupCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactDischargeReasonCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactFinishedCode |
(X) |
N/A |
N/A |
(X) |
|
|
TransportationCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactAdmittedToCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactDischargedToCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactMeasurementCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactParticipantCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactTreaterType |
(X) |
N/A |
N/A |
(X) |
|
|
ContactTreatmentCode |
(X) |
N/A |
N/A |
(X) |
|
|
DecisionCode |
(X) |
(X) |
CATEGORY ----------- Only in response types: VALID-NUMBER-OF-DAYS ----------- DAYS-BETWEEN-REVIEW |
(X) |
Decision Category can be
set in Type to filter Decsion codes. Valid Categories are: H S T -------------------------------- Number of day a decision
is valid for. -------------------------------- Number of days between
review of the decisions. |
|
DecisionType |
(X) |
(X) |
CATEGORY |
(X) |
Decision Category can be
set in Type to filter Decsion types. Valid Categories are: H S T |
|
ComplaintType |
(X) |
N/A |
N/A |
(X) |
|
|
CriteriaType |
(X) |
N/A |
N/A |
(X) |
|
|
PatientAdditionalInformationCode |
(X) |
(X) |
TYPE |
(X) |
Type can contain type of
Additional information codes Valid types can be
listed by using CommonCodesWS.GetCommonCode with PatientAdditionalInformationType
(See below) |
|
PatientAdditionalInformationType |
(X) |
N/A |
N/A |
(X) |
Some valid types are: BA = Live alone OE = Care of own
children PS = Patient consent |
|
PatientConfidentialCode |
(X) |
N/A |
N/A |
(X) |
Confidential codes for a
patient (Info: XML code set
file) |
|
WaitingListStatusCode |
(X) |
N/A |
N/A |
(X) |
Status codes on
waitinglists (Info: XML code set
file) |
|
WaitingListGuaranteeCode |
(X) |
N/A |
N/A |
(X) |
Waiting list guarantee
codes (Info: XML code set
file) |
|
CarePeriodStatusCode |
(X) |
N/A |
N/A |
(X) |
Status codes on care
periods (Info: XML code set
file) |
|
ContactAccidentCode |
(X) |
N/A |
N/A |
(X) |
Accodent codes (Info: XML code set
file) |
|
ContactStatusCode |
(X) |
(X) |
TYPE |
(X) |
Contact status codes Valid types are: <Blank> = All I = Inpatients types P = Outpatients types (Info: XML code set
file) |
|
AppointmentType |
(X) |
N/A |
N/A |
(X) |
Appointment types (Info: XML code set
file) |
|
TypeOfCareCode |
(X) |
(X) |
TYPE |
(X) |
Type of care codes Valid types are: <Blank> = All CONT = Codes for
ContactWS WAIT = Codes for
WaitingListWS (Info: XML code set
file) |
|
MetaInformationCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for
DocumentMessagingWS |
|
OrganizationTypeCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for
DocumentMessagingWS |
|
MessageTypeCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for
DocumentMessagingWS |
|
DocumentPhrases |
N/A |
N/A |
N/A |
N/A |
Not in use, for
DocumentMessagingWS |
|
ComplaintResultType |
(X) |
N/A |
N/A |
(X) |
Codes/Types for
complaint result. |
|
SystemPrintersCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set
in Type to get Letter Codes for on department. Valid departments can be
listed by using OrganixationWS.ListOrganizations or OrganixationWS.ListOrganizations2G |
|
PatientLeaveCode |
X |
N/A |
N/A |
X |
|
|
CareTypeCodes |
X |
N/A |
N/A |
X |
|
|
IndividualPlanRoleCodes |
X |
N/A |
N/A |
X |
|
|
IndividualPlanStatusCodes |
X |
N/A |
N/A |
X |
|
|
EvaluationPriorityCode |
X |
N/A |
N/A |
X |
|
|
GenericCodeSets |
X |
N/A |
N/A |
X |
|
|
GenericCodeValues |
X |
(X) |
TYPE |
X |
TYPE of code set may be given. To get get possible
values use GenericCodeSets. |
|
AdmSex |
X |
N/A |
N/A |
X |
|
|
AdmYesNo |
X |
N/A |
N/A |
X |
|
|
AdmYesNoUnknown |
X |
N/A |
N/A |
X |
|
|
DrugOpioid |
X |
N/A |
N/A |
X |
|
|
DrugLivingConditions |
X |
N/A |
N/A |
X |
|
|
DrugSyringeUse |
X |
N/A |
N/A |
X |
|
|
DrugSyringeFrequency |
X |
N/A |
N/A |
X |
|
|
DrugSyringeNeedleSharing |
X |
N/A |
N/A |
X |
|
|
DrugMentalHealth |
X |
N/A |
N/A |
X |
|
|
DrugFrequencyOfUse |
X |
N/A |
N/A |
X |
|
|
DrugType |
X |
N/A |
N/A |
X |
|
|
DrugIngestionMethod |
X |
N/A |
N/A |
X |
|
|
DrugLivesWith |
X |
N/A |
N/A |
X |
|
|
DrugLivingChildrenU18 |
X |
N/A |
N/A |
X |
|
|
DrugAgeChildrenU18 |
X |
N/A |
N/A |
X |
|
|
DrugBloodVirusTested |
X |
N/A |
N/A |
X |
|
|
DrugBloodVirusType |
X |
N/A |
N/A |
X |
|
|
DrugFollowUp |
X |
N/A |
N/A |
X |
|
|
DrugTreatmentEnding |
X |
N/A |
N/A |
X |
|
|
DecisionGroup |
X |
N/A |
N/A |
X |
XML File codes |
|
UpdatableCommonCodes |
X |
N/A |
N/A |
X |
XML File codes |
|
AdmTreatmentTime |
X |
N/A |
N/A |
X |
|
|
PatientClassificationCod |
X |
N/A |
N/A |
X |
|
|
HelfoNotificationStatus |
X |
N/A |
N/A |
X |
|
|
PsychosocialAspects |
X |
N/A |
N/A |
X |
|
|
PsychosocialFunctionLeve |
X |
N/A |
N/A |
X |
|
|
PsychosocialFunctionType |
X |
N/A |
N/A |
X |
|
|
ReferralReasonChildCond |
X |
N/A |
N/A |
X |
|
|
ReferralReasonChildEnv |
X |
N/A |
N/A |
X |
|
|
ChildWelfareRole |
X |
N/A |
N/A |
X |
|
|
CarePeriodInfoGroupCodes |
X |
N/A |
N/A |
X |
|
|
PatientRelationRole |
X |
N/A |
N/A |
X |
|
|
CareLivingSituation |
X |
N/A |
N/A |
X |
|
|
PatientTranslatorNeed |
X |
N/A |
N/A |
X |
|
|
EPRInfoTransferConsent |
X |
N/A |
N/A |
X |
|
|
PatientLivingWithPartner |
X |
N/A |
N/A |
X |
|
|
PatientEthnicAffiliation |
X |
N/A |
N/A |
X |
|
|
PatientCaregiverRelations |
X |
N/A |
N/A |
X |
|
|
AddressPostalTypes |
X |
N/A |
N/A |
X |
XML File codes |
|
AddressTelephoneTypes |
X |
N/A |
N/A |
X |
XML File codes |
|
AddressEmailTypes |
X |
N/A |
N/A |
X |
XML File codes |
|
AddressLineTypes |
X |
N/A |
N/A |
X |
XML File codes |
|
ContactAdditionalInfoType |
X |
N/A |
N/A |
X |
XML File codes |
|
CollInstanceServiceTypes |
X |
N/A |
N/A |
X |
|
|
RoomAttributeTypes |
X |
N/A |
N/A |
X |
|
|
CarePeriodResourceType |
X |
N/A |
N/A |
X |
|
|
WaitingListAdditionalInfoType |
X |
N/A |
N/A |
X |
XML File codes |
|
DocumentLanguageCodes |
X |
N/A |
N/A |
X |
|
|
ContactActivityTypeCodes |
X |
N/A |
N/A |
X |
|
Example of returned parameters in
GetCommonCodeResponse:
|
Returned parameter GetCommonCodeResponse |
Type |
Length Byte |
Description – Comments |
|
Registration.Institution.Id |
String |
|
Id of institution (hospital) that registered
this record. |
|
Registration.Institution.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 “LIN” by web service. |
|
Registration.Institution.ShortNameId |
String |
|
Short name of institution. HIS90: N/A |
|
Registration.Institution.Name |
String |
|
Name of institution. HIS90: N/A |
|
Registration.Date |
DateTime |
|
Insertion date of record. HIS90: Extracted from ticket (op block) by PAS server
program. |
|
Registration.Name |
String |
|
Name of person responsible for registration of
the record. HIS90: N/A |
|
Registration.Organization.Id |
String |
|
Code of organization that first registered this
record. 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
record. HIS90: Extracted from ticket (op block) by PAS server
program. |
|
Update.UpdateCount |
Integer |
|
Counter 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. |
|
Update.Institution |
String |
|
Institution person who updated the record
belongs to. HIS90: N/A |
|
Update.Date |
DateTime |
|
Date and time
when the record was updated. |
|
Update.Name |
String |
|
Name of person who updated the record. HIS90: N/A |
|
Update.Organization |
String |
|
Organization that
updated the record. |
|
Update.SignedBy |
String |
|
Initials of
person who updated the record. |
|
AdditionalCodes.AdditionalCode.Code |
String |
|
Additional codes or type description for the
code See parameter
table for more details about
usage and valid values. |
|
AdditionalCodes.AdditionalCode.TypeOfCode |
String |
|
Type description for AdditionalCode.Code See parameter
table for more details about
usage and valid values. |
|
AdditionalCodes.AdditionalCode.CodeSystemOID |
String |
|
OID code Used by: UrbanNeighbourhoodCodes PatientAdditionalInformationCodes |
|
AdditionalCodes.AdditionalCode.Text |
String |
|
Description of OID code Used by: UrbanNeighbourhoodCodes PatientAdditionalInformationCodes |
|
AdditionalCodes.AdditionalCode.CodedValue |
KITH:CV |
|
Code represented in KITH’s CV format with
attributes: V = “Type”, S = “OID” and DN = “Text”. Used by: PatientAdditionalInformationCodes |
|
ValidPeriod.From |
DateTime |
|
From date of when code is valid |
|
ValidPeriod.To |
DateTime |
|
To date of when code is no longer valid |
|
RefInterval.Low |
String |
|
Description: Lowest value that can be registered on code Used by: ContactMeasurementCodes |
|
RefInterval.High |
String |
|
Highest value that can be registered on code Used by: ContactMeasurementCodes |
|
CodeId |
String |
|
Internal Id for the code. Used to get or update the one spesific code. E.g. common code id. CommonCodeId is a combined id with pipe
delimiter (|). HIS90: Minimum values in id is: CommonCodeType, Code
and ValidToDate. Additional values like Type of Category are
added after ToDate. |
|
TypeOfCodeId |
String |
|
Type of code id given i CodeId. This will give
the WS to use to get details. CCID = Common code id - use CommonCodesWS LRC = Local requester code - use RequesterWS |
|
CodeType |
Enum |
|
Common Code type for each code. Only present if codes from multiple codes sets
are returned in same response. Usually same as CommonCodeType in request, but
for some listings multiple code sets can be returned. |
|
Code |
String |
|
Returned code, e.g. AD for nationality codes.
Code and text are mandatory in reply for all methods |
|
Text |
String |
|
Returned text, e.g. |
|
CodeSystemOID |
String/OID |
|
OID identificator Used by: ContactMeasurementCodes ContactParticipantTypes ContactTreaterTypes ContactTreatmentCodes DecisionCodes DecisionTypes ComplaintTypes CriteriaTypes PatientAdditionalInformationCodes GenericCodeSets GenericCodeValues AdmSex AdmYesNo AdmYesNoUnknown DrugOpioid DrugLivingConditions DrugSyringeUse DrugSyringeFrequency DrugSyringeNeedleSharing DrugMentalHealth DrugFrequencyOfUse DrugType DrugIngestionMethod DrugLivesWith DrugLivingChildrenU18 DrugAgeChildrenU18 DrugBloodVirusTested DrugBloodVirusType DrugFollowUp DrugTreatmentEnding DecisionGroup UpdatableCommonCodes AdmTreatmentTime PatientClassificationCode HelfoNotificationStatus PsychosocialAspects PsychosocialFunctionLevel PsychosocialFunctionType WaitTimeEndCode ReferralReasonChildCond ReferralReasonChildEnv ChildWelfareRole CarePeriodInfoGroupCodes PatientRelationRole CareLivingSituation PatientTranslatorNeed EPRInfoTransferConsent PatientLivingWithPartner PatientEthnicAffiliation PatientCaregiverRelations AddressPostalTypes AddressTelephoneTypes AddressEmailTypes AddressLineTypes ContactAdditionalInfoType CollInstanceServiceTypes RoomAttributeTypes CarePeriodResourceType WaitingListAdditionalInfoType DocumentLanguageCodes ContactActivityTypeCodes |
|
CodedValue |
KITH:CV |
|
Code represented in KITH’s CV format with
attributes: V = “Type”, S = “OID” and DN = “Text”. |
Schema for GetCommonCode: CommonCodesWS.xsd
Schema documentation for CommonCodes: CommonCodes.html
Web Service Response and
Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=GetCommonCode
Related methods or functions used:
GetUserLogin Used
to verify user and 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 system name is also required. An error will result if any of these are
missing.
A valid authentication block for RequestHeader can be retrieved by using the
method GetUserLogin in the Authentication web service.
In the return from the method there will always
be a ResponseHeader, which contains Error Information and System Information. The Error
Information block must always be examined to determine if any error has
occurred during execution of the method.
Applicable systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Method for saving/updating a common code used
in PasLink web service methods.
For first time registration, user must specify
all details necessary for saving the common code. When updating an existing
common code, the GetCommonCode method must be used to get the desired common
code object.
Syntax:
SaveCommonCodeResponse = SaveCommonCode(SaveCommonCodeRequest)
Request:
|
Parameter in SaveCommonCodeRequest |
Type |
Length byte |
Description – Data format – Valid
data |
|
|
Registration.Institution.Id |
String |
|
Id of institution (hospital) that registered
this record. |
|
|
Registration.Institution.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 “LIN” by web service. |
|
|
Registration.Institution.ShortNameId |
String |
|
Short name of institution. HIS90: N/A |
|
|
Registration.Institution.Name |
String |
|
Name of institution. HIS90: N/A |
|
|
Registration.Date |
DateTime |
|
Insertion date of record. HIS90: Extracted from ticket (op block) by PAS server program. |
|
|
Registration.Name |
String |
|
Name of person responsible for registration of
the record. HIS90: N/A |
|
|
Registration.Organization.Id |
String |
|
Code of organization that first registered this
record. 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: N/A |
|
|
Registration.Organization.Name |
String |
|
Name of organization. HIS90: N/A |
|
|
Registration.SignedBy |
String |
|
Initials of person who originally created this
record. HIS90: Extracted from ticket (op block) by PAS server
program. |
|
|
Update.UpdateCount |
Integer |
|
Counter used
for concurrency testing when record is updated. Required only if CodeId is
set, i.e. updating existing record. Set to
blank/0 if new record. |
|
|
Update.Institution.Id |
String |
|
Institution person who updated the record
belongs to. HIS90: Set by web service from record to be updated. |
|
|
Update.Institution.TypeOfId |
String |
|
Type of institution id. HIS90: Set to “LIN”
by web service. |
|
|
Update.Institution.ShortNameId |
String |
|
Institution short name. HIS90: N/A |
|
|
Update.Institution.Name |
String |
|
Institution name. HIS90: N/A |
|
|
Update.Date |
DateTime |
|
Date and time
when the record was updated. HIS90: Set by web service from record to be updated. |
|
|
Update.Name |
String |
|
Name of person who updated the record. HIS90: N/A |
|
|
Update.Organization.Id |
String |
|
Organization that
record to be updated belongs to. HIS90: Set by web service to department id from record to
be updated. |
|
|
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 |
|
Organization short name. HIS90: N/A |
|
|
Update.Organization.Name |
String |
|
Organization that updated record belongs to. HIS90: N/A |
|
|
Update.SignedBy |
String |
|
Initials of
person who updated the record. |
|
|
AdditionalCodes[] |
Struct |
|
Additional
information about the code value. |
|
|
AdditionalCodes[].TypeOfCode |
String |
|
HIS90: Set to “INTERNAL” by web service. |
|
|
AdditionalCodes[].Code |
String |
|
Internal code matching the enumerator list
(CommonCodeTypes) in CommonCodesWS. |
|
|
AdditionalCodes[].Text |
String |
|
HIS90: N/A |
|
|
AdditionalCodes[].CodeSystemOID |
String |
|
HIS90: N/A |
|
|
AdditionalCodes[].CodedValue |
Struct |
|
HIS90: N/A |
|
|
ValidPeriod.From |
DateTime |
|
Date from which record is valid. |
|
|
ValidPeriod.To |
DateTime |
|
Date to which record is valid. |
|
|
RefInterval.Low |
Struct |
|
HIS90: N/A |
|
|
RefInterval.High |
Struct |
|
HIS90: N/A |
|
|
CodeId |
String |
|
Internal id of the code. Used to get or update one
specific code. E.g., common code id. CommonCodeId is a combined id, delimited with pipe
(|). HIS90: Minimum value in id is: CommonCodeType, Code and
ValidToDate. Additional values like Type of Category are added after ToDate. |
|
|
TypeOfCodeId |
String |
|
Type of code
id given i CodeId. This determines which WS must be used to get details. CCID = Common
code id - use CommonCodesWS LRC = Local
requester code - use RequesterWS |
|
|
CodeType |
String |
|
Type of code
set to be updated. See CommonCodeTypes for legal values. Use GenericCodeSets to update a code set. |
|
|
Code |
String |
|
New code
value. |
|
|
Text |
String |
|
Description
of code. |
|
|
CodeSystemOID |
String |
|
Code set
identificator. Must correspond to a Volven OID, for code sets, or to an
internal OID, for code values. |
|
|
CodedValue |
KITH:CV |
|
Code represented in KITH’s CV format with
attributes: V = “Type”, S = “OID” and DN = “Text”. |
|
Valid parameters in SaveCommonCode
request:
|
CommonCodeType (Only CommonCodeType parameter is required in
request) |
Code |
Types.Type |
Types.
TypeOfType |
Valid.AllCodes |
Comments |
|
RequesterCode |
(X) |
N/A |
N/A |
(X) |
|
|
AdmitCode |
(X) |
N/A |
N/A |
(X) |
|
|
Rate |
(X) |
N/A |
N/A |
(X) |
|
|
MunicipalityCode |
(X) |
N/A |
N/A |
(X) |
|
|
NationalityCode |
(X) |
N/A |
N/A |
(X) |
|
|
PostCode |
(X) |
(X) |
MUNIC COUNTY |
(X) |
Muncipality or county
code can be set in Type to filter post codes belonging to on municipality or
county. Valid municipalities can
be listed by using CommonCodesWS.SaveCommonCode with MunicipalityCode |
|
LanguageCode |
(X) |
N/A |
N/A |
(X) |
|
|
LetterCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set
in Type to get Letter Codes for on department. Valid departments can be
listed by using OrganixationWS.ListOrganizations or OrganixationWS.ListOrganizations2G |
|
VDGRCode |
(X) |
(X) |
VHDG |
(X) |
VHDG code can be set in
Type to get VDGR codes for one VHDG code. Valid VHDG codes can be
listed by using CommonCodesWS.SaveCommonCode with VHDGCode |
|
VHDGCode |
(X) |
N/A |
N/A |
(X) |
|
|
PriorityCode |
(X) |
N/A |
N/A |
(X) |
|
|
CancelReasonCode |
(X) |
N/A |
N/A |
(X) |
|
|
ClinicalAreaGroupCode |
(X) |
N/A |
N/A |
(X) |
|
|
FreeCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set
in Type to get Free Codes for on department. Valid departments can be
listed by using OrganixationWS.ListOrganizations or OrganixationWS.ListOrganizations2G |
|
CashCode |
(X) |
N/A |
N/A |
(X) |
|
|
PaymentMethodCode |
(X) |
N/A |
N/A |
(X) |
|
|
RefundCode |
(X) |
N/A |
N/A |
(X) |
|
|
MaritialCode |
(X) |
N/A |
N/A |
(X) |
|
|
UrbanNeighbourhoodCode |
(X) |
(X) |
MUNIC COUNTY |
(X) |
Muncipality or county
code can be set in Type to filter urban heighbourhood codes belonging to on
municipality or county. Valid municipalities can
be listed by using CommonCodesWS.SaveCommonCode with MunicipalityCode |
|
AdmissionFromCode |
(X) |
N/A |
N/A |
(X) |
|
|
EECDocumentationCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactCategoryCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactGroupCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactDischargeReasonCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactFinishedCode |
(X) |
N/A |
N/A |
(X) |
|
|
TransportationCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactAdmittedToCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactDischargedToCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactMeasurementCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactParticipantCode |
(X) |
N/A |
N/A |
(X) |
|
|
ContactTreaterType |
(X) |
N/A |
N/A |
(X) |
|
|
ContactTreatmentCode |
(X) |
N/A |
N/A |
(X) |
|
|
DecisionCode |
(X) |
(X) |
CATEGORY ----------- Only in response types: VALID-NUMBER-OF-DAYS ----------- DAYS-BETWEEN-REVIEW |
(X) |
Decision Category can be
set in Type to filter Decsion codes. Valid Categories are: H S T -------------------------------- Number of day a decision
is valid for. -------------------------------- Number of days between
review of the decisions. |
|
DecisionType |
(X) |
(X) |
CATEGORY |
(X) |
Decision Category can be
set in Type to filter Decsion types. Valid Categories are: H S T |
|
ComplaintType |
(X) |
N/A |
N/A |
(X) |
|
|
CriteriaType |
(X) |
N/A |
N/A |
(X) |
|
|
PatientAdditionalInformationCode |
(X) |
(X) |
TYPE |
(X) |
Type can contain type of
Additional information codes Valid types can be
listed by using CommonCodesWS.SaveCommonCode with PatientAdditionalInformationType
(See below) |
|
PatientAdditionalInformationType |
(X) |
N/A |
N/A |
(X) |
Some valid types are: BA = Live alone OE = Care of own
children PS = Patient consent |
|
PatientConfidentialCode |
(X) |
N/A |
N/A |
(X) |
Confidential codes for a
patient (Info: XML code set
file) |
|
WaitingListStatusCode |
(X) |
N/A |
N/A |
(X) |
Status codes on
waitinglists (Info: XML code set
file) |
|
WaitingListGuaranteeCode |
(X) |
N/A |
N/A |
(X) |
Waiting list guarantee
codes (Info: XML code set
file) |
|
CarePeriodStatusCode |
(X) |
N/A |
N/A |
(X) |
Status codes on care
periods (Info: XML code set
file) |
|
ContactAccidentCode |
(X) |
N/A |
N/A |
(X) |
Accodent codes (Info: XML code set
file) |
|
ContactStatusCode |
(X) |
(X) |
TYPE |
(X) |
Contact status codes Valid types are: <Blank> = All I = Inpatients types P = Outpatients types (Info: XML code set
file) |
|
AppointmentType |
(X) |
N/A |
N/A |
(X) |
Appointment types (Info: XML code set
file) |
|
TypeOfCareCode |
(X) |
(X) |
TYPE |
(X) |
Type of care codes Valid types are: <Blank> = All CONT = Codes for
ContactWS WAIT = Codes for
WaitingListWS (Info: XML code set
file) |
|
MetaInformationCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for
DocumentMessagingWS |
|
OrganizationTypeCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for
DocumentMessagingWS |
|
MessageTypeCode |
N/A |
N/A |
N/A |
N/A |
Not in use, for
DocumentMessagingWS |
|
DocumentPhrases |
N/A |
N/A |
N/A |
N/A |
Not in use, for
DocumentMessagingWS |
|
ComplaintResultType |
(X) |
N/A |
N/A |
(X) |
Codes/Types for
complaint result. |
|
SystemPrintersCode |
(X) |
(X) |
LAV |
(X) |
Department id can be set
in Type to get Letter Codes for on department. Valid departments can be
listed by using OrganixationWS.ListOrganizations or OrganixationWS.ListOrganizations2G |
|
PatientLeaveCode |
X |
N/A |
N/A |
X |
|
|
CareTypeCodes |
X |
N/A |
N/A |
X |
|
|
IndividualPlanRoleCodes |
X |
N/A |
N/A |
X |
|
|
IndividualPlanStatusCodes |
X |
N/A |
N/A |
X |
|
|
EvaluationPriorityCode |
X |
N/A |
N/A |
X |
|
|
GenericCodeSets |
X |
N/A |
N/A |
X |
|
|
GenericCodeValues |
X |
(X) |
TYPE |
X |
TYPE of code set may be given. To get get possible
values use GenericCodeSets. |
|
AdmSex |
X |
N/A |
N/A |
X |
|
|
AdmYesNo |
X |
N/A |
N/A |
X |
|
|
AdmYesNoUnknown |
X |
N/A |
N/A |
X |
|
|
DrugOpioid |
X |
N/A |
N/A |
X |
|
|
DrugLivingConditions |
X |
N/A |
N/A |
X |
|
|
DrugSyringeUse |
X |
N/A |
N/A |
X |
|
|
DrugSyringeFrequency |
X |
N/A |
N/A |
X |
|
|
DrugSyringeNeedleSharing |
X |
N/A |
N/A |
X |
|
|
DrugMentalHealth |
X |
N/A |
N/A |
X |
|
|
DrugFrequencyOfUse |
X |
N/A |
N/A |
X |
|
|
DrugType |
X |
N/A |
N/A |
X |
|
|
DrugIngestionMethod |
X |
N/A |
N/A |
X |
|
|
DrugLivesWith |
X |
N/A |
N/A |
X |
|
|
DrugLivingChildrenU18 |
X |
N/A |
N/A |
X |
|
|
DrugAgeChildrenU18 |
X |
N/A |
N/A |
X |
|
|
DrugBloodVirusTested |
X |
N/A |
N/A |
X |
|
|
DrugBloodVirusType |
X |
N/A |
N/A |
X |
|
|
DrugFollowUp |
X |
N/A |
N/A |
X |
|
|
DrugTreatmentEnding |
X |
N/A |
N/A |
X |
|
|
DecisionGroup |
X |
N/A |
N/A |
X |
XML File codes |
|
UpdatableCommonCodes |
X |
N/A |
N/A |
X |
XML File codes |
|
AdmTreatmentTime |
X |
N/A |
N/A |
X |
|
|
PatientClassificationCod |
X |
N/A |
N/A |
X |
|
|
HelfoNotificationStatus |
X |
N/A |
N/A |
X |
|
|
PsychosocialAspects |
X |
N/A |
N/A |
X |
|
|
PsychosocialFunctionLeve |
X |
N/A |
N/A |
X |
|
|
PsychosocialFunctionType |
X |
N/A |
N/A |
X |
|
|
ReferralReasonChildCond |
X |
N/A |
N/A |
X |
|
|
ReferralReasonChildEnv |
X |
N/A |
N/A |
X |
|
|
ChildWelfareRole |
X |
N/A |
N/A |
X |
|
|
CarePeriodInfoGroupCodes |
X |
N/A |
N/A |
X |
|
|
PatientRelationRole |
X |
N/A |
N/A |
X |
|
|
CareLivingSituation |
X |
N/A |
N/A |
X |
|
|
PatientTranslatorNeed |
X |
N/A |
N/A |
X |
|
|
EPRInfoTransferConsent |
X |
N/A |
N/A |
X |
|
|
PatientLivingWithPartner |
X |
N/A |
N/A |
X |
|
|
PatientEthnicAffiliation |
X |
N/A |
N/A |
X |
|
|
PatientCaregiverRelations |
X |
N/A |
N/A |
X |
|
|
AddressPostalTypes |
X |
N/A |
N/A |
X |
XML File codes |
|
AddressTelephoneTypes |
X |
N/A |
N/A |
X |
XML File codes |
|
AddressEmailTypes |
X |
N/A |
N/A |
X |
XML File codes |
|
AddressLineTypes |
X |
N/A |
N/A |
X |
XML File codes |
|
ContactAdditionalInfoType |
X |
N/A |
N/A |
X |
XML File codes |
|
CollInstanceServiceTypes |
X |
N/A |
N/A |
X |
|
|
RoomAttributeTypes |
X |
N/A |
N/A |
X |
|
|
CarePeriodResourceType |
X |
N/A |
N/A |
X |
|
|
WaitingListAdditionalInfoType |
X |
N/A |
N/A |
X |
XML File codes |
|
DocumentLanguageCodes |
X |
N/A |
N/A |
X |
|
|
ContactActivityTypeCodes |
X |
N/A |
N/A |
X |
|
Response:
Method returns GetCommonCodeResponse, see GetCommonCode.
Schema for SaveCommonCode: CommonCodesWS.xsd
Schema documentation for CommonCodes: CommonCodes.html
Web Service Response and
Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=SaveCommonCode
Related methods or functions used:
GetUserLogin Used
to verify user and 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 system name is also required. An error will result if any of these are
missing.
A valid authentication block for RequestHeader can be retrieved by using the
method GetUserLogin in the Authentication web service.
In the return from the method there will always
be a ResponseHeader, which contains Error Information and System Information. The Error
Information block must always be examined to determine if any error has
occurred during execution of the method.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Method for
searching in a common code register used in PasLink Web service methods.
Method returns
any ‘code’ where the search key is inside one of Code, Text,
AdditionalCodes.Code or AdditionalCode.Text.
The method
provides several comon code types.
Same
response as ListCommonCodes
Syntax:
ListCommonCodesResponse = SearchCommonCodes(SearchCommonCodesRequest)
Request:
|
Parameter
in SearchCommonCodesRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
CommonCodeTypes.CommonCodeType |
|
|
Type of codes codes which can be requested. See parameter table for more
details about avlid common code type, usage and valid values. Valid common code types are: RequesterCode AdmitCode Rate MunicipalityCode NationalityCode PostCode LanguageCode LetterCode VDGRCode VHDGCode PriorityCode CancelReasonCode ClinicalAreaGroupCode FreeCode CashCode PaymentMethodCode RefundCode MaritialCode UrbanNeighbourhoodCode ContactAdmittedFromCode EECDocumentationCode ContactGategoryCode ContactGroupCode ContactDischargeCode ContactFinishedCode TransportationCode ContactAdmittedToCode ContactDischargedToCode ContactMeasurementCode ContactParticipantCode ContactTreaterType ContactTreatmentCode DecisionCode DecisionType ComplaintType ComplainResultType CriteriaType PatientAdditionalInformationCode PatientAdditionalInformationType WaitingListStatusCode WaitingListGuaranteeCode CarePeriodStatusCode ContactAccidentCode ContactStatusCode AppointmentType TypeOfCareCode MetaInformationCode OrganizationTypeCode MessageTypeCode DocumentPhrases SystemPrintersCode PatientLeaveCode CareTypeCodes IndividualPlanRoleCodes IndividualPlanStatusCodes EvaluationPriorityCode GenericCodeSets GenericCodeValues AdmSex AdmYesNo AdmYesNoUnknown DrugOpioid DrugLivingConditions DrugSyringeUse DrugSyringeFrequency DrugSyringeNeedleSharing DrugMentalHealth DrugFrequencyOfUse DrugType DrugIngestionMethod DrugLivesWith DrugLivingChildrenU18 DrugAgeChildrenU18 DrugBloodVirusTested DrugBloodVirusType DrugFollowUp DrugTreatmentEnding DecisionGroup UpdatableCommonCodes AdmTreatmentTime PatientClassificationCode HelfoNotificationStatus PsychosocialAspects PsychosocialFunctionLevel PsychosocialFunctionType WaitTimeEndCode ReferralReasonChildCond ReferralReasonChildEnv ChildWelfareRole CarePeriodInfoGroupCodes PatientRelationRole CareLivingSituation PatientTranslatorNeed EPRInfoTransferConsent PatientLivingWithPartner PatientEthnicAffiliation PatientCaregiverRelations AddressPostalTypes AddressTelephoneTypes AddressEmailTypes AddressLineTypes ContactAdditionalInfoType CollInstanceServiceTypes RoomAttributeTypes CarePeriodResourceType WaitingListAdditionalInfoType DocumentLanguageCodes ContactActivityTypeCodes |
|
SearchKey |
String |
|
Text to search for. Code is return if search
text is found within code, text/description or additional
code/text/description. |
|
Valid.Valid.AllCodes |
Boolean |
|
If true list all codes, if false list only
valid codes (at time of request) Default if not specificed is True, listing
all valid codes |
|
Valid.Valid.AllCodesSpecified |
Boolean |
|
Boolean value describing if
Valid.Valid.AllCodes above is specified |
Response:
Method
returns ListCommonCodesResponse, see
ListCommonCodes.
Valid parameters in Request to SearchCommonCodes:
|
CommonCodeType (Only
CommonCodeType paramter is required in request) |
SearchKey |
Valid. AllCodes |
Comments |
|
RequesterCode |
(X) |
(X) |
|
|
AdmitCode |
(X) |
(X) |
|
|
Rate |
(X) |
(X) |
|
|
MunicipalityCode |
(X) |
(X) |
|
|
NationalityCode |
(X) |
(X) |
|
|
PostCode |
(X) |
(X) |
|
|
LanguageCode |
(X) |
(X) |
|
|
LetterCode |
(X) |
(X) |
|
|
VDGRCode |
(X) |
(X) |
|
|
VHDGCode |
(X) |
(X) |
|
|
PriorityCode |
(X) |
(X) |
|
|
CancelReasonCode |
(X) |
(X) |
|
|
ClinicalAreaGroupCode |
(X) |
(X) |
|
|
FreeCode |
(X) |
(X) |
|
|
CashCode |
(X) |
(X) |
|
|
PaymentMethodCode |
(X) |
(X) |
|
|
RefundCode |
(X) |
(X) |
|
|
MaritialCode |
(X) |
(X) |
|
|
UrbanNeighbourhoodCode |
(X) |
(X) |
|
|
AdmissionFromCode |
(X) |
(X) |
|
|
EECDocumentationCode |
(X) |
(X) |
|
|
ContactCategoryCode |
(X) |
(X) |
|
|
ContactGroupCode |
(X) |
(X) |
|
|
ContactDischargeReasonCode |
(X) |
(X) |
|
|
ContactFinishedCode |
(X) |
(X) |
|
|
TransportationCode |
(X) |
(X) |
|
|
ContactAdmittedToCode |
(X) |
(X) |
|
|
ContactDischargedToCode |
(X) |
(X) |
|
|
ContactMeasurementCode |
(X) |
(X) |
|
|
ContactParticipantCode |
(X) |
(X) |
|
|
ContactTreaterType |
(X) |
(X) |
|
|
ContactTreatmentCode |
(X) |
(X) |
|
|
DecisionCode |
(X) |
(X) |
|
|
DecisionType |
(X) |
(X) |
|
|
ComplaintType |
(X) |
(X) |
|
|
CriteriaType |
(X) |
(X) |
|
|
PatientAdditionalInformationCode |
(X) |
(X) |
|
|
PatientAdditionalInformationType |
(X) |
(X) |
|
|
PatientConfidentialCode |
(X) |
(X) |
(Info: XML code set file) |
|
WaitingListStatusCode |
(X) |
(X) |
(Info: XML code set file) |
|
WaitingListGuaranteeCode |
(X) |
(X) |
(Info: XML code set file) |
|
CarePeriodStatusCode |
(X) |
(X) |
(Info: XML code set file) |
|
ContactAccidentCode |
(X) |
(X) |
(Info: XML code set file) |
|
ContactStatusCode |
(X) |
(X) |
(Info: XML code set file) |
|
AppointmentType |
(X) |
(X) |
(Info: XML code set file) |
|
TypeOfCareCode |
(X) |
(X) |
(Info: XML code set file) |
|
MetaInformationCode |
N/A |
N/A |
Not in use, for DocumentMessagingWS |
|
OrganizationTypeCode |
N/A |
N/A |
Not in use, for DocumentMessagingWS |
|
MessageTypeCode |
N/A |
N/A |
Not in use, for DocumentMessagingWS |
|
DocumentPhrases |
N/A |
N/A |
Not in use, for DocumentMessagingWS |
|
ComplaintResultType |
(X) |
(X) |
|
|
SystemPrintersCode |
(X) |
(X) |
|
|
PatientLeaveCode |
(X) |
(X) |
|
|
CareTypeCodes |
(X) |
(X) |
|
|
IndividualPlanRoleCodes |
(X) |
(X) |
|
|
IndividualPlanStatusCodes |
(X) |
(X) |
|
|
EvaluationPriorityCode |
(X) |
(X) |
|
|
GenericCodeSets |
(X) |
(X) |
|
|
GenericCodeValues |
(X) |
(X) |
|
|
AdmSex |
(X) |
(X) |
|
|
AdmYesNo |
(X) |
(X) |
|
|
AdmYesNoUnknown |
(X) |
(X) |
|
|
DrugOpioid |
(X) |
(X) |
|
|
DrugLivingConditions |
(X) |
(X) |
|
|
DrugSyringeUse |
(X) |
(X) |
|
|
DrugSyringeFrequency |
(X) |
(X) |
|
|
DrugSyringeNeedleSharing |
(X) |
(X) |
|
|
DrugMentalHealth |
(X) |
(X) |
|
|
DrugFrequencyOfUse |
(X) |
(X) |
|
|
DrugType |
(X) |
(X) |
|
|
DrugIngestionMethod |
(X) |
(X) |
|
|
DrugLivesWith |
(X) |
(X) |
|
|
DrugLivingChildrenU18 |
(X) |
(X) |
|
|
DrugAgeChildrenU18 |
(X) |
(X) |
|
|
DrugBloodVirusTested |
(X) |
(X) |
|
|
DrugBloodVirusType |
(X) |
(X) |
|
|
DrugFollowUp |
(X) |
(X) |
|
|
DrugTreatmentEnding |
(X) |
(X) |
|
|
DecisionGroup |
(X) |
(X) |
(Info: XML code set file) |
|
UpdatableCommonCodes |
(X) |
(X) |
(Info: XML code set file) |
|
AdmTreatmentTime |
(X) |
(X) |
|
|
PatientClassificationCode |
(X) |
(X) |
|
|
HelfoNotificationStatus |
(X) |
(X) |
|
|
PsychosocialAspects |
(X) |
(X) |
|
|
PsychosocialFunctionLeve |
(X) |
(X) |
|
|
PsychosocialFunctionType |
(X) |
(X) |
|
|
ReferralReasonChildCond |
(X) |
(X) |
|
|
ReferralReasonChildEnv |
(X) |
(X) |
|
|
ChildWelfareRole |
(X) |
(X) |
|
|
CarePeriodInfoGroupCodes |
(X) |
(X) |
|
|
PatientRelationRole |
(X) |
(X) |
|
|
CareLivingSituation |
(X) |
(X) |
|
|
PatientTranslatorNeed |
(X) |
(X) |
|
|
EPRInfoTransferConsent |
(X) |
(X) |
|
|
PatientLivingWithPartner |
(X) |
(X) |
|
|
PatientEthnicAffiliation |
(X) |
(X) |
|
|
PatientCaregiverRelations |
(X) |
(X) |
|
|
AddressPostalTypes |
(X) |
(X) |
|
|
AddressTelephoneTypes |
(X) |
(X) |
|
|
AddressEmailTypes |
(X) |
(X) |
|
|
AddressLineTypes |
(X) |
(X) |
|
|
ContactAdditionalInfoType |
(X) |
(X) |
|
|
CollInstanceServiceTypes |
(X) |
(X) |
|
|
RoomAttributeTypes |
(X) |
(X) |
|
|
CarePeriodResourceType |
(X) |
(X) |
|
|
WaitingListAdditionalInfoType |
(X) |
(X) |
|
|
DocumentLanguageCodes |
(X) |
(X) |
|
|
ContactActivityTypeCodes |
(X) |
(X) |
|
Schema for SearchCommonCodes: CommonCodesWS.xsd
Schema
documentation for CommonCodes: CommonCodes.html
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/CommonCodesWS/CommonCodesWS.asmx?op=SearchCommonCodes
Related
methods or functions used:
GetUserLogin Used
to verify user and 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 system name is also required.
An error will result if any of these are missing.
A valid authentication block for RequestHeader can be retrieved by using the
method GetUserLogin in the Authentication web service.
In the return from the method there will always
be a ResponseHeader, which contains Error Information and System Information. The Error
Information block must always be examined to determine if any error has
occurred during execution of the method.
·
The
CommonCodeId is an unique id that can identifies the single code in the PAS
system, regardless of code set/table and internal ids.
·
The
methods that supports CommonCodeId is ListCommonCode, GetCommonCode and
SaveCommonCode.
·
|
CommonCodeType |
TypeOfId |
Support Get and/or
Save |
Comments |
|
RequesterCode |
LRC |
Y |
Get/Save is
supported, but only by using Get/Save methods in RequesterWS. |
|
AdmitCode |
CCID |
N |
|
|
Rate |
CCID |
N |
|
|
MunicipalityCode |
CCID |
N |
|
|
NationalityCode |
CCID |
N |
|
|
PostCode |
CCID |
N |
|
|
LanguageCode |
CCID |
N |
|
|
LetterCode |
CCID |
N |
|
|
VDGRCode |
CCID |
N |
|
|
VHDGCode |
CCID |
N |
|
|
PriorityCode |
CCID |
N |
|
|
CancelReasonCode |
CCID |
N |
|
|
ClinicalAreaGroupCode |
CCID |
N |
|
|
FreeCode |
CCID |
N |
|
|
CashCode |
CCID |
N |
|
|
PaymentMethodCode |
CCID |
N |
|
|
RefundCode |
CCID |
N |
|
|
MaritialCode |
CCID |
N |
|
|
UrbanNeighbourhoodCode |
CCID |
N |
|
|
ContactAdmittedFromCode |
CCID |
N |
|
|
EECDocumentationCode |
CCID |
N |
|
|
ContactGategoryCode |
CCID |
N |
|
|
ContactGroupCode |
CCID |
N |
|
|
ContactDischargeCode |
CCID |
N |
|
|
ContactFinishedCode |
CCID |
N |
|
|
TransportationCode |
CCID |
N |
|
|
ContactAdmittedToCode |
CCID |
N |
|
|
ContactDischargedToCode |
CCID |
N |
|
|
ContactMeasurementCode |
CCID |
N |
|
|
ContactParticipantCode |
CCID |
N |
|
|
ContactTreaterType |
CCID |
N |
|
|
ContactTreatmentCode |
CCID |
N |
|
|
DecisionCode |
CCID |
N |
|
|
DecisionType |
CCID |
N |
|
|
ComplaintType |
CCID |
N |
|
|
ComplainResultType |
CCID |
N |
|
|
CriteriaType |
CCID |
N |
|
|
PatientAdditionalInformationCode |
CCID |
N |
|
|
PatientAdditionalInformationType |
CCID |
N |
|
|
WaitingListStatusCode |
CCID |
N |
|
|
WaitingListGuaranteeCode |
CCID |
N |
|
|
CarePeriodStatusCode |
CCID |
N |
|
|
ContactAccidentCode |
CCID |
N |
|
|
ContactStatusCode |
CCID |
N |
|
|
AppointmentType |
CCID |
N |
|
|
TypeOfCareCode |
CCID |
N |
|
|
MetaInformationCode |
CCID |
N |
|
|
OrganizationTypeCode |
CCID |
N |
|
|
MessageTypeCode |
CCID |
N |
|
|
DocumentPhrases |
CCID |
N |
|
|
SystemPrintersCode |
CCID |
N |
|
|
PatientLeaveCode |
CCID |
N |
|
|
CareTypeCodes |
CCID |
N |
|
|
IndividualPlanRoleCodes |
CCID |
N |
|
|
IndividualPlanStatusCodes |
CCID |
N |
|
|
EvaluationPriorityCode |
CCID |
N |
|
|
GenericCodeSets |
CCID |
Y |
|
|
GenericCodeValues |
CCID |
Y |
|
|
AdmSex |
CCID |
Y |
|
|
AdmYesNo |
CCID |
Y |
|
|
AdmYesNoUnknown |
CCID |
Y |
|
|
DrugOpioid |
CCID |
Y |
|
|
DrugLivingConditions |
CCID |
Y |
|
|
DrugSyringeUse |
CCID |
Y |
|
|
DrugSyringeFrequency |
CCID |
Y |
|
|
DrugSyringeNeedleSharing |
CCID |
Y |
|
|
DrugMentalHealth |
CCID |
Y |
|
|
DrugFrequencyOfUse |
CCID |
Y |
|
|
DrugType |
CCID |
Y |
|
|
DrugIngestionMethod |
CCID |
Y |
|
|
DrugLivesWith |
CCID |
Y |
|
|
DrugLivingChildrenU18 |
CCID |
Y |
|
|
DrugAgeChildrenU18 |
CCID |
Y |
|
|
DrugBloodVirusTested |
CCID |
Y |
|
|
DrugBloodVirusType |
CCID |
Y |
|
|
DrugFollowUp |
CCID |
Y |
|
|
DrugTreatmentEnding |
CCID |
Y |
|
|
DecisionGroup |
CCID |
N |
|
|
UpdatableCommonCodes |
CCID |
N |
|
|
AdmTreatmentTime |
CCID |
Y |
|
|
PatientClassificationCode |
CCID |
Y |
|
|
HelfoNotificationStatus |
CCID |
Y |
|
|
PsychosocialAspects |
CCID |
Y |
|
|
PsychosocialFunctionLeve |
CCID |
Y |
|
|
PsychosocialFunctionType |
CCID |
Y |
|
|
ReferralReasonChildCond |
CCID |
Y |
|
|
ReferralReasonChildEnv |
CCID |
Y |
|
|
ChildWelfareRole |
CCID |
Y |
|
|
CarePeriodInfoGroupCodes |
CCID |
Y |
|
|
PatientRelationRole |
CCID |
Y |
|
|
CareLivingSituation |
CCID |
Y |
|
|
PatientTranslatorNeed |
CCID |
Y |
|
|
EPRInfoTransferConsent |
CCID |
Y |
|
|
PatientLivingWithPartner |
CCID |
Y |
|
|
PatientEthnicAffiliation |
CCID |
Y |
|
|
PatientCaregiverRelations |
CCID |
Y |
|
|
AddressPostalTypes |
CCID |
N |
|
|
AddressTelephoneTypes |
CCID |
N |
|
|
AddressEmailTypes |
CCID |
N |
|
|
AddressLineTypes |
CCID |
N |
|
|
ContactAdditionalInfoType |
CCID |
N |
|
|
CollInstanceServiceTypes |
CCID |
Y |
|
|
RoomAttributeTypes |
CCID |
Y |
|
|
CarePeriodResourceType |
CCID |
Y |
|
|
WaitingListAdditionalInfoType |
CCID |
N |
|
|
DocumentLanguageCodes |
CCID |
N |
|
|
ContactActivityTypeCodes |
CCID |
Y |
|
·
·