Version: 2.3.12044
Web Service
with methods to save a requisition to NSL and NSML database. And to get
requisition numbers from provider/lab system.
All methods
require a correct and verified Authentication Block from AuthenticationWS to
get any information from the HIS.
The
RequisitionWeb Service contains these methods:
The Web
Service reference is: RequisitionWS.asmx
For more
detailed information as the Web Service's WSDL, SOAP request and response see:
https://linkws.service.tieto.com/LabLinkWS/RequisitionWS/RequisitionWS.asmx
Applicable
LIS for the method:
|
NSL |
NSML |
|
|
|
|
|
Method can
be used in the following versions of the Web Service:
|
2.0 |
|
|
|
|
|
|
Description:
The method saves a requisition based on the KITH Rekvisisjon-v13.xsd
scheme as input to the database. The method can not update an existing
requisition, only add new requisitions.
Method can be used with NSL and NSML lab systems.
Syntax:
TehcObject =
SaveRequisition(RequisitionRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
RequisitionRequest |
Data
structure containing
KITH message according to Rekvisisjon-v13.xsd
scheme |
N/A Dynamic |
A requisition based on the KITH Requisition
scheme as input. The KITH message goes into the RequisitionRequest/Message
value. See schema for more details. |
Details of
the data structure RequisitionRequest/Message for saving information to
SaveRequisition
The Lab
Type column describes which message type the field is used in:
Valid
message types for LabLinkWS is C and M
(Only values
in the schema used by NSL and NSML is described here)
|
Name (All bold are required) |
Lab Type |
Description
– Data format – Valid data |
|
Message/Type |
C, M |
Always
R E.g.
V="R" DN="Rekvisisjon" |
|
Message/MIGVersion |
C, M |
Message version from KITH. Now this is v1.3 2003-10-13 |
|
Message/GenDate |
C, M |
Date
when message is generated. Format
CCYY-MM-DDThh:mm:ss |
|
Message/MsgId |
C, M |
Unique
id for this message. E.g. GUID |
|
Message/ServReq/ServType |
C, M |
Requisition
action/type N:
Ny (new), M: Endring (Modified), C: Kansellering (Cancelled). E.g.
V="N" DN="Ny" |
|
Message/ServReq/IssueDate |
C, M |
Date
when requisition is issued. Format
CCYY-MM-DDThh:mm:ss |
|
Message/ServReq/MsgDescr |
C, M |
Type
of laboratory system to use. Valid
values is CLIN(Clinical Chemical) or MBIO(Microbiology) |
|
Message/ServReq/Id |
C, M |
Unique
reference id from requester. ID is stored in lab system and sent back with
the answers/report. Reference between requisition and reports by the
requesting system and used to identify these. E.g. GUID from requester or requester local
requisition number. |
|
Message/ServReq/RequestedDateReport |
C, M |
Date
when report is wanted if RequestedPrioReport
is set to DATO |
|
Message/ServReq/RequestedPrioReport |
C, M |
Priority
for all requisition. Valid
values are OHJELP, NORM, TEL or DATO.
E. g. V="NORM" DN="Normal" |
|
Message/ServReq/Patient/Sex |
C, M |
The
patient’s sex. Valid values are 1=Mann/Man,
2=Kvinne/Woman, 9=Ukjent/Unkwon E.g.
V=”1” DN=”Mann” |
|
Message/ServReq/Patient/Name |
C, M |
Patient’s
name. Family name and first name for the patient. |
|
Message/ServReq/Patient/IdByServProvider |
C, M |
ID
(Requisition year and number) for service provider. For
NSL and NSML this is year and 8 digits requisition number. Valid
formats are: XXXXCCYYNNNNNNNN , LLCCYYNNNNNNNN or LLYYNNNNNNNN. XXXX is LabSystem(SubSys for NSL/NSML), LL
is LabId(alphanumeric), CCYY and YY is year and NNNNNNNN is requisition
number. N is between 0 to 9 |
|
Message/ServReq/Patient/OffId |
C, M |
Patients
Official Id 11 numbers. |
|
Message/ServReq/Patient/TypeOffId |
C, M |
Type
of official id. Valid
values are: FNR = Fødselsnummer/OfficialId
HNR= Hjelpenummer/nødnummer/EmergencyId E.g.
V="FNR" DN="Fødselnummer" |
|
Message/ServReq/Patient/InfItem/Observation/Description |
C, M |
Description
of the infection if it exists. This
is added to the requisition's comments. |
|
Message/ServReq/Patient/InfItem/Observation/CodedDescr |
C, M |
Infection risk code. E.g. V="INCO"
S="LO" DN=
"Kontaktsmitte" This
is added to the requisition's comments. |
|
Message/ServReq/Patient/InfItem/Type |
C, M |
If
infection risk set to V="SMITTE" DN="Smitte
opplysninger". If no infection risks leave InfItem tag out pf message. |
|
Message/ServReq/ServProvider/Role |
C, M |
Always
set to V="SPR" DN="Tjenesteyter" |
|
Message/ServReq/ServProvider/HCP/Inst/Id |
C, M |
Unique
for the laboratory, used by Web Service to determine which server, database
and subsystem to use. This
value is configures in ConfigManager for the Web Service to match the input
in the scheme. |
|
Message/ServReq/ServProvider/HCP/Inst/TypeId |
C, M |
For
service providers this is always set to V="LIN" DN="Lokal
identifikator for institusjoner"
|
|
Message/ServReq/ServProvider/HCP/Inst/Name |
C, M |
Name of the service provider. |
|
Message/ServReq/Requester/Role |
C, M |
Always set to V="REQ"
DN="Rekvirent" |
|
Message/ServReq/Requester/HCP/Inst/Dept/Id |
C, M |
The
code for the requester. Code
is the local requester code in the NSL or NSML lab system. Can be retrieved
by RequesterWS/ListRequester. |
|
Message/ServReq/Requester/HCP/Inst/Dept/TypeId |
C, M |
For local requester(departments or
units) this is always set to V="LAV" DN="Lokal identifikator
for avdelinger" |
|
Message/ServReq/Requester/HCP/Inst/Dept/Name |
C, M |
Name of the requester. |
|
Message/ServReq/Requester/HCP/Inst/HCPerson /Id |
C, M |
Id of the responsible doctor.
HER-id or HPR number. |
|
Message/ServReq/Requester/HCP/Inst/HCPerson /TypeId |
C, M |
If HER-id is used set to
V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret
(HER)" If HPR number is used set to
V="HPR" DN="Off. identifikator for helsepersonell
(HPR-nummer)" |
|
Message/ServReq/Requester/HCP/Inst/HCPerson /Name |
C, M |
Family
name and first name for the patient's responsible doctor. Format:
Family name , First name + Middle names |
|
Message/ServReq/Comment/Heading |
C, M |
Type of comment. Valid values are:
TEL, ADM or SH. For RoS/NSL/NSML use TEL or SH. E.g. V="SH"
DN=”Spesielle hensyn” |
|
Message/ServReq/Comment/TextResultValue |
C, M |
Reason
(possible indication) for the investigation. This
is added to the requisition's comments. |
|
Message/ServReq/ReqInvestigation |
C, M |
The
investigations requested on the sample. Contains array of priority,
investigations and analysed subject. |
|
Message/ServReq/ReqInvestigation/ServType |
C, M |
Can be N New, M Modified or C
Cancelled. For NSL and NSML always new. Valid values are: V="N"
DN="Ny", V="M" DN="Endring" or V="C"
DN="Kansellering" |
|
Message/ServReq/ReqInvestigation/Priority |
C, M |
Maximum number of days (24 hours
days) before report is wanted. E.g. 0 means now/emergent and 1 means report
is wanted within 24 hours. NSL and NSML use 0, 1 or 2 for
priority. 0=ØHJELP/EMERGENT
(Umiddelbart), 1=ASAP(Innen 24 timer),
2=ROUTINE(Innen 48 timer) E.g. V="0"
DN="Umiddelbart" V="1" DN="Innen 24
timer" |
|
Message/ServReq/ReqInvestigation/Investigation/Id |
C, M |
Investigations
code. For
NSL formatted according to NKKKL standard. With prefix e.g. NPU, NO or LO +
the code number. For
NSL use S="2.16.578.1.12.4.1.1.7230" to identify NKKL codes. E.g.
V="LO0039" S="2.16.578.1.12.4.1.1.7230"
DN="ALAT" For
NSML local investigation code. For
NSL use S="2.16.578.1.12.4.1.1.8212" to identify local microbiology
codes. E.g. V="B1"
S="2.16.578.1.12.4.1.1.8212" DN="Aerob 1" |
|
Message/ServReq/ReqInvestigation/Investigation/Comment |
C, M |
Investigation
comments. This
is added to the requisition's comments with the investigation code as prefix
for the comment. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/CollectedSample/CollectedDate |
C, M |
Before collecting sample this is
the date and time wanted, after the collection this reflects actual collected
date time. Format: CCYY-MM-DDThh:mm:ss E.g.
V="2004-08-17T12:00:00" |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/CollectedSample/CollectorComment |
C, M |
Comment from collector. This
is added to the requisition's comments. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/CollectedSample/CollectorSign |
C, M |
Signature (Whom) collected the
sample. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/Type |
C, M |
NSL/CLIN: For NSL this contains
type of tube/glass. As text. NSML/MBIO: Contains the materiel
coded value. Described by local code and description. Format: local
code^description E.g. for blood this gives the NSML
value BLO^BLOD |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/Comment |
C, M |
Comment on the subject to be
analysed. This
is added to the requisition's comments. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/AnatomicalOrigin |
C, M |
NSL/CLIN:
Text to describe location. OPTIONAL, as this is added to the requisition's
comments. NSML:/MBIO:
Location where the analysed subject is taken from on the patient. Optional. Described by local code and description. Format: local
code^description |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/Number |
C, M |
Number
of tubes/glasses needed or used. This
is added to the requisition's comments. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/SampleHandling |
C, M |
Sample
handling or procedure information needed by the lab system. This
is added to the requisition's comments. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/SubjectMeasure/TypeQuantity |
C, M |
Quantities
for analysed subject(e.g. test-tube or patient) Can
be patient's weight or height/length. Week’s
pregnant if the patient is pregnant. This
is added to the requisition's comments. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/SubjectMeasure/Quantity |
C, M |
Values
and unit for quantity type. Can be 55 kg, 155 cm or 25 ml E.g.
V=”55” U=”kg” This
is added to the requisition's comments. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/Pretreatment/Heading |
C, M |
Pre-treatment
that can affect the analysed subject. Valid
values are: MEDB=Medikamentell behandling, DI=Diett or FA=Faste E.g.
V="FA" DN="Faste" This
is added to the requisition's comments. |
|
Message/ServReq/ReqInvestigation/AnalysedSubject/Pretreatment/TextResultValue |
C, M |
Description
of the pre-treatment. This
is added to the requisition's comments. |
Schema for
KITH Rekvisisjon-v13.xsd: Rekvisisjon-v13.xsd
Schema for
KITH Rekvisisjon-v13-TE-CLIN-MBIO.xsd for TE: Rekvisisjon-v13-TE-CLIN-MBIO.xsd
Schema for
KITH Rekvisisjon-v13.xsd picture: KITH Rekvisisjon
CLIN-MBIO.png
Schema
documentation for KITH Rekvisisjon-v13.xsd: KITH
Requisition 13.html
Schema
documentation for KITH Rekvisisjon-v13-TE-CLIN-MBIO.xsd TE: KITH
Requisition CLIN-MBIO 13.html
Sample xml file
for KITH Rekvisisjon-v13 Clinical Chemical: KITH Rekvisisjon CLIN.xml
Sample xml
file for KITH Rekvisisjon-v13 Microbiology: KITH Rekvisisjon MBIO.xml
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
RequisitionResponse |
N/A |
N/A Dynamic |
Used
for response status and error reporting. See
ResponseHeader/ErrorInformation for warning and errors. ResponseHeader.ErrorInformation.Code
is <> 0 then error. Also
check if warning or information in
ResponseHeader.ErrorInformation.Severity and Description contains
message. |
Details of
the data structure RequisitionResponse from SaveRequisition
|
Name |
Type |
Description
– Data format – Valid data |
|
RequsitionYear |
String |
Requisition
year, Format CCYY |
|
RequsitionNumber |
String |
Requisition number Format: NNNNNNNN |
|
LabId |
String |
Information
about selected provider/Lab identification. From Message.ServReq.ServProvider.HCP.Inst.Id |
|
ExternalId |
String |
Unique
id from requesting application, taken from Message/ServReq/Id. |
|
ProviderSystem |
String |
Information
about selected lab system. E.g. CSLSection, SubSystem or LabType |
|
ServerMessage |
String |
Any messages/information from the
database |
|
Status |
String |
Same
as ErrorInformation.Code |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/RequisitionWS/RequisitionWS.asmx?op=SaveRequisitionKITH
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.
Applicable
LIS for the method:
|
NSL |
NSML |
|
|
|
|
|
Method can
be used in the following versions of the Web Service:
|
1.0 |
2.0 |
|
|
|
|
|
Description:
The method saves a requisition based on the ServiceRequestNSL.xsd scheme
as input to the database. The method can not update an existing requisition,
only add new requisitions.
This method
can automatically acquire a NSL requisition number and year for requisition if
configured in ConfigManager.
Method can be used with only NSL lab systems.
Syntax:
TehcObject =
SaveRequisition(ServiceRequestNSL/EHCM)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
ServiceRequestNSL/
EHCM |
Data
structure according
to ServiceRequestNSL.xsd
scheme |
N/A Dynamic |
A requisition based on the ServiceRequestNSL
scheme as input. The Tag name in EHCM(not ServicRequest). See schema for more details. |
Some
details of the data structure ServiceRequestNSL for saving information to
SaveRequisition
(Only values in the schema used by NSL is
described here)
|
Name |
Type |
Length Byte |
Description
– Data format – Valid data |
|
EHCM/Body/ServiceRequest/ServiceProvider/Organisation/AgreedId |
String |
N/A Dynamic |
Required. Laboratory
identification. Unique for the laboratory, used by Web Service to determine
which server, lab type, database and subsystem to use. This
value is configured in ConfigManager for the Web Service to match the input
in the EHCM scheme. |
|
EHCM/Body/ServiceRequest/Investigations/RequestedInvestigation |
Dynamic |
|
Required. The
investigations requested on the sample. Contains array of priority and
investigations. |
|
EHCM/Body/ServiceRequest/Patient/OfficialId |
String |
|
Required. Patients
Official Id 11 numbers. |
|
EHCM/Body/ServiceRequest/ServiceRequester/Organisation/RequesterId |
String |
|
Required. The
code for the primary requester. Code
must be in the NSL lab system. |
|
EHCM/Body/ServiceRequest/CopyRecipient/Organisation/RequesterId |
String |
|
The
code for the secondary requester if needed. Used for copy of answer/report . Code
must be in the NSL lab system. |
|
EHCM/Body/ServiceRequest/AgentAdmInfo/Location/Room |
String |
|
Patient's
room number. Optional. |
|
EHCM/Body/ServiceRequest/PlannedTime |
Date
Time |
|
Required. |
|
EHCM/Body/ServiceRequest/Investigations/RequestedInvestigation[]/Priority |
String |
|
Priority
for investigation. Valid values is ROUTINE, ASAP or EMERGENT If
blank or omitted the priority is set to ROUTINE. |
|
EHCM/Body/ServiceRequest/RequesterId |
String |
|
Required. Unique
ID forms the requester. This ID is sent back with the answers/report and is
used by the requesting system to identify these. |
|
EHCM/Body/ServiceRequest/Samples/InfectionRiscCode |
String |
|
Infection
risk code. |
|
EHCM/Body/ServiceRequest/ServiceRequester/Professional/NameDetails/FamilyName |
String |
|
Family
name for the patient's responsible doctor. |
|
EHCM/Body/ServiceRequest/ServiceRequester/Professional/NameDetails/FirstName |
String |
|
First
name for the patient's responsible doctor. |
|
EHCM/Body/ServiceRequest/ServiceRequester/Professional/NameDetails/DailyName |
String |
|
Family
name and first name for the patient's responsible doctor. Format:
Family name , First name + Middle names |
|
EHCM/Body/ServiceRequest/Investigations/RequestedInvestigation[]/Investigation/Code |
String |
|
Required. Investigations
code. Format according to NKKKL standard. With prefix e.g. NPU, NO or LO +
the code number. |
|
EHCM/Body/ServiceRequest/ClinicalInfo/Type
EHCM/Body/ServiceRequest/ClinicalInfo/Description
EHCM/Body/ServiceRequest/ClinicalInfo/Certainty |
String String String |
|
Clinical
information if needed. This
is added to the requisition's comments. |
|
EHCM/Body/ServiceRequest/Investigations/RequestedInvestigation[]/Investigation/Comment |
String |
|
Investigation
comments. This
is added to the requisition's comments with the investigation code as prefix
for the comment. |
|
EHCM/Body/ServiceRequest/Patient/Weight |
String |
|
Patient's
weight. This
is added to the requisition's comments. |
|
EHCM/Body/ServiceRequest/Patient/Length |
String |
|
Patient's
height/length. This
is added to the requisition's comments. |
|
EHCM/Body/ServiceRequest/Reason |
String |
|
Reason(possible
indication) for the investigation. This
is added to the requisition's comments. |
|
EHCM/Body/ServiceRequest/RequesterComment |
String |
|
Comment
for the requisition. This
is added to the requisition's comments. |
|
EHCM/Body/ServiceRequest/Patient/PregnancyWeek |
String |
|
Week’s
pregnant if the patient is pregnant. This
is added to the requisition's comments. |
Schema for
ServiceRequestNSL: ServiceRequestNSL.xsd
Schema for
ServiceRequestNSL picture: ServiceRequestNSL.png
Schema
documentation for ServiceRequestNSL: ServiceRequestNSL.html
Sample xml
file for ServiceRequestNSL: ServiceRequestNSL.xml
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
RequisitionResponse |
N/A |
N/A Dynamic |
Used
for response status and error reporting. See
ResponseHeader/ErrorInformation for warning and errors. ResponseHeader.ErrorInformation.Code
is <> 0 then error. Also
check if warning or information in
ResponseHeader.ErrorInformation.Severity and Description contains
message. |
Details of
the data structure RequisitionResponse from SaveRequisition
|
Name |
Type |
Description
– Data format – Valid data |
|
RequsitionYear |
String |
Requisition
year, Format CCYY |
|
RequsitionNumber |
String |
Requisition number Format: NNNNNNNN |
|
LabId |
String |
Information
about selected provider/Lab identification. From Message.ServReq.ServProvider.HCP.Inst.Id |
|
ExternalId |
String |
Unique
id from requesting application, taken from Message/ServReq/Id. |
|
ProviderSystem |
String |
Information
about selected lab system. E.g. CSLSection, SubSystem or LabType |
|
ServerMessage |
String |
Any messages/information from the
database |
|
Status |
String |
Same
as ErrorInformation.Code |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/RequisitionWS/RequisitionWS.asmx?op=SaveRequisitionEHCM
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.
Applicable
LIS for the method:
|
NSL |
NSML |
|
|
|
|
|
Method can
be used in the following versions of the Web Service:
|
2.0 |
|
|
|
|
|
|
Description:
Get one requisition number from the provider/Lab system.
Method can be used with only NSL lab systems.
Syntax:
RequisitionNumbers =
GetRequisitionNumber(LabId)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
LabId |
String |
N/A Dynamic |
Lab id for the provider. This is configured
in the ConfigManager for the Web Service. This is a unique id to identify the
provider’s database (CSLSection) and SubSystem. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
RequisitionNumbers |
N/A |
N/A Dynamic |
Array
containing one to many RequisitionNumbers and Year.
|
One item in
RequisitionNumbers from GetRequisitionNumber
|
Name |
Type |
Description
– Data format – Valid data |
|
RequsitionYear |
String |
Requisition
year, Format CCYY |
|
RequsitionNumber |
String |
Requisition number Format: NNNNNNNN |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/RequisitionWS/RequisitionWS.asmx?op=GetRequisitionNumber
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.
Applicable
LIS for the method:
|
NSL |
NSML |
|
|
|
|
|
Method can
be used in the following versions of the Web Service:
|
2.0 |
|
|
|
|
|
|
Description:
Get a block of many requisition numbers from the provider/Lab system.
Method can be used with only NSL lab systems.
Syntax:
RequisitionNumbers =
GetRequisitionNumbers(LabId, NumberOfRequisitionNumbers)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
LabId |
String |
N/A Dynamic |
Lab id for the provider. This is configured
in the ConfigManager for the Web Service. This is a unique id to identify the
provider’s database (CSLSection) and SubSystem. |
|
NumberOfRequisitionNumbers |
Int |
4 byte |
A number telling g how many requisition
number to get. From 1 to 99 |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
RequisitionNumbers |
N/A |
N/A Dynamic |
Array
containing one to many RequisitionNumbers and Year.
|
One item in
RequisitionNumbers from GetRequisitionNumber
|
Name |
Type |
Description
– Data format – Valid data |
|
RequsitionYear |
String |
Requisition
year, Format CCYY |
|
RequsitionNumber |
String |
Requisition number Format: NNNNNNNN |
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/RequisitionWS/RequisitionWS.asmx?op=GetRequisitionNumbers
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.
Applicable
LIS for the method:
|
NSL |
NSML |
Sympathy |
FlexLab Chemistry |
FlexLab Micro |
|
|
Method can
be used in the following versions of the Web Service:
|
2.3 |
|
|
|
|
|
|
Description:
The method saves a requisition scheme as input to the database. The
method can not update an existing requisition, only add new requisitions.
The format of a requisition can be several formats, supported formats
are: KITH1.3, KITH1.4, EHCM
In the future formats like HL7 v3 can be added
Method can be used with NSL and NSML lab systems. Sympathy also support
this method in their implementation of LabLink RequisitionWS
Syntax:
SaveRequisitionAnyResponse
= SaveRequisitionAny(SaveRequisitionAnyRequest)
|
Parameter
in SaveRequisitionAnyRequest |
Type |
Length
byte |
Description
– Data format – Valid data |
|
Document |
AnyType |
N/A Dynamic |
The request/requisition document |
|
DocumentType |
String |
N/A Dynamic |
Type of content in document. Only used if document type cannot be found
automatically in the document. Valid values are: KITH1.3 KITH1.5 EHCM Future expansion will be: HL7 |
|
MessageId |
String |
N/A Dynamic |
Message id from sender Only used/supported if LAB system can use it |
|
Returned
parameter SaveRequisitionAnyResponse |
Type |
Length
Byte |
Description
– Comments |
|
Status.Delivered |
Boolean |
N/A Dynamic |
Is
true if request/requisition is received ok by the LAB system. False if
request/requisition fails to be saved. |
|
Status.ValidationPerformed |
Boolean |
N/A Dynamic |
Is
true if validation of request/requisition has been tried by the LAB system.
False if no validation is done. Requeired if Delivered above is true. |
|
Status.ValidationSuccessful |
Boolean |
N/A Dynamic |
Is
true if validation of request/requisition is successful by the LAB system.
False if validation has failed. Requeired if ValidationPerformed above is
true. |
|
Status.Message |
String |
N/A Dynamic |
Message
with status, warning or error regarding delivery and/or validation of
message. |
|
DocumentInfo.ServiceProviderId |
String |
N/A Dynamic |
Id
for service provider from the document in request, same as LabId. Used for
routing document to correct database. E.g.
TR_NSL, MO_SYMPATHY |
|
DocumentInfo.LabType |
String |
N/A Dynamic |
Lab
type in document. E.g. CLIN, MBIO, HIST, CYTO |
|
DocumentInfo.LabDocumentId |
String |
N/A Dynamic |
Unique
id for LAB and report/request. Can
be a combined id. |
|
DocumentInfo.RequestYear |
String |
N/A Dynamic |
Request/Requisition
year in document |
|
DocumentInfo.RequestNumber |
String |
N/A Dynamic |
Request/Requisition
number in document |
|
DocumentInfo.ProviderSystem |
String |
N/A Dynamic |
E.g.
SubSystem in NSL/NSML |
|
DocumentInfo.ExternalId |
String |
N/A Dynamic |
External
id in document from sender linking all documents together. e.g. ActivityGUID
in RoS |
|
DocumentInfo.MessageId |
String |
N/A Dynamic |
Message
id from sender regarding the specific message/request saved. Only
used/supported if LAB system can use it |
|
AppRec |
AnyType |
N/A Dynamic |
Application
receipt in KITH format. |
Schema for
SaveRequisitionAny is in RequisitionWS.xsd: RequisitionWS.xsd
Schema
documentation for RequisitionWS.xsd: RequisitionWS.html
Web Service Response and Request:
See https://linkws.service.tieto.com/LabLinkWS/RequisitionWS/RequisitionWS.asmx?op=SaveRequisitionAny
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.
