Version: 2.3.12047
This web service is very specific for the ANP product from Tieto.
Due to the adaption of ANP specific requirements these web service methods is not suitable for use by other vendors/applications.
Web Service
with methods communicates between a LIS and ANP application. There are methods
for getting requests and results from the LIS, and methods for adding/updating
results in the LIS, adding investigations/analyses to a sample/requisition.
The AnpWS
service contains these methods:
The Web
Service reference is: AnpWS.asmx
For more
detailed information as the Web service's WSDL, SOAP request and response see:
https://linkws.service.tieto.com/LabLinkWS/AnpWS/AnpWS.asmx
Method can
be used in the following LIS:
|
NSL |
|
|
|
|
|
|
Description:
This function performs necessary and LIS specific formatting of the
service request ID.
Syntax:
formattedServReqId
= FormatServReqId(servReqId)
|
Parameter
in AddInvestigationsRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
.ServiceProviderId |
String |
|
Id
for service provider in the document, same as LabId. Used for routing
document to correct database. E.g.
TR_NSL, MO_SYMPATHY |
|
.ServReqId |
String |
14 |
Service
request id to be formatted. HIS90:
Requisition id to be formatted, read from the sample tube label. Format:
LLYYNNNNNNNNSS LL
= Lab identity, 2 digits YY
= Requisition year NNNNNNNN
= Requisition number SS
= Suffix, 2 digits |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
.FormattedServReq Id |
String |
14 |
Formatted
service request id. HIS90:
Formatted id. Format:
LLYYNNNNNNNNSS (see above) Method
is required by ANP. It will only check format of input, then return exact
same id. |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/AnpWS/AnpWS.asmx?op=FormatServReqId
Related
methods or functions used:
None
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:
This method
is not using authentication.
The return
from the method will always have a ResponseHeader,
containing Error and System Information. Error Information block must always be
checked to determine if any error, warning or information has occurred while
processing the methods.
Method can
be used in the following LIS:
|
NSL |
|
|
|
|
|
|
Description:
This method queries the LIS about which samples that belong to specific
bar codes. For each submitted identity, the server should return an
AnalysedSubjectReference structure, which both contains the identity of the
sample, according to the LIS, and references to all requests that the sample
belongs to at the moment.
HIS90: The
method will not query the LIS about sample ids, but just return a copy of the
sample ids from the input. It is required by ANP.
Syntax:
AnalysedSubjectReferenceCollection
= GetAnalysedSubjectReferences(AnalysedSubjectIdentities)
|
Parameter
in AddInvestigationsRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
.AnalysedSubject Identities[] |
String |
|
Bar
codes for which to retrieve samples. HIS90:
Will accept any format, and return a copy of the id (required by ANP). Only
the following format will be meaningful for NSL: LLYYNNNNNNNNSS. LL
= Lab identity, 2 digits YY
= Requisition year NNNNNNNN
= Requisition number SS
= Suffix, 2 digits |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
AnalysedSubjectReferenceCollection |
Structure according to AnpWS.xsd schema |
N/A dynamic |
Collection
of AnalysedSubjectReference structures, which both contains the identity of
the sample, according to the LIS, and references to all requests that the
sample belongs to at the moment. |
|
.SubjectReferences [].IdByRequester |
String |
14 |
Identity
of the sample according to LIS. Format:
String HIS90:
Requisition year/number and suffix, copied from the input. |
|
.SubjectReferences
[].RequestReferences[].ServReqId |
String |
10 |
Requests
that the sample belongs to. Format:
String HIS90:
Requisition year/number and suffix, copied from the input. |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/AnpWS/AnpWS.asmx?op=GetAnalysedSubjectReferences
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required calling a method,
containing authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
The return
from the method will always have a ResponseHeader,
containing Error and System Information. Error Information block must always be
checked to determine if any error, warning or information has occurred while
processing the methods.
Method can
be used in the following LIS:
|
NSL |
|
|
|
|
|
|
Description:
Returns a formatted version of the sample (analysed subject) barcode
string.
Syntax:
formattedSubjectId
= GetFormattedAnalysedSubjectIdentity(idByRequester)
|
Parameter
in AddInvestigationsRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
.ServiceProviderId |
String |
|
Id
for service provider in the document, same as LabId. Used for routing
document to correct database. E.g.
TR_NSL, MO_SYMPATHY |
|
.IdByRequester |
String |
14 |
Sample
(analysed subject) barcode string to be formatted. HIS90:
Requisition id from ANP to be formatted, read from the sample tube label. Format:
LLYYNNNNNNNNSS LL
= Lab identity, 2 digits YY
= Requisition year NNNNNNNN
= Requisition number SS
= Suffix, 2 digits |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
.FormattedServReq Id |
String |
14 |
Formatted
version of the sample (analysed subject) barcode string. HIS90:
Formatted id. Format:
LLYYNNNNNNNNSS (see above) Method
is required by ANP. It will only check format of input, then return exact
same id. |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/AnpWS/AnpWS.asmx?op=GetFormattedAnalysedSubjectIdentity
Related
methods or functions used:
None.
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:
This method
is not using authentication.
The return
from the method will always have a ResponseHeader,
containing Error and System Information. Error Information block must always be
checked to determine if any error, warning or information has occurred while
processing the methods.
Method can
be used in the following LIS:
|
NSL |
|
|
|
|
|
|
Description:
Returns a collection of lab reports corresponding to a given list of
analysed subjects. The ServReq structure should conform to the Norwegian KITH
standard.
If no lab reports exist for a given lab id, an empty structure will be
returned, where only the Id and IdByRequester fields are filled out.
Syntax:
ServiceRequestCollection
= GetServiceRequests(AnalysedSubjects)
|
Parameter
in AddInvestigationsRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
.ServiceProviderId |
String |
|
Id
for service provider in the document, same as LabId. Used for routing
document to correct database. E.g.
TR_NSL, MO_SYMPATHY |
|
AnalysedSubjects |
Structure according to AnpWS.xsd schema |
N/A dynamic |
Structure
containing input parameters. |
|
.ServReqId |
String |
14 |
Identity
of the service request in the LIS. HIS90:
Array of requisition year/number for requisitions to get. If requisition does
not exist, an empty, complete KITH structure is returned. Only
investigations with given suffix will be included. Although
any format is accepted, only the following format will result in a call to
NSL. Format:
LLYYNNNNNNNNSS. LL
= Lab identity, 2 digits (ignored) YY
= Requisition year NNNNNNNN
= Requisition number SS
= Suffix, 2 digits |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
ServiceRequestCollection |
Structure according to AnpWS.xsd schema |
N/A dynamic |
Collection
of requisitions on given year/number, although maximum one requisition exists
in NSL. |
|
.ServReq |
KITH ServReq structure |
Dynamic |
A
requisition or a blank KITH message. NB: Only
fields used by ANP or NSL are listed below. |
|
.ServReq. ReqComment |
String |
Dynamic |
Requestor’s
comment, free text. HIS90:
Requisition comment (type P). Format:
String |
|
.ServReq.Id |
String |
10 |
Identity
of the service request. Format:
String HIS90:
Requisition id. Format:
YYNNNNNNNN YY
= Requisition year NNNNNNNN
= Requisition number |
|
.ServReq.Requested PrioReport.V |
String |
1 |
Priority
on request level. The value should be given according to KITH code system
7303. Format:
String HIS90: N/A |
|
[Patient] .ServReq.Inv Subject.Sex.V |
String |
1 |
Patient’s
sex. Sex
should be encoded using OID <kith>.3101. http://www.volven.no/produkt.asp?id=3003&subID=
8&catID=3&oid=3101 Format:
String HIS90:
Patient’s sex. Format:
OID <kith>.3101 |
|
[Patient] .ServReq.Inv Subject.Name |
String |
Dynamic |
Patient’s
name. Format:
String HIS90:
Patient’s name. Format:
«etternavn, fornavn», string(37). |
|
[Patient] .ServReq.Inv Subject.OffId |
String |
11 |
Official
id of the patient. Format:
String HIS90:
Patient’s birth number, 11 digits. Format:
DDMMYYNNNNN. DD
= Day MM
= Month YY
= Year NNNNN
= Individual number (3), control digits (2) |
|
[Patient] .ServReq.Inv Subject.TypeOffId.V |
String |
1 |
Patient’s
official id type. Format:
String HIS90:
Type of OfficialId. Format:
String(1) F
= Birth number, 11 digits |
|
[Patient] .ServReq.InvSubject. Address.StreetAddress |
String |
Dynamic |
Patient’s
street address. Format:
String HIS90:
Patient’s address. Format:
String(45) |
|
[Patient] .ServReq.InvSubject. Address.PostalCode |
String |
Dynamic |
Patient’s
postal code. Format:
String HIS90:
Patient’s zip code. Format:
String(5) |
|
[Patient] .ServReq.InvSubject. Address.City |
String |
Dynamic |
Patient’s
city of residence. Format:
String HIS90:
Patient’s city. Format:
String(20) |
|
[Patient] .ServReq.InvSubject. Address.Country.V |
String |
Dynamic |
Patient’s
country of residence. Format:
String HIS90:
Patient’s country. Format:
String(50) |
|
[Patient] .ServReq.InvSubject. IdByServProvider |
String |
Dynamic |
Patient’s
id in LIS. NB: Same
as OffId.V. HIS90:
Patient id. Format:
Long |
|
[Material] .ServReq.InvSubject. InvMaterial |
String |
Dynamic |
Investigated
material. Format:
String HIS90:
Material description. Format:
String(25) |
|
[Material] .ServReq.InvSubject. IdByServProvider |
String |
Dynamic |
Material
id in LIS. Format:
String HIS90:
Nonhuman id (birth no). Format:
DDMMYYNNNNN. DD
= Day MM
= Month YY
= Year NNNNN
= Individual number (3), control digits (2) |
|
[Material] .ServReq.InvSubject. IdByRequester |
String |
Dynamic |
Material
id in ANP. Format:
String HIS90: N/A |
|
[Animal] .ServReq.InvSubject. Sex.V |
String |
Dynamic |
Animal’s
sex. Format:
String HIS90: N/A |
|
[Animal] .ServReq.InvSubject. Name |
String |
Dynamic |
Animal’s
name. Format:
String HIS90: N/A |
|
[Animal] .ServReq.InvSubject. IdByServProvider |
String |
Dynamic |
Animal’s
id in LIS. Format:
String HIS90: N/A |
|
[Animal] .ServReq.InvSubject. IdByRequester |
String |
Dynamic |
Animal’s
id in ANP. Format:
String HIS90: N/A |
|
.ServReq.ServProv ider.HCP.Item |
Structure |
Dynamic |
KITH:
Helsetjenesteenhet som henviser pasient til undersøkelse eller behandling. HIS90:
Institution. |
|
.ServReq.ServProv ider.HCP.Item.Id |
String |
Dynamic |
Service
provider identification. Format:
String HIS90:
Institusjonskode. Format:
String(7) |
|
.ServReq.ServProv ider.HCP.Item.Name |
String |
Dynamic |
Service
provider name. Format:
String HIS90:
Institution name. Format:
String(40) |
|
.ServReq.ServProv ider.HCP.Address.
StreetAdr |
String |
Dynamic |
Service
provider street address. Format:
String HIS90:
Hospital’s street address. Format:
String(60) |
|
.ServReq.ServProv ider.HCP.Address.
PostalCode |
String |
Dynamic |
Service
provider postal code. Format:
String HIS90:
Hospital’s zip code. Format:
String(5) |
|
.ServReq.ServProv ider.HCP.Address.City |
String |
Dynamic |
Service
provider city. Format:
String HIS90:
Hospital’s city. Format:
String(20) |
|
.ServReq.ServProv ider.HCP.Address. Country.V |
String |
Dynamic |
Service
provider country. Format:
String HIS90:
Hospital’s country. Format:
String(50) |
|
.ServReq.Requester. HCP.Item |
Structure |
Dynamic |
KITH:
Helsetjenesteenhet som henviser pasient til undersøkelse eller behandling. HIS90:
Requester. |
|
.ServReq.Requester. HCP.Item.Id |
String |
Dynamic |
Requester
identification. Format:
String HIS90:
Requester code. Format:
String(7) |
|
.ServReq.Requester. HCP.Item.Name |
String |
Dynamic |
Requester
name. Format:
String HIS90:
Requester’s name. Format:
String(40) |
|
.ServReq.Requester. HCP.Address.StreetAdr |
String |
Dynamic |
Requester
street address. Format:
String HIS90:
Requester’s street address. Format:
String(25) |
|
.ServReq.Requester. HCP.Address. PostalCode |
String |
Dynamic |
Requester
postal code. Format:
String HIS90:
Requester’s zip code. Format:
String(5) |
|
.ServReq.Requester. HCP.Address.City |
String |
Dynamic |
Requester
city. Format:
String HIS90: Requester’s
city. Format:
String(20) |
|
.ServReq.Requester. HCP.Address.Country.V |
String |
Dynamic |
Requester
country. Format:
String HIS90:
Requester’s country. Format:
String(50) |
|
.ServReq.Payment Responsible |
Structure |
Dynamic |
N/A |
|
.ServReq.CopyDest[] |
Structure |
Dynamic |
N/A |
|
.ServReq.RefDoc[] |
Structure |
Dynamic |
N/A |
|
.ServReq.ReasonAs Text[] |
Structure |
Dynamic |
N/A |
|
.ServReq.Comment[] |
Structure |
Dynamic |
N/A |
|
.ServReq. ReqInvestigation[].
ServType.V |
Structure |
Dynamic |
Each
ReqInvestigation structure contains a list of investigations to be performed,
and the specimens that they are to be performed on. |
|
.ServReq. ReqInvestigation[].
ReqDate.V |
String |
Dynamic |
TimeStamp
for when the investigation was requested. Format:
KITH_Base.TS (yyyyMMddTHHmmss). HIS90:
Date/time when the requisition was saved (REQS.REQ_DATE/REQ_TIME). Format:
YYYYMMDDTHHMM00 |
|
.ServReq. ReqInvestigation[].
Priority.V |
String |
1 |
Priority
of investigation. Format:
String HIS90: The
highest priority of all listed investigations on this requisition. Format:
String(1) Mapping:
3
= immediate (Ø) 2
= answer today (S) 1
= normal (V) |
|
.ServReq. ReqInvestigation[].
Comment |
String |
Dynamic |
Free
text comment associated with the requested investigation. Format:
String HIS90:
N/A. Sample comment (type T). Format:
String(2940) |
|
.ServReq. ReqInvestigation[].
Investigation[].Id[].V |
String |
6 |
Id
of this particular investigation. String
containing the value of the code. Example: “PAT” If
the analyses are given in the local analysis codes used by the LIS, the OID
should be “2.16.578.1.12.4.1.1.8212”, meaning that the codes are unspecified
and local. Format:
String HIS90:
Investigation code. Format:
LOnnnn “LO”
= local code (defined in ANDE.ANDE_CODE_2) nnnn
= investigation code |
|
.ServReq. ReqInvestigation[].
Investigation[].Spec[]. S |
String |
Dynamic |
If
answers to an investigation on the Service Request already has been reported,
and therefore the LIS doesn’t want any more results reported on that
investigation, this should be signalled to ANP by adding an entry in the SPEC
list as follows: <spec
S=”<labprefix>.1000” V=”ANSWERED” /> Lab
prefix set to ”0”. If result has not been reported (= first result), S and V
are set to blank. Format:
String HIS90:
Result has been saved before if status is answered (B), verified (V) or
adjusted (K). Format:
String |
|
.ServReq. ReqInvestigation[].
Investigation[].Spec[]. V |
String |
Dynamic |
See
Spec.S above. |
|
.ServReq. ReqInvestigation[].
Investigation[]. Comment |
String |
Dynamic |
Free
text comment associated with this particular investigation. Format:
String HIS90:
Investigation comment. Format:
String(2940) |
|
.ServReq. ReqInvestigation[].
Investigation[]. Priority.V |
String |
1 |
The
priority (urgency level) of this particular investigation. Can be omitted. The
priority information should be given according to <kith>.8304 or as a
LIS specific priority <labprefix>.5001. The priority information is
optional. Format:
String HIS90:
Priority code for investigation. Format:
String(1) Mapping:
3
= immediate (Ø) 2
= answer today (S) 1
= normal (V) |
|
.ServReq. ReqInvestigation[].
AnalysedSubject[]. Item |
Structure |
Dynamic |
|
|
.ServReq. ReqInvestigation[].
AnalysedSubject[]. TypeCoded.V |
String |
Dynamic |
Type
of requisition, not used now. May be needed for future communication with instrument
CIIS. HIS90: N/A |
|
.ServReq. ReqInvestigation[].
AnalysedSubject[]. IdByRequester |
String |
10 |
Identity
of the sample according to LIS. Format:
String HIS90:
Identity of sample tube or material. Format:
YYNNNNNNNN YY
= Requisition year NNNNNNNN
= Requisition number |
|
.ServReq. ReqInvestigation[].
AnalysedSubject[]. Comment |
String |
Dynamic |
Free
text comment associated with the requested investigation. Format:
String HIS90:
Requisition comment, see ServReq.ReqInvestigation[].Comment above. Format:
String(2940) [JAS:
Kommentar
om objektet som er tatt, dvs. kommentar på/om prøveglass eller materiale.] |
|
[CollectedSample] .ServReq.ReqInvestig ation[].
AnalysedSubject[]. CollectedSample. CollectedDate.V |
String |
Dynamic |
TimeStamp
for when the sample was collected. Format:
KITH_Base.TS (yyyyMMddTHHmmss). HIS90:
Collection date/time. Format:
YYYYMMDDTHHMM00 |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/AnpWS/AnpWS.asmx?op=GetServiceRequests
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required calling a method,
containing authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
The return
from the method will always have a ResponseHeader,
containing Error and System Information. Error Information block must always be
checked to determine if any error, warning or information has occurred while
processing the methods.
Method can
be used in the following LIS:
|
NSL |
|
|
|
|
|
|
Description:
Reports results from the investigation of one or more specimens.
Syntax:
AnswerReportingOutcome
= ReportAnswers(ObjectInvestigations)
|
Parameter
in AddInvestigationsRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
.ServiceProviderId |
String |
|
Id
for service provider in the document, same as LabId. Used for routing
document to correct database. E.g.
TR_NSL, MO_SYMPATHY |
|
ObjectInvestigation |
Structure according to AnpWS.xsd schema |
N/A Dynamic |
Structure
containing input parameters. NB: Only
fields used by ANP or NSL are listed below. |
|
.InstrumentId |
String |
2 |
The
identity of the apparatus that performed the analysis. Format:
String HIS90:
Instrument number (ANRE.INSTRUMENT_NO_VER). Format:
String(2) |
|
[ExistingAnalysedObject] .AnalysedObject. IdByRequester |
String |
14 |
Sample
Identity, according to LIS. HIS90:
Requisition year/number from sample label. Any id will be accepted, but only
the following format will result in an update in NSL. Format:
LLYYNNNNNNNNSS LL
= Lab identification (ignored) YYYY
= Requisition year NNNNNNNN
= Requisition number SS
= Suffix (ignored) |
|
[ExistingAnalysedObject] .AnalysedObject. IdByServProvider |
String |
Dynamic |
Internal
identity of the Sample within ANP. Format:
String HIS90: N/A |
|
[ExistingAnalysedObject] .AnalysedObject. ServReqId |
String |
Dynamic |
Identity
of the service request in the LIS. [Same contents as IdByRequester above] HIS90: N/A |
|
[ExistingAnalysedObject] .AnalysedObject. Comment |
String |
Dynamic |
Free
text comment associated with the request. Format:
String HIS90:
Requisition comment (type P). Format:
String(2940) |
|
[NewAnalysedObject] .ObjectInvestig ation.Analysed
Object.<xxx> |
Structure |
Dynamic |
POCT
sample. HIS90:
N/A. Only existing requisitions in NSL are supported. |
|
.ObjectInvestig
ation.RackInfo. RackIdentity |
String |
Dynamic |
Identity
of the rack that the specimen was placed in when being analysed. Format:
String. HIS90: N/A |
|
.ObjectInvestig
ation.RackInfo. RackPosition |
String |
Dynamic |
Position
of the specimen within the rack. Format:
String HIS90: N/A |
|
.ObjectInvestig
ation.Investigation Results[].Analysis Time.V |
String |
Dynamic |
TimeStamp
for when the result arrived from the apparatus. Format:
KITH_Base.TS (yyyyMMddTHHmmss). HIS90:
Time of collection, ignored. NSL will set this to the execution date/time. |
|
.ObjectInvestig
ation.Investigation Results[]. IdByServProvider |
String |
Dynamic |
ANPs
internal identity for this particular result. Format:
String HIS90:
Copied to IdByRequester in response. |
|
.ObjectInvestig
ation.Investigation Results[].Medical ValidationNecessary |
Boolean |
1 |
If
set to true, the result needs also to be medically validated before it is
sent to the requester. Format:
Boolean HIS90:
Result status is set according to the following: True: B
(Besvart) False: V
(Verifisert), or next status (RàV normal; BàV should not happen, already reported; VàK should not happen, already reported, KàK message “Denne raden er allerede korrigert
en gang”). |
|
.ObjectInvestig
ation.Investigation Results[].Dilution |
String |
Dynamic |
Denotes
how much the sample needed to be diluted. 1 = no dilution, 2 = diluted to
double volume, etc. Format:
Decimal HIS90: N/A |
|
.ObjectInvestig
ation.Investigation Results[].Investigation.Id[0].V |
String |
6 |
String
containing the value of the code. Example: “PAT” If
the analyses are given in the local analysis codes used by the LIS, the OID
should be “2.16.578.1.12.4.1.1.8212”, meaning that the codes are unspecified
and local. Format:
String HIS90:
Investigation code. Format:
LOnnnn “LO”
= local code (defined in ANDE.ANDE_CODE_2) nnnn
= investigation code |
|
.ObjectInvestig
ation.Investigation Results[].Investigation.Priority.V |
String |
1 |
The
priority (urgency level) of this particular result. Can be omitted. The
priority information should be given according to <kith>.8304 or as a
LIS specific priority <labprefix>.5001. Format:
String (heltall) HIS90:
Priority code. Format:
String(1) Mapping:
3
= immediate (Ø) 2
= answer today (S) 1
= normal (V) |
|
.ObjectInvestig
ation.Investigation Results[].Investigation.Comment |
String |
Dynamic |
Free
text comment associated with this particular investigation result. Format:
String HIS90:
Investigation comment. Format:
String(2940) |
|
.ObjectInvestig
ation.Investigation Results[].Result Value.FormattedResult |
String |
Dynamic |
Clear
text representation of the result. Format:
String HIS90: N/A |
|
.ObjectInvestig
ation.Investigation Results[].Result Value.InterpretationOf |
String |
Dynamic |
If
the result is an interpretation of another result value, that original value
is stored as another ResultValue descendent here. Format:
String HIS90: N/A |
|
[NumericResult] .ObjectInvestig
ation.Investigation Results[].Result Value.NumResultValue |
String |
6 |
The
numeric value of the result. Format:
Decimal HIS90:
Sample result. Format:
String(6) |
|
[NumericResult] .ObjectInvestig
ation.Investigation Results[].Result Value.ArithmeticComp |
String |
Dynamic |
Arithmetic
comparer: EQ
- equal to (default) GE
- greater than or equal to GT
- greater than LE
- less than or equal to LT
- less than MG
- much greater than ML
- much less than NE
- not equal to Format:
Coded value HIS90:
N/A. (Future
implementation: Interpret result according to these operators. E.g.
’GT’ and NumResult = 1000 è ’>1000’) |
|
[TextResult] .ObjectInvestig
ation.Investigation Results[].Result Value.TextCode |
String |
Dynamic |
A
text replacing the result, represented by a result replacing text code. Format: String HIS90:
N/A. (Future
implementation: Support strings like ‘POSITI’, ‘NEGATI’.) |
|
[DateResult] .ObjectInvestig
ation.Investigation Results[].Result Value.DateResultValue |
String |
Dynamic |
This
result format not used in this version. Format:
KITH_Base.TS (yyyyMMddTHHmmss). HIS90: N/A |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
AnswerReportingOutcome |
Structure according to AnpWS.xsd schema |
N/A dynamic |
Contains
a list describing whether or not the reporting of each investigation result
was successful. |
|
.ReportingOutcomes [].IdByProvider |
String |
Dynamic |
Returns
the ANP identity that the result was reported with. Format:
String HIS90:
Requisition year/number from IdByServProvider in AnalysedObject. Format:
YYNNNNNNNN YY
= Requisition year NNNNNNNN
= Requisition number |
|
.ReportingOutcomes [].IdByRequester |
String |
Dynamic |
The
identity of the result in LIS, if successfully reported. Otherwise, it will
be null. Format:
String HIS90:
Copy of IdByServProvider in InvestigationResults. |
|
.ReportingOutcomes [].Message |
String |
Dynamic |
Contains
a clear text error message in case the result couldn’t be reported. Format:
String HIS90:
Error message from server program. Format:
String(40) |
|
.ReportingOutcomes [].Outcome |
String |
Dynamic |
Ok
if the result was successfully reported, Duplicate if the result would
conflict with another result that already is reported, and Error otherwise. Format:
String HIS90:
Status/error code (ErrorCode from server program). Mapping: Ok
= certain status codes from NSL (001: Analyseresultater oppdatert!; 014: Utenfor ekstremgrense. Husk kommentar! 017: Ingen flere data! 034: Cut-Off.Utenfor ex.grense.OBS!kommentar! 044: Cut-Off foretatt!) Error
= others (see specific message text) Duplicate
= not used |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/AnpWS/AnpWS.asmx?op=ReportAnswers
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required calling a method,
containing authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
The return
from the method will always have a ResponseHeader,
containing Error and System Information. Error Information block must always be
checked to determine if any error, warning or information has occurred while
processing the methods.
Method can
be used in the following LIS:
|
NSL |
|
|
|
|
|
|
Description:
This method queries the result register within the LIS for already
reported results of specific investigation types within a specified time for a
patient.
HIS90: If no
results exist, an empty structure is returned and with error message (NSL
message “Ingen prøver på denne pasienten” is logged).
Syntax:
LisResultCollection
= GetPatientResults(SearchCriteria)
|
Parameter
in AddInvestigationsRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
.ServiceProviderId |
String |
|
Id
for service provider in the document, same as LabId. Used for routing
document to correct database. E.g.
TR_NSL, MO_SYMPATHY |
|
SearchCriteria |
Structure according to AnpWS.xsd schema |
N/A Dynamic |
Structure
containing input parameters. |
|
.InvSubjectId |
String |
11 |
Identity
of patient/animal whose results should be searched for. Format:
String(decimal) HIS90:
Birth number of patient for which to search for, 11 digits. Format:
DDMMYYNNNNN. DD
= Day MM
= Month YY
= Year NNNNN
= Individual number (3), control digits (2) |
|
.StartTime.V |
String |
Dynamic |
Beginning
of time period to search within. Results with a sampling time before this
time point will not be included in the search. Format:
KITH_Base.TS (yyyyMMddTHHmmss). HIS90:
Startdato/tid for søk. Prøvetakingsdato (REQS.DATE_COLL/TIME_COLL). Format:
KITH_Base.TS |
|
.EndTime.V |
String |
Dynamic |
End
of time period to search within. Results with a sampling time on and after
this time point will not be included in the search. Format:
KITH_Base.TS (yyyyMMddTHHmmss). HIS90:
Sluttdato/tid for søk. Prøvetakingsdato (REQS.DATE_COLL/TIME_COLL). Format:
KITH_Base.TS |
|
.Investigations[].V |
String |
6 |
Investigation
codes, expressed using CodedValues (with appropriate code system). HIS90:
Investigation code search for. Format:
LOnnnn “LO”
= local code (defined in ANDE.ANDE_CODE_2) nnnn
= investigation code |
|
.Investigations[]. DN |
String |
Dynamic |
String
containing a short, human-readable description of the concept that may be
abbreviated for display purposes. Example:
Participation Type (PAT) = “Patient” in HL7 Reference Information Model. Format:
String HIS90:
Investigation short name (ANDE_SHORT_NAME), not used. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
LisResultCollection |
Structure according to AnpWS.xsd schema |
N/A dynamic |
The
function GetPatientResults returns a list of sample information which in turn
contains a list of results from observations on each sample. |
|
.LisSampleInfo. IdByRequester |
String |
12 |
Identity
of the sample within LIS. Format:
String HIS90:
Requisition year/number. Format:
YYYYNNNNNNNN |
|
.LisSampleInfo. CollectionTime.V |
String |
Dynamic |
Point
in time when the sample was collected. Format:
KITH_Base.TS (yyyyMMddTHHmmss) HIS90:
Collection date/time. Format:
KITH_Base.TS |
|
.LisSampleInfo. SampleComment |
String |
Dynamic |
LIS
comment associated with the Sample. (Reported on the answer.) Format:
String HIS90:
Requisition comment (type P). Format:
String(2940) |
|
.LisSampleInfo. InternalComment |
String |
Dynamic |
Laboratory
internal sample comment. Format:
String HIS90: N/A |
|
.LisSampleInfo. InternalComment |
String |
Dynamic |
Laboratory
internal sample comment. Format:
String HIS90: N/A |
|
.LisSampleInfo. AnamnesisComment |
String |
Dynamic |
Anamnesis. Format:
String HIS90: N/A |
|
.LisSampleInfo. LisResults[].Analysis
Time.V |
String |
Dynamic |
Point
in time when the analysis was registered. Format:
KITH_Base.TS (yyyyMMddTHHmmss) HIS90:
Registration date/time of result. Format:
KITH_Base.TS |
|
.LisSampleInfo. LisResults[].Investig
ationId |
String |
Dynamic |
The
analysis that was performed. HIS90:
Investigation code. Format:
LOnnnn “LO”
= local code (defined in ANDE.ANDE_CODE_2) nnnn
= investigation code |
|
.LisSampleInfo. LisResults[].Result Value |
String |
Dynamic |
Measured
result value. This is either a NumericResult, a TextResult or a DateResult.
It contains the raw result value as well as the formatted representation. Format:
NumericResult, TextResult, DateResult HIS90:
Investigation result. Numerical: NumericResult; else TextResult. Format:
String(6) |
|
.LisSampleInfo. LisResults[].Comment |
String |
Dynamic |
Analysis
comment. Format:
String HIS90:
Investigation comment. Format:
String(2940) |
|
.LisSampleInfo. LisResults[].ServReqId |
String |
Dynamic |
Sample
Identity, according to LIS. HIS90: See
IdByRequester above. |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/AnpWS/AnpWS.asmx?op=GetPatientResults
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required calling a method,
containing authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
The return
from the method will always have a ResponseHeader,
containing Error and System Information. Error Information block must always be
checked to determine if any error, warning or information has occurred while
processing the methods.
Method can
be used in the following LIS:
|
NSL |
|
|
|
|
|
|
Description:
Adds new requested investigations to a ServiceRequest. The investigations
listed are requested being performed on the specific sample having the given
sampleId belonging to the specific request having the given requestId.
Syntax:
AddInvestigationAnswer
= AddInvestigations(InvestigationsToAdd)
|
Parameter
in AddInvestigationsRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
.ServiceProviderId |
String |
|
Id
for service provider in the document, same as LabId. Used for routing
document to correct database. E.g.
TR_NSL, MO_SYMPATHY |
|
InvestigationsToAdd |
Structure according to AnpWS.xsd schema |
N/A Dynamic |
Structure
containing input parameters. |
|
.ServReqId |
String |
12/14 |
Sample
identity according to LIS. Valid
formats are: YYNNNNNNNN, YYYYNNNNNNNN YY/YYYY
= requisition year (without/with century) NNNNNNNN
= requisition number |
|
.SpecimenId |
String |
Dynamic |
LIS
identity of the sample at this position in the batch. Format:
String (decimal) HIS90: N/A |
|
.Investigations[]. Id[0].OT |
String |
Dynamic |
String
which describes an element within a coded set. This is the text, phrase,
etc., that is the basis for the coding. (e.g., “Insulin-dependent diabetes mellitus”
which is mapped on to the three-letter abbreviation "E10" by
the ICD-10 International Classification of Diseases coding scheme. This can
also be designated as the “Term”. Format:
String HIS90: N/A |
|
.Investigations[]. Id[0].V |
String |
6 |
String
containing the value of the code. Example: “PAT” If
the analyses are given in the local analysis codes used by the LIS, the OID
should be “2.16.578.1.12.4.1.1.8212”, meaning that the codes are unspecified
and local. Format:
String HIS90:
Investigation code. Format:
LOnnnn “LO”
= local code (defined in ANDE.ANDE_CODE_2) nnnn
= investigation code |
|
.Investigations[]. Id[0].DN |
String |
Dynamic |
String
containing a short, human-readable description of the concept that may be
abbreviated for display purposes. Example:
Participation Type (PAT) = “Patient” in HL7 Reference Information Model. Format:
String HIS90: N/A |
|
.Investigations[]. Spec[0].S |
String |
Dynamic |
(Optional)
Way of furthermore specifying which investigation that should be added. What
alternatives that may be used here is highly dependent on the ordered
investigation and the LIS. HIS90: N/A |
|
.Investigations[]. Spec[0].OT |
String |
Dynamic |
String
which describes an element within a coded set. This is the text, phrase,
etc., that is the basis for the coding. This
can also be designated as the “Term”. Format:
String HIS90: N/A |
|
.Investigations[]. Spec[0].V |
String |
Dynamic |
String
containing the value of the code. Example: “PAT” Format:
String HIS90: N/A |
|
.Investigations[]. Spec[0].DN |
String |
Dynamic |
String
containing a short, human-readable description of the concept that may be
abbreviated for display purposes. Format:
String HIS90: N/A |
|
.Investigations[]. Comment |
String |
Dynamic |
Free
text comment associated with this particular investigation result. Format:
String HIS90: N/A |
|
.Investigations[]. Priority.V |
String |
1 |
The
priority (urgency level) of this particular result. Can be omitted. The
priority information should be given according to <kith>.8304 or as a
LIS specific priority <labprefix>.5001. Format:
String (integer) HIS90:
Priority code. Not required. Format:
String(1) Mapping:
3
= immediate (Ø) 2
= answer today (S) 2
= normal (V), default |
|
.Investigations[]. Priority.DN |
String |
Dynamic |
String
containing the value of the code. Example: “PAT” Format:
String HIS90: N/A |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
AddInvestigationsAnswer |
Structure according to AnpWS.xsd schema |
N/A dynamic |
AddInvestigations
will return an AddInvestigationsAnswer structure holding an outcome field. |
|
.Outcome |
String |
Dynamic |
Depending
on the success of adding the given investigations, this field will have one
of the following values: -
OK -
NOT_SUPPORTED: SQL error + all other errors -
INVALID_INVESTI-GATIONS -
UNKNOWN_REQUEST -
UNKNOWN_SAMPLE (N/A) -
ALREADY_ORDERED |
|
.Description |
String |
Dynamic |
The
Description field might contain a cleartext description of the error that
caused the problem. HIS90:
Error message text from NSL or web service method. |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/AnpWS/AnpWS.asmx?op=AddInvestigations
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication block in return.
Other
references:
RequestHeader Information required calling a method,
containing authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid Authentication
Block for RequestHeader the can be
retrieved by using the method GetUserLogin in
Authentication-Web Service.
The return
from the method will always have a ResponseHeader,
containing Error and System Information. Error Information block must always be
checked to determine if any error, warning or information has occurred while
processing the methods.