Version: 2.1.17180
The Web
Service includes methods for accessing waitinglist and careperiods.
The WaitlingListWS
Web Service contains these methods:
The Web Service reference is: WaitingListWS.asmx
Open in a
Web Browser for more detailed information about each method. The Web Service's WSDL, SOAP request and
response is described.
The result
of WaitingListWS.asmx presented in a browser:
https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
The method
is used for listing waiting lists of a selected patient. The list can be
filtered on either care period status or waiting list status and selected
clinical area and/or the resource responsible for evaluating the waiting list.
Syntax:
ListWaitingListsResponse
= ListWaitingLists(ListWaitingListsRequest)
|
Parameter
in |
Type |
Length
byte |
Description
Data format Valid data |
|
ListWaitingListsRequest: |
|
N/A Dynamic |
ListWaitingListsRequest class according to XML schema WaitingList.xsd. |
|
PatientId |
|
|
HIS
Internal patient id |
|
Status.CarePeriod |
|
|
Status
for care periods. HIS90: See
codetable for valid CarePeriod statuses.
Default is OPEN. |
|
Status.WaitingList |
·
|
·
|
Status
for waiting lists. HIS90: See
codetable for valid waiting list
statuses. Default is 0 (All waitinglists) |
|
ClinicalAreaCode |
|
|
If
no code is specified all clinical areas will be listed. Valid
values can be retrieved by using the CommonCodesWS.ListCliniclaAreaGroupCodes. |
|
Resources.EvaluatedBy.Id |
|
|
The
resource responsible for the evaluation. HIS90: PaqBook.Treated_BY |
|
Returned
parameter |
Type |
Length
Byte |
Description
Comments |
|
ListWaitingListsResponse
|
|
N/A Dynamic |
ListWaitingListsResponse class according to XML schema WaitingList.xsd. |
|
Patient.Id.PatientId |
|
|
HIS Internal patient id |
|
WaitingList.Id |
string |
|
The internal id for the waitinglist. HIS90: Combined id
WaitingListId Format: PatientId|BookingNo |
|
WaitingList.Contacts.ContactId |
string |
|
Contact(s) the
waitinglist has resulted in. If blank/null then
no contact is associated with the waiting list. Is normally one contact but
can be several. Use ContactId with ContactWS to get more information
about the contact. |
|
WaitingList.Contacts.Status.Code |
string |
|
Contact status code. Valid values are: AK (active/aktiv) UT
(discharged/utskrevet) IM
(Ikke møtt/Did not meet) |
|
WaitingList.Contacts.Status.Text |
string |
|
Description of status. For Inpatients text can be: AK = Innliggende/In-patient
UT =
Discharged/Utskrevet For Outpatients text can be: AK =
Out-patient visit arrival registered/ Ankomstregistrert UT =
Out-patient visit finished registered/ Besøksregistrert IM =
Ikke møtt/Not meet |
|
WaitingList.CarePeriod.Id |
string |
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
SequenceNumber |
|
|
The sequence number of the care period. HIS90: CAPE_NO |
|
WaitingList.CarePeriod.Status.Code |
|
|
Status of the care period. HIS90: Status code is
derived from the contents of StatusDate2 and StatusDate3. See codetable for valid care period statuses. |
|
WaitingList.CarePeriod.Status.Text |
|
|
Set by the web service based on the status code
value |
|
WaitingList.CarePeriod.WaitingTimeEndedDate |
|
|
Status date when the waiting time has ended. HIS90: NoDate/Empty = Treatment is not started. Date = Waiting time has ended. Ready for
treatment/booking time. |
|
WaitingList.CarePeriod.CarePeriodClosedDate |
|
|
Status date of care period. HIS90: NoDate/Empty = Care period is open Date = Care period is closed, the date indicating
when it is/was closed. |
|
WaitingList.CarePeriod.ReceivedDate |
|
|
Date when the first referreal is
registered/received. HIS90:
PaqCape.Application_Received_Date |
|
WaitingList.CarePeriod.InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
WaitingList.CarePeriod.InDiagnosis.Code |
|
|
In
diagnosis using code from medical register, i.e. ICD10 |
|
WaitingList.CarePeriod.InDiagnosis.Text |
|
|
Text
describing the in diagnosis. |
|
WaitingList.CarePeriod.InDiagnosis.MedRegister.Id |
|
|
ICD
id |
|
WaitingList.CarePeriod.InDiagnosis.MedRegister.Code |
|
|
Medical
register code. HIS90: N/A |
|
WaitingList.CarePeriod.InDiagnosis.MedCode.MedRegister.Text |
|
|
Medical
register text |
|
WaitingList.Status.Code |
|
|
Status of waiting list/referral. See codetable for
valid waiting list statuses. |
|
WaitingList.Status.Text |
|
|
Description
of status for waitinglist/referral See
codetable for valid waitinglist statuses/descriptions. |
|
EvaluationPriority.Code |
|
|
Priority of waitinglist on evaluation. Use CommonCodesWS.ListCommonCodes with
CommonCodeType= EvaluationPriorityCode
to get valid codes |
|
EvaluationPriority. Text |
|
|
Description of the prioroty code. |
|
WaitingList.TypeOfCare.Code |
|
|
TypeOfCare: I = InPatient P = OutPatient D = In hospital only at daytime/daypatient F = Common for
all/Unknown/Undecided A = Avvist/Rejected |
|
WaitingList.TypeOfCare.Text |
|
|
Set by the PAS server based on the type of care code
value |
|
WaitingList.Organization.MedicalUnit.Id |
|
|
Department code |
|
WaitingList.Organization.MedicalUnit.ShortNameId |
|
|
Department short name HIS90: Department id |
|
WaitingList.Organization.MedicalUnit.Name |
|
|
Department name |
|
WaitingList.Organization.CareUnit.Id |
|
|
Care unit code/id HIS90: Care unit code |
|
WaitingList.Organization.CareUnit.ShortNameId |
|
|
Care unit short name HIS90: care unit id |
|
WaitingList.Organization.CareUnit.Name |
|
|
Care unit name |
|
WaitingList.Organization.Section.Code |
|
|
Section id, a collection of care units working
together. HIS90: Section id. In
HIS90 a section can span more than one care unit. |
|
WaitingList.Organization.Section.Text |
|
|
Section name HIS90: N/A |
|
WaitingList.RequestFrom.Organization.Id |
|
|
Internal Id of the requesting organization. HIS90: If
PaqReqr.Reqr_Type <> 3 the information is placed in organization. If
PaqReqr.Reqr_Type = 3 the information is placed for/as requesting physican. |
|
WaitingList.RequestFrom.Organization.TypeOfId |
|
|
Type of id as defined by PAS. 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: LOC is default in
WS as this is a local requester code |
|
WaitingList.RequestFrom.Organization.ShortNameId |
|
|
Requesters shortname/id HIS90: Kortnavn/id |
|
WaitingList.RequestFrom.Organization.Name |
|
|
Requesting organization, department or unit name |
|
WaitingList.RequestFrom.Physician.Id |
|
|
Internal
id of the requesting physican HIS90: If
PaqReqr.Reqr_Type <> 3 the information is placed in organization. If PaqReqr.Reqr_Type = 3 the information is placed
for/as requesting physican. |
|
WaitingList.RequestFrom.Physician.TypeOfId |
|
|
Type
of id as defined by PAS. 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: LOC is default in
WS as this is a local requester code |
|
WaitingList.RequestFrom.Physician.Code |
|
|
Physician
code HIS90: N/A |
|
WaitingList.RequestFrom.Physician.Name |
|
|
Requesters
name |
|
WaitingList.RequestFrom.InitialRequester.Organization.Id |
|
|
Internal
organization id of the organization that created the initial request. HIS90: If
PaqReqr.Reqr_Type <> 3 the information is placed in organization. If
PaqReqr.Reqr_Type = 3 the information is placed for/as requesting physican. |
|
WaitingList.RequestFrom.InitialRequester.Organization.TypeOfId |
|
|
Type
of id as defined by PAS. 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: LOC is default in
WS as this is a local requester code |
|
WaitingList.RequestFrom.InitialRequester.Organization.ShortNameId |
|
|
Requesters
shortname/id |
|
WaitingList.RequestFrom.InitialRequester.Organization.Name |
|
|
Initial
requesting organization, department or unit name |
|
WaitingList.RequestFrom.InitialRequester.Physician.Id |
|
|
Id
of physician who initially created the request. HIS90: If
PaqReqr.Reqr_Type <> 3 the information is placed in organization. If
PaqReqr.Reqr_Type =3 the information is placed for/as requesting physican. |
|
WaitingList.RequestFrom.InitialRequester.Physician.TypeOfId |
|
|
Type
of id as defined by PAS. 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: LOC is default in
WS as this is a local requester code |
|
WaitingList.RequestFrom.InitialRequester.Physician.Code |
|
|
Code
of initial requesting physician HIS90: N/A |
|
WaitingList.RequestFrom.InitialRequester.Physician.Name |
|
|
Requesters
name |
|
WaitingList.Resources.PatientResponsible.Id |
|
|
The
resource (i.e. the chief physician) responsible for the patient. HIS90:
N/A |
|
WaitingList.Resources.PatientResponsible.Code |
|
|
Code
of the patient responsible resource HIS90: N/A |
|
WaitingList.Resources.PatientResponsible.Name |
|
|
Resource
Name (i.e. the chief physician), responsible for the patient. HIS90: N/A |
|
WaitingList.Resources.PatientResponsible.Property |
|
|
Property
of resource that is responsible for the patient. HIS90:
Resource category |
|
WaitingList.Resources.EvaluatedBy.Id |
|
|
The
resource (i.e. the chief physician) responsible for the patient waiting list
evaluation. HIS90:
ResponsibleTreater PaqBook.Treated_By |
|
WaitingList.Resources.
EvaluatedBy.Code |
|
|
Code
of resource that has evaluated/evaluates the request/waiting list. HIS90: N/A |
|
WaitingList.Resources.
EvaluatedBy.Name |
|
|
Name
of evaluator |
|
WaitingList.Resources.
EvaluatedBy.Property |
|
|
Code
of resource properties. HIS90:
Resource category |
|
WaitingList.Resources.Resource.ResourceId |
|
|
ResourceId for
booked Resources HIS90: ResourceVist ResourceVist2 ResourceVist3 |
|
WaitingList.Resources.Resource.TypeOfResource |
|
|
Type used for describing
the resource id when several resources is listed. |
|
WaitingList.Resources.Resource.Id |
|
|
Internal Id for
booked Resources |
|
WaitingList.Resources.Resource.Code |
|
|
Code for booked
Resources |
|
WaitingList.Resources.Resource.Name |
|
|
Name for booked
Resources |
|
WaitingList.Resources.Resource.Property |
|
|
Property for booked
Resources |
|
WaitingList.VisitType.Code |
|
|
Type
of consulting. HIS90:
Patient type. For
valid values see codetable. |
|
WaitingList.VisitType.Text |
|
|
Set
according to code by the Web Service method. HIS90:
Patient type. For
valid values see codetable. |
|
WaitingList.Group.Code |
|
|
Group
code. HIS90: N/A Not Used |
|
WaitingList.Group.Name |
|
|
Group
description HIS90: N/A Not Used |
|
WaitingList.ReceivedDate |
|
|
Date
when application/waitinglist/referral is received. HIS90: Dato for mottatt søknad ved et omsorgsnivå. Hvis
1. søknad i omsorgsperioden vil denne datoen være lik
Application_Received_Date i PAQCAPE. Ledetekst "Mottatt dato" PaqBook.Application_Date |
|
WaitingList.Reason |
|
|
Reason
of the referral/application/waiting list. |
|
WaitingList.InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
WaitingList.InDiagnosis.Code |
|
|
In
diagnosis using code from medical register, i.e. ICD10 |
|
WaitingList.InDiagnosis.Text |
|
|
Text
describing the in diagnosis. |
|
WaitingList.InDiagnosis.MedRegister.Id |
|
|
ICD
id |
|
WaitingList.InDiagnosis.MedRegister.Code |
|
|
Medical
register code. HIS90: N/A |
|
WaitingList.InDiagnosis.MedCode.MedRegister.Text |
|
|
Medical
register text |
|
WaitingList.InProcedure.Id |
|
|
In
procedure id. HIS90: N/A |
|
WaitingList.InProcedure.Code |
|
|
In
procedure/operation using code from medical register, i.e. NCSP or NCMP |
|
WaitingList.InProcedure.Text |
|
|
In
procedure text. HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Id |
|
|
In
procedure medical register id. HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Code |
|
|
In
procedure medical register code. HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Text |
|
|
In
procedure medical register text/ description. HIS90: N/A |
|
WaitingList.ClinicalArea.Code |
|
|
Clinical
area of application/referral. HIS90:
Clinical area code |
|
WaitingList.ClinicalArea.Text |
|
|
Description
of clinical area |
|
WaitingList.Dates.EvaluationDate |
|
|
Date
for evaulation of treatment or when the evaluation is done (ref status). HIS90:
PaqBook.Treated date |
|
WaitingList.Dates.BookingDate.From |
|
|
Booking/visit
date/time of patient if available/booked. |
|
WaitingList.Dates.BookingDate.To |
|
|
Booking/visit
end date/time. HIS90: N/A |
|
WaitingList.Dates.CriticalDate |
|
|
Critical
date for waitinglist. |
|
AdministrationInformations.AdministrationInformation.Code |
string |
|
Code
associated to free text. The text can be used for administration of waiting
list. HIS90: Valid values or more details can be found by
using use the CommonCodesWS.ListFreeCodes
|
|
AdministrationInformations.AdministrationInformation.Text |
string |
|
Text
for administration of waiting list |
|
WaitingListGuarantee |
String |
|
Waitinglist
guarantee HIS90: Valid
values: J/N/Space(blank/mellomrom) Where
J is YES, N is No and Space means not set. |
|
CancellationOrPostponment.Code |
string |
|
Cancellation/postponment
info. Cancel/postponement
Code |
|
CancellationOrPostponment.Text |
String |
|
Description
of Cancel/postponement Code |
|
CancellationOrPostponment.CancellationOrPostponmentDate |
datetime |
|
Cancel
date/postponement date for referral/waiting list instance. |
Schema for
ListWaitingListsRequest: WaitingListWS.xsd
Schema
documentation for ListWaitingListsRequest: WaitingList.html
Sample xml
file for ListWaitingListsRequest: ListWaitingListsRequest.xml
Schema for
ListWaitingListsResponse: WaitingListWS.xsd
Schema
documentation for ListWaitingListsResponse: WaitingList.html
Sample xml
file for ListWaitingListsResponse: ListWaitingListsResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx?op=ListWaitingLists
Related
methods or function used:
N/A.
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.
A valid
Authentication Block for RequestHeader
can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In the
return data from the method there will always be a ResponseHeader, which contains Error
Information and System Information. The Error Information block must always be
checked to determine if any error has occurred while processing the methods.
HIS-90 specific information:
Server:
The server used in the method is CWWL01 (Service code 54458) and
server PWS150. The server is only to list care periods and waiting lists that
the user is allowed to see accourding to placement in hospital organization
(department/care unit.)
HIS90 access control for ListWaitingLists and ListWaitingListsByOrg
In HIS90
the waiting lists in the response for ListWaitingLists and
ListWaitingListsByOrg is filtered based
on a functional access POVT and the accesslevel the user have for this
functional access. This access levels specifies the users access to different
organizational units were waiting lists can be listed for. This will give the
ability to give the user limited access to restricted/sensitive units or unit
outside the logged on department/medical unit.
This
functional access is used by both ListWaitingLists
and ListWaitingListsByOrg
The method
AuthorizationWS GetUserServiceAccess can be used to check the users
accesslevel for the specific functional access POVT used here.
The rules
for ListWaitingLists and ListWaitingListsByOrg and POVT access level in HIS90
are:
|
·
POVT Access Level |
·
0 |
·
1 |
·
2 |
·
3 |
·
4 |
·
>4 |
|
·
Non sensitive units |
·
- |
·
(X) |
·
X |
·
X |
·
X |
·
X |
|
·
Somatic/care sensitive units |
·
- |
·
(X) |
·
(X) |
·
X |
·
(X) |
·
X |
|
·
Psychiatric sensitive units |
·
- |
·
(X) |
·
(X) |
·
(X) |
·
X |
·
X |
·
- = No access to any waiting lists
X = Full access to waiting lists regardless of the
authorization group the user belongs to
(X) = Limited access configured in users
authorizations. Only waiting lists that are in units configured
in users authorization group will be listed.
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
The method
is used for listing waiting lists for a selected organization (medical unit,
care unit, section or care group). The list can be filtered on either care
period status or waiting list status and/or selected clinical area and/or the
resource responsible for evaluating the waiting list and/or from and to dates
for selected dates periodes.
At least one
of the date periods must be in input as search/filter criteria. Both from and
to date must be in input for the same type of date criteria.
If more
than one type of organization unit is in input than the filter priority is as
follows.
Section and
MedicalUnit can both be given in the request. The method will then only return
the waiting lists for the CareUnits within the Section that belongs to the given
MedicalUnit. If only Section and no MedicalUnit is given then all waiting lists
belonging to the CareUnits within the Section will be returned regardless of
MedicalUnit.
Syntax:
ListWaitingListsByOrgResponse
= ListWaitingListsByOrg(ListWaitingListsByOrgRequest)
|
Parameter
in |
Type |
Length
byte |
Description
Data format Valid data |
|
ListWaitingListsByOrgRequest: |
|
N/A Dynamic |
ListWaitingListsByOrgRequest class according to XML schema WaitingList.xsd. |
|
Organization.MedicalUnit.Id |
|
|
Medical
unit. Valid
values can be retrieved by the WS method OrganizationWS.ListOrganizations,
OrganizationWS.GetOrganization or OrganizationWS.GetOrganization2G HIS90: Either
Medical unit or Care unit or section must be part of a request. |
|
Organization.CareUnit.Id |
|
|
Care
unit Valid
values can be retrieved by the WS method OrganizationWS.ListOrganizations,
OrganizationWS.GetOrganization or OrganizationWS.GetOrganization2G HIS90: Either
Medical unit or Care unit or section must be part of a request. |
|
Organization.CareGroup.Id |
|
|
Care
group HIS90: Either
Medical unit or Care unit or section must be part of a request. |
|
Organization.Section.Code |
|
|
Section
Valid
values can be retrieved by the WS method OrganizationWS.ListOrganizations,
OrganizationWS.GetOrganization or OrganizationWS.GetOrganization2G HIS90: Either
Medical unit or Care unit or section must be part of a request. |
|
Status.CarePeriod |
|
|
Status
for careperiods. HIS90: See
codetable for valid CerPeriod statuses. Default is OPEN |
|
Status.WaitingList |
|
|
Status
for waitinglists. HIS90: See
codetable for valid waitinglist statuses. Default
is 0 (All waitinglists) |
|
ClinicalAreaCode |
|
|
Clinical
Area Code. If
no code is specified all clinical areas wiil be listed. Valid
values is listed in PAQCADG and can be retrieved by the WS method CommonCodesWS.ListCliniclaAreaGroupCodes |
|
Dates.CarePeriodStart.From |
|
|
Search
from date. Date
for when the the first (oldest) waitinglist in the care period was received. HIS90: Dato søknaden ble mottatt. (1. søknad i omsorgsperioden) PaqCape.Application_Received_Date |
|
Dates.CarePeriodStart.To |
|
|
Search
to date. Description for date above. |
|
Dates.Received.From |
|
|
Search
from date. Date
when application/waitinglist/referral is received. HIS90: Dato for mottatt søknad ved et omsorgsnivå. Hvis
1. søknad i omsorgsperioden vil denne datoen være lik
Application_Received_Date i PAQCAPE. Ledetekst "Mottatt dato" PaqBook.Application_Date |
|
Dates.Received.To |
|
|
Search
to date. Description for date above. |
|
Dates.PlannedInDate.From |
|
|
Search
from date. Planned
visit date or in-date for patient HIS90: Planlagt dato for
besøk/innleggelse. Klokkeslett for timebestillingen. Ledetekst
"Inndato". PaqBook.Visit_Date |
|
Dates.PlannedInDate.To |
|
|
Search
to date. Description for date above. |
|
Dates.CriticalDate.From |
|
|
Search
from date. Critical
date set by the hospital/unit. HIS90: Kritisk dato som sykehuset har
satt. Ledetekst "Kritisk dato". PaqBook.Critical_Date |
|
Dates.CriticalDate.To |
|
|
Search
to date. Description for date above. |
|
Dates.TreatmentDeadlineDate.From |
|
|
Search
from date. Last
deadline for when treatment must be given to the patient. HIS90: Behandlingsfrist. Obligatorisk
for henvisninger med rett til nødvendig helsehjelp. PaqCape.Treatment_Date |
|
Dates.TreatmentDeadlineDate.To |
|
|
Search
to date. Description for date above. |
|
Resources.BookedResourceId |
string |
|
Code
identifying physicians or other resources reserved for the appointment. HIS90:
PAQBOOK.RESOURCE_VISIT |
|
Resources.EvaluatedBy |
string |
|
Code
identifying the resource who will be or has evaluted the waiting list. HIS90: Not
used |
|
Codes.WaitingListGuarantee |
string |
|
|
|
Codes.Priority.FromCode |
string |
|
Search
WaitingList priority codes From
code |
|
Codes.Priority.ToCode |
string |
|
To
code for the waiting list priority |
|
Codes.InDiagnosis.FromId |
string |
|
Search from InDiagnosis. Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
Codes.InDiagnosis.ToId |
string |
|
Search to InDiagnosis. |
|
Codes.TypeOfCareCode |
string |
|
Search
on type of care code for waitinglist. TypeOfCare:
I
= Inpatient P
= OutPatients D
= Daytime patients F
= Common for all / unknown / undecided A
= Rejected (avvist) HIS90: Elective
type |
|
Codes.VisitTypeCode |
string |
|
Search
on type of consulting HIS90: Patient_type,
for valid values see code table |
|
Codes.AdminstrativeInfo.Code |
string |
|
Codes
associated to free text. The text can be used for administration of waiting
list. HIS90: Valid
codes found in PAQFREE |
|
Returned
parameter |
Type |
Length
Byte |
Description
Comments |
|
ListWaitingListsResponse
|
|
N/A Dynamic |
ListWaitingListsResponse class according to XML schema WaitingList.xsd. |
|
Patient.Id.OfficialId.Value |
|
|
The
value of the official id as it is stored in the database, ie. the Norwegian
number 01013356789. |
|
Patient.Id.OfficialId.TypeOfId |
|
|
F
= official id, N = Emergency number, K = Catastrophy number, U = Non human
number |
|
Patient.Id.PatientId |
|
|
Internal
patient id for the HIS |
|
Patient.Name.FormattedName |
|
|
The
person's names formatted in one string according to national rules |
|
Patient.Municipality.Code |
string |
|
Patients municipality code, i.e. 1917 |
|
Patient.Municipality.Name |
string |
|
Patients municipality name, i.e. Ibestad |
|
WaitingList.Id |
string |
|
The internal id for the waitinglist. HIS90: Combined id
WaitingListId Format: PatientId|BookingNo (Combined Id) |
|
WaitingList.Contacts.ContactId |
string |
|
Contact(s) the
waitinglist has resulted in. If blank/null then
no contact is associated with the waiting list. Is normally one contact but
can be several. Use ContactId with ContactWS to get more information
about the contact. |
|
WaitingList.Contacts.Status.Code |
string |
|
Contact status code. Valid values are: AK
(active/aktiv) UT
(discharged/utskrevet) IM
(Ikke møtt/Did not meet) |
|
WaitingList.Contacts.Status.Text |
string |
|
Description of status. For Inpatients text can be: AK = Innliggende/In-patient
UT =
Discharged/Utskrevet For Outpatients text can be: AK =
Out-patient visit arrival registered/ Ankomstregistrert UT =
Out-patient visit finished registered/ Besøksregistrert IM =
Ikke møtt/Not meet |
|
WaitingList.CarePeriod.Id |
string |
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
SequenceNumber |
|
|
The sequence number of the care period. HIS90: CAPE_NO |
|
WaitingList.CarePeriod.Status.Code |
|
|
Status of the care period. HIS90: Status code is
derived from the contents of StatusDate2 and StatusDate3. See codetable for
valid care period statuses. |
|
WaitingList.CarePeriod.Status.Text |
|
|
Set by the web service based on the status code
value |
|
WaitingList.CarePeriod.WaitingTimeEndedDate |
|
|
Status date when the waiting time has ended. HIS90: NoDate/Empty = Treatment is not started. Date = Waiting time has ended. Ready for
treatment/booking time. |
|
WaitingList.CarePeriod.CarePeriodClosedDate |
|
|
Status date of care period. HIS90: NoDate/Empty = Care period is open Date = Care period is closed, the date indicating
when it is/was closed. |
|
WaitingList.CarePeriod.StartDate |
datetime |
|
Original start date HIS90: Start of care period. Only to be set if patient
transfers from other hospitals |
|
WaitingList.CarePeriod.ReceivedDate |
datetime |
|
Date when the first referreal is
registered/received. HIS90:
PaqCape.Application_Received_Date |
|
WaitingList.CarePeriod.InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
WaitingList.CarePeriod.InDiagnosis.Code |
|
|
In
diagnosis using code from medical register, i.e. ICD10 |
|
WaitingList.CarePeriod.InDiagnosis.Text |
|
|
Text
describing the in diagnosis. |
|
WaitingList.CarePeriod.InDiagnosis.MedRegister.Id |
|
|
ICD
id |
|
WaitingList.CarePeriod.InDiagnosis.MedRegister.Code |
|
|
Medical
register code. HIS90: N/A |
|
WaitingList.CarePeriod.InDiagnosis.MedCode.MedRegister.Text |
|
|
Medical
register text |
|
WaitingList.Status.Code |
|
|
Status of waiting list/referral. See codetable for
valid waiting list statuses. |
|
WaitingList.Status.Text |
|
|
Description
of status for waitinglist/referral See
codetable for valid waitinglist statuses/descriptions. |
|
EvaluationPriority.Code |
|
|
Priority of waitinglist on evaluation. Use CommonCodesWS.ListCommonCodes with
CommonCodeType= EvaluationPriorityCode
to get valid codes |
|
EvaluationPriority. Text |
|
|
Description of the prioroty code. |
|
WaitingList.TypeOfCare.Code |
|
|
TypeOfCare: I = InPatient P = OutPatient D = In hospital only at daytime/daypatient F = Common for
all/Unknown/Undecided A = Avvist/Rejected |
|
WaitingList.TypeOfCare.Text |
|
|
Set by the PAS server based on the type of care code
value |
|
WaitingList.Organization.MedicalUnit.Id |
|
|
Department code |
|
WaitingList.Organization.MedicalUnit.ShortNameId |
|
|
Department short name HIS90: Department id |
|
WaitingList.Organization.MedicalUnit.Name |
|
|
Department name |
|
WaitingList.Organization.CareUnit.Id |
|
|
Care unit code/id HIS90: Care unit code |
|
WaitingList.Organization.CareUnit.ShortNameId |
|
|
Care unit short name HIS90: care unit id |
|
WaitingList.Organization.CareUnit.Name |
|
|
Care unit name |
|
WaitingList.Organization.Section.Code |
|
|
Section id, a collection of care units working
together. HIS90: Section id. In
HIS90 a section can span more than one care unit. |
|
WaitingList.Organization.Section.Text |
|
|
Section name HIS90: N/A |
|
WaitingList.RequestFrom.Organization.Id |
|
|
Internal Id of the requesting organization. HIS90: If
PaqReqr.Reqr_Type <> 3 the information is placed in organization. If
PaqReqr.Reqr_Type = 3 the information is placed for/as requesting physican. |
|
WaitingList.RequestFrom.Organization.TypeOfId |
|
|
Type of id as defined by PAS. 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: LOC is default in
WS as this is a local requester code |
|
WaitingList.RequestFrom.Organization.ShortNameId |
|
|
Requesters shortname/id HIS90: Kortnavn/id |
|
WaitingList.RequestFrom.Organization.Name |
|
|
Requesting organization, department or unit name |
|
WaitingList.RequestFrom.Physician.Id |
|
|
Internal
id of the requesting physican HIS90: If
PaqReqr.Reqr_Type <> 3 the information is placed in organization. If PaqReqr.Reqr_Type = 3 the information is placed
for/as requesting physican. |
|
WaitingList.RequestFrom.Physician.TypeOfId |
|
|
Type
of id as defined by PAS. 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: LOC is default in
WS as this is a local requester code |
|
WaitingList.RequestFrom.Physician.Code |
|
|
Physician
code HIS90: N/A |
|
WaitingList.RequestFrom.Physician.Name |
|
|
Requesters
name |
|
WaitingList.RequestFrom.InitialRequester.Organization.Id |
|
|
Internal
organization id of the organization that created the initial request. HIS90: If
PaqReqr.Reqr_Type <> 3 the information is placed in organization. If
PaqReqr.Reqr_Type = 3 the information is placed for/as requesting physican. |
|
WaitingList.RequestFrom.InitialRequester.Organization.TypeOfId |
|
|
Type
of id as defined by PAS. 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: LOC is default in
WS as this is a local requester code |
|
WaitingList.RequestFrom.InitialRequester.Organization.ShortNameId |
|
|
Requesters
shortname/id |
|
WaitingList.RequestFrom.InitialRequester.Organization.Name |
|
|
Initial
requesting organization, department or unit name |
|
WaitingList.RequestFrom.InitialRequester.Physician.Id |
|
|
Id
of physician who initially created the request. HIS90: If
PaqReqr.Reqr_Type <> 3 the information is placed in organization. If
PaqReqr.Reqr_Type =3 the information is placed for/as requesting physican. |
|
WaitingList.RequestFrom.InitialRequester.Physician.TypeOfId |
|
|
Type
of id as defined by PAS. 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: LOC is default in
WS as this is a local requester code |
|
WaitingList.RequestFrom.InitialRequester.Physician.Code |
|
|
Code
of initial requesting physician HIS90: N/A |
|
WaitingList.RequestFrom.InitialRequester.Physician.Name |
|
|
Requesters
name |
|
WaitingList.Resources.PatientResponsible.ResourceId |
|
|
Unique
id for the resource (i.e. the chief physician) responsible for the
patient. HIS90:
N/A |
|
WaitingList.Resources.PatientResponsible.Id |
|
|
The
resource (i.e. the chief physician) responsible for the patient. HIS90:
N/A |
|
WaitingList.Resources.PatientResponsible.Code |
|
|
Code
of the patient responsible resource HIS90: N/A |
|
WaitingList.Resources.PatientResponsible.Name |
|
|
Resource
Name (i.e. the chief physician), responsible for the patient. HIS90: N/A |
|
WaitingList.Resources.PatientResponsible.Property |
|
|
Property
of resource that is responsible for the patient. HIS90:
Resource category |
|
WaitingList.Resources.EvaluatedBy.ResourceId |
|
|
Unique
id for the resource (i.e. the chief physician) responsible for the patient
waiting list evaluation. HIS90: Combined
Id of type ResourceId PaqBookDeptNo and PaqBook.Treated_By |
|
WaitingList.Resources.EvaluatedBy.Id |
|
|
The
resource (i.e. the chief physician) responsible for the patient waiting list
evaluation. HIS90:
ResponsibleTreater PaqBook.Treated_By |
|
WaitingList.Resources.
EvaluatedBy.Code |
|
|
Code
of resource that has evaluated/evaluates the request/waiting list. HIS90: N/A |
|
WaitingList.Resources.
EvaluatedBy.Name |
|
|
Name
of evaluator |
|
WaitingList.Resources.
EvaluatedBy.Property |
|
|
Code
of resource properties. HIS90:
Resource category |
|
WaitingList.Resources.Resource.ResourceId |
|
|
Unique
id for the resource This
should be the id used in other WS methods. HIS90: Combined
Id of type ResourceId |
|
WaitingList.Resources.
Resource.TypeOfResource |
|
|
Code
used for describing the reosurce when there many in the list. E.g.
RESOURCE1 or RESOURCE2 |
|
WaitingList.Resources.Resource.Id |
|
|
The
internal id for the id HIS90: N/A |
|
WaitingList.Resources.Resource.Code |
|
|
Code
of resource. HIS90:
ResponsibleTreater PaqBook.Treated_By |
|
WaitingList.Resources.Resource.Name |
|
|
Name
of the resource |
|
WaitingList.Resources.Resource.Property |
|
|
Code
of resource properties. HIS90: N/A |
|
WaitingList.VisitType.Code |
|
|
Type
of consulting. HIS90:
Patient type. For
valid values see codetable. |
|
WaitingList.VisitType.Text |
|
|
Set
according to code by the Web Service method. HIS90:
Patient type. For
valid values see codetable. |
|
WaitingList.Group.GroupCode |
string |
|
Groupcode HIS90: Valid
codes found in PAQGROUP |
|
WaitingList.Group.GroupText |
string |
|
Group
description |
|
WaitingList.ReceivedDate |
|
|
Date
when application/waitinglist/referral is received. HIS90: Dato for mottatt søknad ved et omsorgsnivå. Hvis
1. søknad i omsorgsperioden vil denne datoen være lik
Application_Received_Date i PAQCAPE. Ledetekst "Mottatt dato" PaqBook.Application_Date |
|
WaitingList.Reason |
|
|
Reason
of the referral/application/waiting list. |
|
Priority.Code |
|
|
Priority code set by hospital Valid values can be found by using use the CommonCodesWS.ListPriorityCodes HIS90: Valid codes to be found in PAQPRIO |
|
Priority.ModificationDate |
datetime |
|
Date when priority was set or modified.
Current date when service is / was run. Set by server |
|
Priority.Text |
string |
|
Description of priority code |
|
Priority.SignedBy |
string |
|
Changers initials. Set by server using
information about user from security token |
|
Priority.Organization.Id |
string |
|
Department changing / modifying priority.
Internal id. Valid values or more details can be found by
using use the OrganizationWS.ListOrganizations or OrganizationWS.ListOrganizations2G or OrganizationWS.GetOrganization2G Code and name is found in PAQDEPT. Set by
server using information about user from security token. |
|
Priority.Organization.TypeOfId |
string |
|
Type of id given in Id above. Normally LAV
for medicalunit/department |
|
Priority.Organization.ShortNameId |
string |
|
Department code |
|
Priority.Organization.Name |
string |
|
Department name |
|
WaitingList.InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values or more details can be found by
using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
WaitingList.InDiagnosis.Code |
|
|
In
diagnosis using code from medical register, i.e. ICD10 |
|
WaitingList.InDiagnosis.Text |
|
|
Text
describing the in diagnosis. |
|
WaitingList.InDiagnosis.MedRegister.Id |
|
|
ICD
id |
|
WaitingList.InDiagnosis.MedRegister.Code |
|
|
Medical
register code. HIS90: N/A |
|
WaitingList.InDiagnosis.MedCode.MedRegister.Text |
|
|
Medical
register text |
|
WaitingList.InProcedure.Id |
|
|
In
procedure id. HIS90: N/A |
|
WaitingList.InProcedure.Code |
|
|
In
procedure/operation using code from medical register, i.e. NCSP or NCMP |
|
WaitingList.InProcedure.Text |
|
|
In
procedure text. HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Id |
|
|
In
procedure medical register id. HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Code |
|
|
In
procedure medical register code. HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Text |
|
|
In
procedure medical register text/ description. HIS90: N/A |
|
WaitingList.ClinicalArea.Code |
|
|
Clinical
area of application/referral. HIS90:
Clinical area code |
|
WaitingList.ClinicalArea.Text |
|
|
Description
of clinical area |
|
WaitingList.Dates.EvaluationDate |
|
|
Date
for evaulation of treatment or when the evaluation is done (ref status). HIS90:
PaqBook.Treated date |
|
WaitingList.Dates.BookingDate.From |
|
|
Booking/visit
date/time of patient if available/booked. |
|
WaitingList.Dates.BookingDate.To |
|
|
Booking/visit
end date/time. HIS90: N/A |
|
WaitingList.Dates.TreatmentDeadlineDate |
|
|
Deadline
date for treatment of the patient HIS90: Behandlingsfrist. Obligatorisk
for henvisninger med rett til nødvendig helsehjelp. PaqCape.Treatment_Date |
|
WaitingList.Dates.CriticalDate |
|
|
Critical
date for waiting list set by the hospital/unit. HIS90: Kritisk dato som sykehuset har
satt. Ledetekst "Kritisk dato". PaqBook.Critical_Date |
|
WaitingList.Dates.PlannedInDate |
|
|
Planned
visit date or in-date for patient HIS90: Planlagt dato for
besøk/innleggelse. Klokkeslett for timebestillingen. Ledetekst
"Inndato". PaqBook.Visit_Date |
|
AdministrationInformations.AdministrationInformation.Code |
string |
|
Code
associated to free text. The text can be used for administration of waiting
list. HIS90: Valid values or more details can be found by
using use the CommonCodesWS.ListFreeCodes
|
|
AdministrationInformations.AdministrationInformation.Text |
string |
|
Text
for administration of waiting list |
|
WaitingListGuarantee |
String |
|
Waitinglist
guarantee HIS90: Valid
values: J/N/Space(blank/mellomrom) Where
J is YES, N is No and Space means not set. |
|
CancellationOrPostponment.Code |
string |
|
Cancellation/postponment
info. Cancel/postponement
Code |
|
CancellationOrPostponment.Text |
String |
|
Description
of Cancel/postponement Code |
|
CancellationOrPostponment.CancellationOrPostponmentDate |
datetime |
|
Cancel
date/postponement date for referral/waiting list instance. |
Schema for
ListWaitingListsByOrgRequest: WaitingListWS.xsd
Schema
documentation for ListWaitingListsByOrgRequest: WaitingList.html
Sample xml
file for ListWaitingListsByOrgRequest: ListWaitingListsByOrgRequest.xml
Schema for
ListWaitingListsByOrgResponse: WaitingListWS.xsd
Schema
documentation for ListWaitingListsByOrgResponse: WaitingList.html
Sample xml
file for ListWaitingListsByOrgResponse: ListWaitingListsByOrgResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx?op=ListWaitingListsByOrg
Related
methods or function used:
N/A.
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.
A valid
Authentication Block for RequestHeader
can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In the
return data from the method there will always be a ResponseHeader, which contains Error
Information and System Information. The Error Information block must always be
checked to determine if any error has occurred while processing the methods.
HIS-90 specific information:
Server:
·
The server used in the method is CWWL01 (Service code 54466) service PWS1501.
The server is only to list care periods and waiting lists that the user is
allowed to see according to placement in hospital organization (department/care
unit.)
·
Waiting lists are to be listed by server in
following order:
·
1. Ascending date
and time for waiting list
2. Patient date of
birth
3. Patient social
security number.
HIS90 access control for ListWaitingLists and
ListWaitingListsByOrg
See ListWaitingLists description for
access control.
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
Gets one waitinglist for a patients according to search criteria.
Syntax:
GetWaitingListResponse =
GetWaitingList(GetWaitingListRequest)
|
Parameter
in |
Type |
Length
byte |
Description
Data format Valid data |
|
GetWaitingListRequest |
|
N/A Dynamic |
GetWaitingListRequest
class according to XML schema WaitingListWS.xsd. |
|
Id |
|
|
The internal id for the waitinglist. HIS90: Combined id
WaitingListId Format: PatientId|BookingNo |
|
Returned
parameter |
Type |
Length
Byte |
Description
Comments |
|
GetWaitingListResponse |
|
N/A Dynamic |
GetWaitingListResponse
class according to XML schema WaitingListWS.xsd. |
|
Ids.Id |
|
|
The internal id for the waitinglist. HIS90: Combined id
WaitingListId Format: PatientId|BookingNo) |
|
Ids.PatientId |
|
|
Patient
internal Id |
|
Ids.CarePeriodId |
|
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
Contacts.ContactId |
string |
|
Contact(s) the waitinglist
has resulted in. If blank/null then
no contact is associated with the waiting list. Is normally one contact but
can be several. Use ContactId with ContactWS to get more information
about the contact. |
|
Contacts.Status.Code |
string |
|
Contact status code. Valid values are: AK
(active/aktiv) UT
(discharged/utskrevet) IM
(Ikke møtt/Did not meet) |
|
Contacts.Status.Text |
string |
|
Description of status. For Inpatients text can be: AK = Innliggende/In-patient
UT =
Discharged/Utskrevet For Outpatients text can be: AK =
Out-patient visit arrival registered/ Ankomstregistrert UT =
Out-patient visit finished registered/ Besøksregistrert IM =
Ikke møtt/Not meet |
|
CarePeriod.InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
CarePeriod.InDiagnosis.Code |
|
|
In
diagnosis using code from medical register, i.e. ICD10 |
|
CarePeriod.InDiagnosis.Text |
|
|
Text
describing the in diagnosis. |
|
CarePeriod.InDiagnosis.MedRegister.Id |
|
|
ICD
id |
|
CarePeriod.InDiagnosis.MedRegister.Code |
|
|
Medical
register code. HIS90: N/A |
|
CarePeriod.InDiagnosis.MedCode.MedRegister.Text |
|
|
Medical
register text |
|
CarePeriod.SequenceNumber |
|
|
The
sequence num,ber of the care period HIS90: CAPE_NO |
|
Status.Code |
|
|
Status
for waiting list/referral (HIS90) HIS90: Fixed
statuses: Set
by server when waiting list is inserted/updated. See
codes for waiting list status |
|
Status.Text |
|
|
Description
of status for waitinglist/referral See
codes for valid waitinglist statuses/descriptions. |
|
InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
InDiagnosis.Code |
|
|
In
diagnosis using code from medical register, i.e. ICD10 |
|
InDiagnosis.Text |
|
|
Text
describing the in diagnosis. |
|
InDiagnosis.MedRegister.Id |
|
|
ICD
id |
|
InDiagnosis.MedRegister.Code |
|
|
Medical
register code. HIS90: N/A |
|
InDiagnosis.MedCode.MedRegister.Text |
|
|
Medical
register text |
|
TypeOfCare.Code |
|
|
TypeOfCare HIS90: See codetables
for valid values |
|
TypeOfCare.Text |
|
|
TypeOfCare
descriptive text |
|
Organization.MedicalUnit.Id |
|
|
Departement
Id |
|
Organization.MedicalUnit.ShortNameId |
|
|
Department
Code |
|
Organization.MedicalUnit.Name |
|
|
Department
name |
|
Organization.CareUnit.Id |
|
|
Care
Unit Id |
|
Organization.CareUnit.ShortNameId |
|
|
Care
Unit Code |
|
Organization.CareUnit.Name |
|
|
Care
Unit Name |
|
Organization.Section.Code |
|
|
Section
that care unit is part of. |
|
Organization.Section.Text |
|
|
Section
description HIS90: Not
found. |
|
RequestFrom.Organization.Id |
|
|
Requester
code. HIS90: Valid
codes are found in PAQREQR. |
|
RequestFrom.Organization.TypeOfId |
|
|
Type
of Id as defined by PAS. Empty/LOC/LOK
= Unkown or 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: Setting
LOC as default in WS as this is local requester code |
|
RequestFrom.
Organization.Code |
|
|
HIS90: Not
found. |
|
RequestFrom.Organization.Name |
|
|
Name
of requesting instance. |
|
RequestFrom.Physician.Id |
|
|
Requesting
physicians Id |
|
RequestFrom.Physician.TypeOfId |
|
|
Type
of Id as defined by PAS. Empty/LOC/LOK
= Unkown or 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 as LOC |
|
RequestFrom.
Physician.Code |
|
|
HIS90: Not
found. |
|
RequestFrom.Physician.Name |
|
|
Name
of requesting physician. HIS90: (Name
is found in PAQREQR using PaqBook.Reqr_Code_Phys and PaqReqr.Reqr_code) |
|
EvaluationPriority.Code |
|
|
Priority of waitinglist on evaluation. Use CommonCodesWS.ListCommonCodes with
CommonCodeType= EvaluationPriorityCode
to get valid codes |
|
EvaluationPriority. Text |
|
|
Description of the prioroty code. |
|
AppointmentType |
|
|
Appointment
type. HIS90: (T1-T4,
XT) |
|
EvaluatedBy.Id |
|
|
Physician
that evaluates case. Mandatory
after evaluation HIS90: PaqBook.Treated_By |
|
EvaluatedBy.Code |
|
|
HIS90: Not
found. |
|
EvaluatedBy.Name |
|
|
Name
of resource that has evaluated the case. Mandatory
when EvaluatedBy is in output. |
|
VisitType.Code |
|
|
Type
of consultation. HIS90:
Patient type. For
valid values see codetable. |
|
VisitType.Text |
|
|
Consultation
description. Set by server. HIS90:
Patient type. For
valid values see codetable. |
|
ReceivedDate |
|
|
Date
when waiting list is registered/received.
|
|
BookingDate.From |
|
|
Booking/Visit
time for patient if available/booked. Note - If the
booking is suspended/postponed(see Status.Code) the From and To date will
contain the start original date/time for the booking (Not the new date/time). |
|
BookingDate.To |
|
|
HIS90: Not
found. Note - If the
booking is suspended/postponed(see Status.Code) the From and To date will
contain the original end date/time for the booking (Not the new date/time). |
|
BookingText.Text |
|
|
Free
text from the referral/booking/waitinglist If
ICPC is registered in requisition than this is shown in booking_text_2 The
text is then in following format:
(Code type) Code description |
|
BookingText.TypeOfText |
|
|
The
element is set by the WS to code values: BT1
= Booking Text 1 BT2
= Booking Text 2 LCAT
= Letter Cancel Text LCOT
= Letter Conf Text LIT = Letter In Text |
|
SendNotification.Code |
|
|
Sending notification to the patient. If not set/null the no notification is sent. HIS90: Codes are: J or Y (YES) only patient sms N (NO) no for both patients and relations R
Relations only A All (both aptient and relations) |
|
SendNotification.Text |
|
|
Description of the notification, if used |
|
SendNotification.TypeOfNotification |
|
|
Type of notification to send. Valid values are: - SMS - Letter - EMail |
|
EvaluationDate |
|
|
Date
for evaluation of treatment or when the evaluation is done(ref status) Mandatory after evaluation is done. HIS90:
PaqBook.Treated date |
|
EstimatedNumberOfTreatmentDays |
|
|
Number
of estimated treatment days. |
|
EstimatedWaitingDays |
|
|
Number
of estimated days on waitinglist |
|
Reason |
|
|
Reason
for the waiting list instance. |
|
PreviousVisits.PreviousVisit |
|
|
Previous
visit date/Time. |
|
RequestedTreatmentOtherHospital |
|
|
Indicator,
indicating if the patient requests treatment in another hospital. HIS90: Valid
codes: J, N. (Default N) |
|
Group.Code |
|
|
Group
code. HIS90: Valid
code is found in PAQGROUP using |
|
Group.Name |
|
|
Group
description |
|
ClinicalArea.Code |
|
|
Clinical area code for waiting list. To get valid values for ClinicalArea use the CommonCodesWS with code type
ListClinicalAreaGroupCodes. HIS90: Fagområde |
|
ClinicalArea.Text |
|
|
Clinical area description for waiting list. |
|
Transfer.From.OtherHospital |
|
|
Indicator,
indicating if patient is transferred from other hospital. HIS90: N/A |
|
Transfer.From.OrginalStartDate |
|
|
If
patient is transferred from other hospital then this is the original start
date. HIS90: N/A |
|
Transfer.To.Code |
|
|
Inst.
code for another hospital where the patient/referral is to be moved
to/transferred. HIS90: If
Transfer.To.OtherHospital equal to J than Transfer.To.Code is mandatory
using ref. code from PAQREQR. Valid Reqr types 1, 7 or 8. |
|
Transfer.To.OtherHospital |
|
|
Indicator,
indicating if patient/referral is to be transferred to another hospital. HIS90: Valid
codes: J, N, . Default
by server |
|
Transfer.To.TransferDate |
|
|
Transfer
date HIS90: N/A |
|
Priority.Code |
|
|
Priority
code. Priority set by hospital. HIS90: Valid
codes is found in PAQPRIO |
|
Priority.PriorityModificationDate |
|
|
Date
when priority was set or modified. Current date when service is/was run. Set
by server. |
|
Priority.Name |
|
|
Description
of priority code |
|
Priority.PrioritySignedBy |
|
|
Changers
initials. Set
by server using information about user from security token. |
|
Priority.Organization.Id |
|
|
Department
changing/modifying priority. Internal HIS90: Code
and Name is found in PAQDEPT. Set
by server using information about user from security token. |
|
Priority.Organization.ShortNameId |
|
|
Department
code |
|
Priority.Organization.Name |
|
|
Department
name |
|
AdministrationInformation.Code |
|
|
Code
associated to free text. The text can be used for administration of waiting
list. HIS90: Valid
code found in PAQFREE |
|
AdministrationInformation.Text |
|
|
Text
for administration of waiting list. |
|
CriticalDate |
|
|
Critical
date for appointment set by hospital |
|
CancellationOrPostponment.Code |
|
|
Cancel/postponement
Code |
|
CancellationOrPostponment. CancellationOrPostponmentDate |
|
|
Cancel
date/postponement date for referral/waiting list instance. Mandatory if
Cancel/postponement code is set. |
|
CancellationOrPostponment.ByPhone |
|
|
Patient
has been informed about the cancel/postponement by phone. HIS90: Valid
code J/N. Set
to N by server as default |
|
CancellationOrPostponment.Letter.LetterDate |
|
|
Date
when cancel/ postponement letter was sent. |
|
CancellationOrPostponment.Letter.
ToRequester.Code |
|
|
Code
used in cancel/ postponement letter to requester/requesting instance. HIS90: Valid
code is found in PAQLETT. |
|
CancellationOrPostponment.Letter.
ToRequester.Name |
|
|
Code
description |
|
CancellationOrPostponment.Letter.ToPatient.Code |
|
|
Code
used in cancel/ postponement letter to patient. HIS90: Valid
code is found in PAQLETT |
|
CancellationOrPostponment.Letter.ToPatient.Name |
|
|
Code
description |
|
CancellationOrPostponment.Letter.TextToPatient.Text |
|
|
Free
text used in cancel/ postponement letter. |
|
CancellationOrPostponment.Letter.TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: LCAT
= Letter Cancel Text |
|
Confirmed. ConfirmationDate |
|
|
Date
when the hospital has confirmed that referral is received. Set by server with
save/modify. |
|
Confirmed.ByPhone |
|
|
Used
if patient has been contacted by phone to confirm that referral has been
received. HIS90: Valid
codes J/N. Set by server to default N. |
|
Confirmed.Letter.
ToRequester.Code |
|
|
Code
used in confirmation letter to requester. HIS90: Valid
code is found in PAQLETT |
|
Confirmed.Letter.
ToRequester.Name |
|
|
Letter
code description |
|
Confirmed.Letter.
ToPasient.Code |
|
|
Code
used in confirmation letter to patient. HIS90: Valid
code is found in PAQLETT |
|
Confirmed.Letter.
ToPasient.Name |
|
|
Letter
code description |
|
Confirmed.Letter.TextToPatient.Text |
|
|
Free
text used in confirmation letter to patient. HIS90: If
ICPC is registered in requisition than this is shown in booking_text_2 The
text is then in following format:
(Code type) Code description |
|
Confirmed.Letter.TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: BT1
= Booking Text 1 BT2
= Booking Text 2 LCOT
= Letter Conf Text |
|
Admission. AdmissionDate |
|
|
Date
when patient is/was contacted about admittance. Set by server when letter is
created |
|
Admission.ByPhone |
|
|
Used
if in-patient has been contacted by phone to confirm admittance. HIS90: Valid
codes J/N. Default N by server |
|
Admission.Letter.
ToRequester.Code |
|
|
Code
used in letter of admission confirmation to requester. HIS90: Valid
code is found in PAQLETT |
|
Admission.Letter.
ToRequester.Name |
|
|
Letter
code description |
|
Admission.Letter.ToPatient.Code |
|
|
Code
used in letter to in-patient confirming admittance. HIS90: Valid
code is found in PAQLETT |
|
Admission.Letter.
ToPatient.Name |
|
|
Letter
code description |
|
Admission.Letter.TextToPatient.Text |
|
|
Free
text used in admittance letter. |
|
Admission.Letter.TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: LIT
= Letter In Text |
|
Registration. Date |
|
|
Insertion
date of referral |
|
Registration.Organization.
Id |
|
|
Department
responsible for insertion of referral. Internal Set
by server using information from security token. |
|
Registration.Organization.ShortNameId |
|
|
Department
Code |
|
Registration.Organization.Name |
|
|
Department
Name |
|
Registration.SignedBy |
|
|
Initials
of user inserting referral. Set by
server using information from security token. |
|
Update.
Date |
|
|
Date
when waiting list instance was last modified. Set by server. |
|
Update.Name |
|
|
HIS90: Not
used |
|
Update.Organization.
Id |
|
|
Department
responsible for last modification of waiting list instance. Internal Set
by server using information from security token. |
|
Update.Organization.ShortNameId |
|
|
Department
Code |
|
Update.Organization.Name |
|
|
Department
Name |
|
Update.Organization.SignedBy |
|
|
Initials
of user that modified waiting list instance. Set by server using information
from security token. |
|
Update.UpdateCount |
|
|
Count
used for concurrency testing when waiting list is updated. |
Schema for GetWaitingListRequest: WaitingListWS.xsd
Schema
documentation for GetWaitingListRequest: WaitingList.html
Sample xml
file for GetWaitingListRequest: GetWaitingListRequest.xml
Schema for GetCarePeriodResponse
: WaitingListWS.xsd
Schema
documentation for GetWaitingListResponse : WaitingList.html
Sample xml
file for GetWaitingListResponse : GetWaitingListResponse .xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx?op=GetWaitingList
For
description of tag:ErrorDescription see HTML or XML document.
Related
methods or function used:
SaveWaitingList: Method
is used to save a patients waiting list.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS-90 spesific information:
Server used for the method is CWBP01 (Service code 54521).
In case of an error, the WS method or the server
responds with an error and an error description in WS response header.
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
The method
is used for saving/creating new waiting lists or updating existing(retrieved by
GetWaitingList) waiting lists.
Syntax:
SaveWaitingListResponse
=
SaveWaitingList(SaveWaitingListRequest)
|
Parameter
in |
Type |
Length
byte |
Description
Data format Valid data |
|
SaveWaitingListRequest |
|
N/A Dynamic |
SaveWaitingListRequest class according to XML schema WaitingList.xsd. |
|
Ids.Id [1] |
|
|
The internal id for the waitinglist. Valid id combination: New
waitinglist: Both PatientId and CarePeriod must be given. Id must
be blank/null. Existing
waitinglist: Id
must be given, PatientId and CarePeriodId can be omitted. HIS90: Combined id
WaitingListId Format: PatientId|BookingNo |
|
Ids.PatientId |
|
|
Patient
internal Id Valid id combination: New
waitinglist: Both PatientId and CarePeriod must be given. Id must
be blank/null. Existing
waitinglist: Id
must be given, PatientId and CarePeriodId can be omitted. |
|
Ids.CarePeriodId |
|
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. Valid id combination: New
waitinglist: Both PatientId and CarePeriod must be given. Id must
be blank/null. Existing
waitinglist: Id
must be given, PatientId and CarePeriodId can be omitted. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
Status.Code |
|
|
Status
for waiting list/referral (HIS90) HIS90: Fixed
statuses: Set
by server when waiting list is inserted/updated. Se
codes for waiting list status |
|
Status.Text |
|
|
Description
of status for waitinglist/referral See
codes for valid waitinglist statuses/descriptions. |
|
InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
InDiagnosis.Code |
|
|
In
diagnosis using code from medical register, i.e. ICD10 |
|
InDiagnosis.Text |
|
|
Text
describing the in diagnosis. |
|
InDiagnosis.MedRegister.Id |
|
|
ICD
id |
|
InDiagnosis.MedRegister.Code |
|
|
Medical
register code. HIS90: N/A |
|
InDiagnosis.MedCode.MedRegister.Text |
|
|
Medical
register text |
|
TypeOfCare.Code |
|
|
TypeOfCare HIS90: Se
codes for valid type of care codes NB! See important information about rules
for waitinglist guarantee |
|
TypeOfCare.Text |
|
|
Not
used for Savemethod Set
by WS method |
|
Organization.MedicalUnit.Id |
|
|
Departement
Id |
|
Organization.MedicalUnit.ShortNameId |
|
|
Department
Code Not
used for Save method |
|
Organization.MedicalUnit.Name |
|
|
Department
name Not
used for Save method |
|
Organization.CareUnit.Id |
|
|
Care
Unit Id |
|
Organization.CareUnit.ShortNameId |
|
|
Care
Unit Code Not
used for Save method |
|
Organization.CareUnit.Name |
|
|
Care
Unit Name Not
used for Save method |
|
Organization.Section.Code |
|
|
Section
that care unit is part of. |
|
Organization.Section.Text |
|
|
Not
used for Save method HIS90: Not
found. |
|
RequestFrom.Organization.Id |
|
|
Requester
code. Valid
codes ca be found by using RequesterWS.
ListRequesters HIS90: Valid
codes are found in PAQREQR. |
|
RequestFrom.Organization.TypeOfId |
|
|
Type
of Id as defined by PAS. Empty/LOC/LOK
= Unkown or 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: Setting
LOC as default in WS as this is local requester code |
|
RequestFrom.
Organization.Code |
|
|
HIS90: Not
found. |
|
RequestFrom.Organization.Name |
|
|
Name
of requesting instance. Not
used for Save method |
|
RequestFrom.Physician.Id |
|
|
Requesting
physicians Id |
|
RequestFrom.Physician.TypeOfId |
|
|
Type
of Id as defined by PAS. Empty/LOC/LOK
= Unkown or 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 as LOC |
|
RequestFrom.
Physician.Code |
|
|
Not
used for Save method HIS90: Not
found. |
|
RequestFrom.Physician.Name |
|
|
Name
of requesting physician. Not
used for Save method HIS90: (Name
is found in PAQREQR using PaqBook.Reqr_Code_Phys and PaqReqr.Reqr_code) |
|
EvaluationPriority.Code |
|
|
Priority of waitinglist on evaluation. Use CommonCodesWS.ListCommonCodes with
CommonCodeType= EvaluationPriorityCode
to get valid codes |
|
EvaluationPriority. Text |
|
|
Description of the prioroty code. |
|
AppointmentType |
|
|
Appointment
type. HIS90: (T1-T4,
XT) |
|
EvaluatedBy.Id |
|
|
Physician
that evaluates case. Mandatory
after evaluation HIS90: If
WaitingListeGuarantee in CarePeriod(Get or Save) is set to J (YES), then EvaluatedBy.Id is
required when saving waiting list. PaqBook.Treated_By |
|
EvaluatedBy.Code |
|
|
Not
used for Save method HIS90: Not
found. |
|
EvaluatedBy.Name |
|
|
Not
used for Save method Name
of resource that has evaluated the case. Mandatory
when EvaluatedBy is in output. |
|
VisitType.Code |
|
|
Type
of consultation. HIS90:
Patient type. For
valid values see codetable. |
|
VisitType.Text |
|
|
Consultation
description. Set by server. Not
used for Save method HIS90:
Patient type. For
valid values see codetable. |
|
ReceivedDate |
|
|
Date
when waiting list is registered/received.
|
|
BookingDate.From |
|
|
Booking/Visit
time for patient if available/booked. |
|
BookingDate.To |
|
|
HIS90: Not
found. |
|
BookingText.Text |
|
|
Free
text from the referral/booking/waitinglist If
ICPC is registered in requisition than this is shown in booking_text_2 The
text is then in following format:
(Code type) Code description |
|
BookingText.TypeOfText |
|
|
The
element is set by the WS to code values: BT1
= Booking Text 1 BT2
= Booking Text 2 LCAT
= Letter Cancel Text LCOT
= Letter Conf Text LIT = Letter In Text |
|
SendNotification.Code |
|
|
Sending notification to the patient. If not set/null the no notification is sent. HIS90: Codes are: J or Y (YES) only patient sms N (NO) no for both patients and relations R Relations only A All (both aptient and relations) |
|
SendNotification.Text |
|
|
Description of the notification, if used |
|
SendNotification.TypeOfNotification |
|
|
Type of notification to send. Valid values are: - SMS - Letter - EMail |
|
EvaluationDate |
|
|
Date
for evaluation of treatment or when the evaluation is done(ref status) Mandatory after evaluation is done. HIS90: If
WaitingListeGuarantee in CarePeriod(Get or Save) is set to J (YES), then EvaluationDate is
required when saving waiting list. PaqBook.Treated
date |
|
EstimatedNumberOfTreatmentDays |
|
|
Number
of estimated treatment days. |
|
EstimatedWaitingDays |
|
|
Number
of estimated days on waitinglist |
|
Reason |
|
|
Reason
for the waiting list instance. |
|
PreviousVisits.PreviousVisit |
|
|
Previous
visit date/Time. |
|
RequestedTreatmentOtherHospital |
|
|
Indicator,
indicating if the patient requests treatment in another hospital. HIS90: Valid
codes: J, N. (Default N) |
|
Group.Code |
|
|
Group
code. HIS90: Valid
code is found in PAQGROUP using |
|
Group.Name |
|
|
Group
description Not
used for Save method |
|
ClinicalArea.Code |
|
|
Clinical area code for waiting list. To get valid values for ClinicalArea use the CommonCodesWS with code type
ListClinicalAreaGroupCodes. HIS90: Fagområde |
|
ClinicalArea.Text |
|
|
Clinical area description for waiting list. |
|
Transfer.From.OtherHospital |
|
|
Indicator,
indicating if patient is transferred from other hospital. HIS90: N/A |
|
Transfer.From.OrginalStartDate |
|
|
If
patient is transferred from other hospital then this is the original start
date. HIS90: N/A |
|
Transfer.To.Code |
|
|
Inst.
code for another hospital where the patient/referral is to be moved
to/transferred. HIS90: If
Transfer.To.OtherHospital equal to J than Transfer.To.Code is mandatory
using ref. code from PAQREQR. Valid Reqr types 1, 7 or 8. |
|
Transfer.To.OtherHospital |
|
|
Indicator,
indicating if patient/referral is to be transferred to another hospital. HIS90: Valid
codes: J, N, . Default
by server |
|
Transfer.To.TransferDate |
|
|
Transfer
date HIS90: N/A |
|
Priority.Code |
|
|
Priority
code. Priority set by hospital. HIS90: Valid
codes is found in PAQPRIO |
|
Priority.PriorityModificationDate |
|
|
Date
when priority was set or modified. Current date when service is/was run. Set
by server. |
|
Priority.Name |
|
|
Description
of priority code Not
used for Save method |
|
Priority.PrioritySignedBy |
|
|
Changers
initials. Set
by server using information about user from security token. |
|
Priority.Organization.Id |
|
|
Department
changing/modifying priority. Internal Valid
values can be retrieved by the WS method OrganizationWS.ListOrganizations,
OrganizationWS.GetOrganization or OrganizationWS.GetOrganization2G |
|
Priority.Organization.ShortNameId |
|
|
Department
code Not
used for Save method |
|
Priority.Organization.Name |
|
|
Department
name Not
used for Save method |
|
AdministrationInformation.Code |
|
|
Code
associated to free text. The text can be used for administration of waiting list.
HIS90: Valid
code found in PAQFREE |
|
AdministrationInformation.Text |
|
|
Text
for administration of waiting list. |
|
CriticalDate |
|
|
Critical
date for appointment set by hospital |
|
CancellationOrPostponment.Code |
|
|
Cancel/postponement
Code |
|
CancellationOrPostponment. CancellationOrPostponmentDate |
|
|
Cancel
date/postponement date for referral/waiting list instance. Mandatory if
Cancel/postponement code is set. |
|
CancellationOrPostponment.ByPhone |
|
|
Patient
has been informed about the cancel/postponement by phone. HIS90: Valid
code J/N. Set
to N by server as default |
|
CancellationOrPostponment.Letter.LetterDate |
|
|
Date
when cancel/ postponement letter was sent. |
|
CancellationOrPostponment.Letter.
ToRequester.Code |
|
|
Code
used in cancel/ postponement letter to requester/requesting instance. Valid
code is using CommonCodesWS.ListLetterCodes HIS90: Valid
code is found in PAQLETT. |
|
CancellationOrPostponment.Letter.
ToRequester.Name |
|
|
Code
description Not
used for Save method |
|
CancellationOrPostponment.Letter.ToPatient.Code |
|
|
Code
used in cancel/ postponement letter to patient. Valid
code is using CommonCodesWS.ListLetterCodes HIS90: Valid
code is found in PAQLETT |
|
CancellationOrPostponment.Letter.ToPatient.Name |
|
|
Code
description Not
used for Save method |
|
CancellationOrPostponment.Letter.TextToPatient.Text |
|
|
Free
text used in cancel/ postponement letter. |
|
CancellationOrPostponment.Letter.TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: LCAT
= Letter Cancel Text |
|
Confirmed. ConfirmationDate |
|
|
Date
when the hospital has confirmed that referral is received. Set by server with
save/modify. |
|
Confirmed.ByPhone |
|
|
Used
if patient has been contacted by phone to confirm that referral has been
received. HIS90: Valid
codes J/N. Set by server to default N. |
|
Confirmed.Letter.
ToRequester.Code |
|
|
Code
used in confirmation letter to requester. Valid
code is using CommonCodesWS.ListLetterCodes HIS90: Valid
code is found in PAQLETT |
|
Confirmed.Letter.
ToRequester.Name |
|
|
Letter
code description Not
used for Save method |
|
Confirmed.Letter.
ToPasient.Code |
|
|
Code
used in confirmation letter to patient. Valid
code is using CommonCodesWS.ListLetterCodes HIS90: Valid
code is found in PAQLETT |
|
Confirmed.Letter.ToPasient.Name |
|
|
Letter
code description Not
used for Save method |
|
Confirmed.Letter.TextToPatient.Text |
|
|
Free
text used in confirmation letter to patient. HIS90: If
ICPC is registered in requisition than this is shown in booking_text_2 The
text is then in following format:
(Code type) Code description |
|
Confirmed.Letter.TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: BT1
= Booking Text 1 BT2
= Booking Text 2 LCOT = Letter Conf Text |
|
Admission.AdmissionDate |
|
|
Date
when patient is/was contacted about admittance. Set by server when letter is
created |
|
Admission.ByPhone |
|
|
Used
if in-patient has been contacted by phone to confirm admittance. HIS90: Valid
codes J/N. Default N by server |
|
Admission.Letter.ToRequester.Code |
|
|
Code
used in letter of admission confirmation to requester. Valid
code is using CommonCodesWS.ListLetterCodes HIS90: Valid
code is found in PAQLETT |
|
Admission.Letter.ToRequester.Name |
|
|
Letter
code description Not
used for Save method |
|
Admission.Letter.ToPatient.Code |
|
|
Code
used in letter to in-patient confirming admittance. Valid
code is using CommonCodesWS.ListLetterCodes HIS90: Valid
code is found in PAQLETT |
|
Admission.Letter.ToPatient.Name |
|
|
Letter
code description Not
used for Save method |
|
Admission.Letter.TextToPatient.Text |
|
|
Free
text used in admittance letter. |
|
Admission.Letter.TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: LIT
= Letter In Text |
|
Registration.Date |
|
|
Insertion
date of referral |
|
Registration.Organization.
Id |
|
|
Department
responsible for insertion of referral. Internal Set
by server using information from security token. |
|
Registration.Organization.ShortNameId |
|
|
Department
Code Not
used for Save method |
|
Registration.Organization.Name |
|
|
Department Name Not
used for Save method |
|
Registration.SignedBy |
|
|
Initials
of user inserting referral. Set by
server using information from security token. |
|
Update.Date |
|
|
Date
when waiting list instance was last modified. Set by server. |
|
Update.Name |
|
|
Not
used for Save method HIS90: Not
used |
|
Update.Organization.
Id |
|
|
Department
responsible for last modification of waiting list instance. Internal Set
by server using information from security token. |
|
Update.Organization.ShortNameId |
|
|
Department
Code Not
used for Save method |
|
Update.Organization.Name |
|
|
Department
Name Not
used for Save method |
|
Update.Organization.SignedBy |
|
|
Initials
of user that modified waiting list instance. Set by server using information
from security token. |
|
Update.UpdateCount [2] |
|
|
Count
used for concurrency testing when waiting list is updated. |
|
Returned
parameter |
Type |
Length
Byte |
Description
Comments |
|
|
SaveWaitingListResponse |
|
N/A Dynamic |
SaveWaitingListResponse
class according to XML schema WaitingList.xsd. |
|
|
Ids.Id |
|
|
The
internal id for the booking/appointment
HIS90: Booking
Id (Combined Id) |
|
|
Ids.Patient.Id.PatientId |
|
|
Patient
internal Id |
|
|
CarePeriodId |
|
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
|
Status |
|
|
Status
for waiting list/referral (HIS90) Fixed
statuses: Set
by server when waiting list is inserted/updated. HIS90: Se
codes for waiting list status |
|
|
InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
|
InDiagnosis.Code |
|
|
In
diagnosis using code from medical register, i.e. ICD10 |
|
|
InDiagnosis.Text |
|
|
Text
describing the in diagnosis. |
|
|
InDiagnosis.MedRegister.Id |
|
|
ICD
id |
|
|
InDiagnosis.MedRegister.Code |
|
|
Medical
register code. HIS90: N/A |
|
|
InDiagnosis.MedCode.MedRegister.Text |
|
|
Medical
register text |
|
|
TypeOfCare.Code |
|
|
TypeOfCare |
|
|
TypeOfCare.Text |
|
|
Set
by WS method |
|
|
Organization.MedicalUnit.Id |
|
|
Departement
Id |
|
|
Organization.MedicalUnit.ShortNameId |
|
|
Department
Code |
|
|
Organization.MedicalUnit.Name |
|
|
Department
name |
|
|
Organization.CareUnit.Id |
|
|
Care
Unit Id |
|
|
Organization.CareUnit.ShortNameId |
|
|
Care
Unit Code |
|
|
Organization.CareUnit.Name |
|
|
Care
Unit Name |
|
|
Organization.Section.Code |
|
|
Section
that care unit is part of. |
|
|
Organization.Section.Text |
|
|
HIS90: Not
found. |
|
|
RequestFrom.Organization.Id |
|
|
Requester
code. HIS90: Valid
codes are found in PAQREQR. |
|
|
RequestFrom.Organization.TypeOfId |
|
|
Type
of Id as defined by PAS. Empty/LOC/LOK
= Unkown or 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: Setting
LOC as default in WS as this is local requester code |
|
|
RequestFrom.
Organization.Code |
|
|
HIS90: Not
found. |
|
|
RequestFrom.Organization.Name |
|
|
Name
of requesting instance. |
|
|
RequestFrom.Physician.Id |
|
|
Requesting
physicians Id |
|
|
RequestFrom.Physician.TypeOfId |
|
|
Type
of Id as defined by PAS. Empty/LOC/LOK
= Unkown or 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 as LOC |
|
|
RequestFrom.
Physician.Code |
|
|
HIS90: Not
found. |
|
|
RequestFrom.Physician.Name |
|
|
Name
of requesting physician. HIS90: (Name
is found in PAQREQR using PaqBook.Reqr_Code_Phys and PaqReqr.Reqr_code) |
|
|
AppointmentType |
|
|
Appointment
type. HIS90: (T1-T4,
XT) |
|
|
EvaluatedBy.Id |
|
|
Physician
that evaluates case. Mandatory
after evaluation HIS90: PaqBook.Treated_By |
|
|
EvaluatedBy.Code |
|
|
HIS90: Not
found. |
|
|
EvaluatedBy.Name |
|
|
Name
of resource that has evaluated the case. Mandatory
when EvaluatedBy is in output. |
|
|
VisitType.Code |
|
|
Type
of consultation. HIS90:
Patient type. For
valid values see codetable. |
|
|
VisitType.Text |
|
|
Consultation
description. Set by server. HIS90:
Patient type. For
valid values see codetable. |
|
|
ReceivedDate |
|
|
Date
when waiting list is registered/received.
|
|
|
BookingDate.From |
|
|
Booking/Visit
time for patient if available/booked. |
|
|
BookingDate.To |
|
|
HIS90: Not
found. |
|
|
BookingText.Text |
|
|
Free
text from the referral/booking/waitinglist If
ICPC is registered in requisition than this is shown in booking_text_2 The
text is then in following format:
(Code type) Code description |
|
|
BookingText.TypeOfText |
|
|
The
element is set by the WS to code values: BT1
= Booking Text 1 BT2
= Booking Text 2 LCAT
= Letter Cancel Text LCOT
= Letter Conf Text LIT = Letter In Text |
|
|
EvaluationDate |
|
|
Date
for evaluation of treatment or when the evaluation is done(ref status) Mandatory after evaluation is done. HIS90:
PaqBook.Treated date |
|
|
EstimatedNumberOfTreatmentDays |
|
|
Number
of estimated treatment days. |
|
|
EstimatedWaitingDays |
|
|
Number
of estimated days on waitinglist |
|
|
Reason |
|
|
Reason
for the waiting list instance. |
|
|
PreviousVisits.PreviousVisit |
|
|
Previous
visit date/Time. |
|
|
RequestedTreatmentOtherHospital |
|
|
Indicator,
indicating if the patient requests treatment in another hospital. HIS90: Valid
codes: J, N. (Default N) |
|
|
Transfer.To.Code |
|
|
Inst.
code for another hospital where the patient/referral is to be moved
to/transferred. HIS90: If
Transfer.To.OtherHospital equal to J than Transfer.To.Code is mandatory
using ref. code from PAQREQR. Valid Reqr types 1, 7 or 8. |
|
|
Transfer.To.OtherHospital |
|
|
Indicator,
indicating if patient/referral is to be transferred to another hospital. HIS90: Valid
codes: J, N, . Default
by server |
|
|
Transfer.To.TransferDate |
|
|
|
|
|
Priority.Code |
|
|
Priority
code. Priority set by hospital. HIS90: Valid
codes is found in PAQPRIO |
|
|
Priority.PriorityModificationDate |
|
|
Date
when priority was set or modified. Current date when service is/was run. Set
by server. |
|
|
Priority.Name |
|
|
Description
of priority code |
|
|
Priority.PrioritySignedBy |
|
|
Changers
initials. Set
by server using information about user from security token. |
|
|
Priority.Organization.Id |
|
|
Department
changing/modifying priority. Internal HIS90: Code
and Name is found in PAQDEPT. Set
by server using information about user from security token. |
|
|
Priority.Organization.ShortNameId |
|
|
Department
code |
|
|
Priority.Organization.Name |
|
|
Department
name |
|
|
Group.Code |
|
|
Group
code. HIS90: Valid
code is found in PAQGROUP using |
|
|
Group.Name |
|
|
Group
description |
|
|
AdministrationInformation.Code |
|
|
Code
associated to free text. The text can be used for administration of waiting
list. HIS90: Valid
code found in PAQFREE |
|
|
AdministrationInformation.Text |
|
|
Text
for administration of waiting list. |
|
|
CriticalDate |
|
|
Critical
date for appointment set by hospital |
|
|
CancellationOrPostponment.Code |
|
|
Cancel/postponement
Code |
|
|
CancellationOrPostponment. CancellationOrPostponmentDate |
|
|
Cancel
date/postponement date for referral/waiting list instance. Mandatory if
Cancel/postponement code is set. |
|
|
CancellationOrPostponment.ByPhone |
|
|
Patient
has been informed about the cancel/postponement by phone. HIS90: Valid
code J/N. Set
to N by server as default |
|
|
CancellationOrPostponment.Letter.LetterDate |
|
|
Date
when cancel/ postponement letter was sent. |
|
|
CancellationOrPostponment.Letter.
ToRequester.Code |
|
|
Code
used in cancel/ postponement letter to requester/requesting instance. HIS90: Valid
code is found in PAQLETT. |
|
|
CancellationOrPostponment.Letter.
ToRequester.Name |
|
|
Code
description |
|
|
CancellationOrPostponment.Letter.ToPatient.Code |
|
|
Code
used in cancel/ postponement letter to patient. HIS90: Valid
code is found in PAQLETT |
|
|
CancellationOrPostponment.Letter.ToPatient.Name |
|
|
Code
description |
|
|
CancellationOrPostponment.Letter.
TextToPatient.Text |
|
|
Free
text used in cancel/ postponement letter. |
|
|
CancellationOrPostponment.Letter.
TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: LCAT
= Letter Cancel Text |
|
|
Confirmed. ConfirmationDate |
|
|
Date
when the hospital has confirmed that referral is received. Set by server with
save/modify. |
|
|
Confirmed.ByPhone |
|
|
Used
if patient has been contacted by phone to confirm that referral has been
received. HIS90: Valid
codes J/N. Set by server to default N. |
|
|
Confirmed.Letter.
ToRequester.Code |
|
|
Code
used in confirmation letter to requester. HIS90: Valid
code is found in PAQLETT using CommonCodesWS.ListLetterCodes |
|
|
Confirmed.Letter.
ToRequester.Name |
|
|
Letter
code description |
|
|
Confirmed.Letter.
ToPasient.Code |
|
|
Code
used in confirmation letter to patient. HIS90: Valid
code is found in PAQLETT |
|
|
Confirmed.Letter.
ToPasient.Name |
|
|
Letter
code description |
|
|
Confirmed.Letter.TextToPatient.Text |
|
|
Free
text used in confirmation letter to patient. HIS90: If
ICPC is registered in requisition than this is shown in booking_text_2 The
text is then in following format:
(Code type) Code description |
|
|
Confirmed.Letter.TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: BT1
= Booking Text 1 BT2
= Booking Text 2 LCOT
= Letter Conf Text |
|
|
Admission. AdmissionDate |
|
|
Date
when patient is/was contacted about admittance. Set by server when letter is
created |
|
|
Admission.ByPhone |
|
|
Used
if in-patient has been contacted by phone to confirm admittance. HIS90: Valid
codes J/N. Default N by server |
|
|
Admission.Letter.
ToRequester.Code |
|
|
Code
used in letter of admission confirmation to requester. HIS90: Valid
code is found in PAQLETT |
|
|
Admission.Letter.
ToRequester.Name |
|
|
Letter
code description |
|
|
Admission.Letter.ToPatient.Code |
|
|
Code
used in letter to in-patient confirming admittance. HIS90: Valid
code is found in PAQLETT |
|
|
Admission.Letter.
ToPatient.Name |
|
|
Letter
code description |
|
|
Admission.Letter.TextToPatient.Text |
|
|
Free
text used in admittance letter. |
|
|
Admission.Letter.TextToPatient.TypeOfText |
|
|
Coded
description for type of HIS90: LIT
= Letter In Text |
|
|
Registration. Date |
|
|
Insertion
date of referral |
|
|
Registration.Organization.
Id |
|
|
Department
responsible for insertion of referral. Internal Set
by server using information from security token. |
|
|
Registration.Organization.ShortNameId |
|
|
Department
Code |
|
|
Registration.Organization.Name |
|
|
Department
Name |
|
|
Registration.SignedBy |
|
|
Initials
of user inserting referral. Set by
server using information from security token. |
|
|
Update.
Date |
|
|
Date
when waiting list instance was last modified. Set by server. |
|
|
Update.Name |
|
|
HIS90: Not
used |
|
|
Update.Organization.
Id |
|
|
Department
responsible for last modification of waiting list instance. Internal Set
by server using information from security token. |
|
|
Update.Organization.ShortNameId |
|
|
Department
Code |
|
|
Update.Organization.Name |
|
|
Department
Name |
|
|
Update.Organization.SignedBy |
|
|
Initials
of user that modified waiting list instance. Set by server using information
from security token. |
|
|
Update.UpdateCount |
|
|
Count
used for concurrency testing when waiting list is updated. |
|
Schema for SaveWaitingListRequest: WaitingList.xsd
Schema
documentation for SaveWaitingListRequest: WaitingList.html
Sample xml
file for SaveWaitingListRequest: SaveWaitingListRequest.xml
Schema for SaveWaitingListResponse: WaitingList.xsd
Schema
documentation for SaveWaitingListResponse: WaitingList.html
Sample xml
file for SaveWaitingListResponse: SaveWaitingListResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx?op=SaveWaitingList
For description
of tag:ErrorDescription see HTML or XML document.
Related
methods or function used:
GetWaitingList: Method
is used to get a patients waiting list before update/change
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.
A valid
Authentication Block for RequestHeader
can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In the return
data from the method there will always be a ResponseHeader, which contains Error
Information and System Information. The Error Information block must always be
checked to determine if any error has occurred while processing the methods.
HIS-90 specific information
The server used in the method is CWBP02 (Service code 54538).
In case of an error, the WS method or the server
responds with an error and an error description in WS response header.
NO: Ved lagring av
vurdering for 1. venteliste i omsorgsperioden, og hvor venteliste
garanti(WaitingListGuarantee in CarePareiod) = J og omsorgsnivå(TypeOfCare.Code
i WaitingList) er I, D eller P, må
avklart dato settes i omsorgsperiode med bruk av SaveCarePeriod
før SaveWaitingList brukes for å oppdatere
ventelisten.
EN: When saving the
waitinglist after the first evaluation, and where waitinglist guarantee(CarePeriod)
is J (YES) and type of care(WaitingList) is I, D or P, the TreatmentDate have to
be updated with SaveCarePeriod before using SaveWaitingList to update the waiting list.
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
The method
is used for cancelling or postpone a waiting list for a selected pasient, based
on the waiting lists id.
Syntax:
CancelWaitingListResponse
=
CancelWaitingList(CancelWaitingListRequest)
|
Parameter
in |
Type |
Length
byte |
Description
Data format Valid data |
|
CancelWaitingListRequest |
|
N/A Dynamic |
CancelWaitingListRequest class according to XML schema WaitingList.xsd. |
|
Ids.Id |
int int |
|
The internal id for the waitinglist. HIS90: Combined id
WaitingListId Format: PatientId|BookingNo |
|
Ids.CarePeriodId |
int int |
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
Status |
int |
|
Status for waiting list/referral. HIS90: Set internally by
PAS server |
|
TypeOfCare.Code |
string |
|
Patients type of care. HIS90: I Innleggelse P Poliklinikk D Dagpasient T Telemedisin F Felles R Røntgen A Avvist |
|
TypeOfCare.Text |
string |
|
Set by WS method based on table in PAQCARE. |
|
EvaluatedBy.Id |
int |
|
Physician that evaluates case. Mandatory after
evaluation. HIS90: N/A |
|
EvaluatedBy.Code |
int |
|
HIS90: N/A |
|
EvaluatedBy.Name |
string |
|
Name of resource that has evaluated the case. Mandatory when/if EvaluatedBy.Id is in output. HIS90: N/A |
|
EvaluationDate |
date |
|
Date for evaluation of treatment or when/if the
evaluation is done. Mandatory after evaluation is done. HIS90: N/A |
|
EvaluationDateSpecified |
boolean |
|
HIS90: N/A |
|
Transfer.To.Code |
string |
|
Inst. code for another hospital where the
patient/referral is to be moved to/transferred. If Transfer.To.OtherHospital equal to J then
Transfer.To.Code is mandatory using ref. code from PAQREQR. Valid Reqr types
1, 7 or 8. |
|
Transfer.To.OtherHospital |
string |
|
Indicator, indicating if patient/referral is to be
transferred to another hospital. Valid codes: J, N, . Default by server When inserted/updated PAQCAPE is also to be updated. |
|
Transfer.To.TransferDate |
date |
|
HIS90: N/A |
|
Transfer.To.TransferDateSpecified |
boolean |
|
True if date is specified, else false. |
|
CancelOrPostponement.Code |
int |
|
Cancel/postponement code. |
|
CancelOrPostponement. CancelOrPostponementDate |
date |
|
Cancel date/postponement date for referral/waiting
list instance. Mandatory if CancelOrPostponement.Code is set. |
|
CancelOrPostponement.
CancelOrPostponementDateSpecified |
boolean |
|
True if date is specified, else false. |
|
CancelOrPostponement.ByPhone |
string |
|
Patient has been informed about the
cancel/postponement by phone. Valid code J/N. Set to N by server as default |
|
CancelOrPostponement.Letter.LetterDate |
date |
|
Date when cancel/postponement letter was sent. |
|
CancelOrPostponement.Letter.LetterDateSpecified |
boolean |
|
True if date is specified, else false. |
|
CancelOrPostponement.Letter.ToRequester[].Code |
string |
|
Code used in cancel/postponement letter to
requester/requesting instance. Valid code is found in PAQLETT using CommonCodeWS.ListLetterCodes |
|
CancelOrPostponement.Letter.ToRequester[].Text |
string |
|
|
|
CancelOrPostponement.Letter.ToPatient[].Code |
string |
|
Code used in cancel/postponement letter to patient. Valid code is found in PAQLETT using CommonCodeWS.ListLetterCodes |
|
CancelOrPostponement.Letter. ToPatient[].Text |
string |
|
|
|
CancelOrPostponement.Letter.TextToPatient[].Text |
string |
|
Free text used in cancel/postponement letter. |
|
CancelOrPostponement.Letter.TextToPatient[].TypeOfText |
string |
|
Coded value to describe text HIS90: LIT = Letter In Text |
|
Returned
parameter |
Type |
Length
Byte |
Description
Comments |
|
CancelWaitingListResponse |
|
N/A Dynamic |
CancelWaitingListResponse
class according to XML schema WaitingList.xsd. |
|
|
|
|
|
|
Ids.Id |
int int |
|
The internal id for the waitinglist. HIS90: Combined id
WaitingListId Format: PatientId|BookingNo |
|
Ids.CarePeriodId |
int int |
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
Schema for CancelWaitingListRequest: WaitingList.xsd
Schema
documentation for CancelWaitingListRequest: WaitingList.html
Sample xml
file for CancelWaitingListRequest: CancelWaitingListRequest.xml
Schema for CancelWaitingListResponse: WaitingList.xsd
Schema
documentation for CancelWaitingListResponse: WaitingList.html
Sample xml
file for CancelWaitingListResponse: CancelWaitingListResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx?op=CancelWaitingList
For
description of tag:ErrorDescription see HTML or XML document.
Related
methods or function used:
WaitlingListWS
GetWaitingList -
can be used for getting detailed infromation about the waitinglist after
CancelWaitinglist
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.
A valid
Authentication Block for RequestHeader
can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In the return
data from the method there will always be a ResponseHeader, which contains Error Information
and System Information. The Error Information block must always be checked to
determine if any error has occurred while processing the methods.
The server used in the method is CWBP01 (Service code 54533).
In case of an error, the WS method or the server
responds with an error and an error description in WS response header.
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
Gets a careperiod for a patients according to search criteria.
Syntax:
GetCarePeriodResponse =
GetCarePeriod(GetCarePeriodRequest)
|
Parameter
in |
Type |
Length
byte |
Description
Data format Valid data |
|
GetCarePeriodRequest: |
|
N/A Dynamic |
GetCarePeriodRequest
class according to XML schema WaitingListWS.xsd. |
|
Id |
string |
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
Returned
parameter |
Type |
Length
Byte |
Description
Comments |
|
GetCarePeriodResponse |
|
N/A Dynamic |
GetCarePeriodResponse
class according to XML schema WaitingListWS.xsd. |
|
CarePeriodDetailsType |
|
|
See schema documentation |
|
PatientId |
|
|
Internal patient id |
|
Id |
|
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
SequenceNumber |
|
|
The sequence number of the care period. HIS90: CAPE_NO |
|
Status.Code |
|
|
Status for
the CarePeriod Status code
is derived by the WS from content in
StatusDate2 and StatusDate3 See codetable for valid
CerPeriod statuses. |
|
Status.Text |
|
|
Set by the
Web service based on Code value |
|
Status.WaitingTimeEndedDate |
|
|
Status date when the waiting time has ended. HIS90: NoDate/Empty = Treatment is not started. Date = Waiting time has ended. Ready for
treatment/booking time. |
|
Status.CarePeriodClosedDate |
|
|
Status date of care period. HIS90: NoDate/Empty = Care period is open Date = Care period is closed, the date indicating
when it is/was closed. |
|
ActiveWaitingLists |
|
|
Flag
for if there still are active waiting lists connected to this care period. True=Active
waiting lists exists False=All
waiting lists closed/finished |
|
CareType.Code |
|
|
Start
care type when the care påeriode was created. Use
CommonCodeWS.ListCommonCodes
with CommonCodeType= CareTypeCodes to get valid codes. |
|
CareType.Text |
|
|
Description
of code for care type |
|
CareType.OID |
|
|
Code
set OID for care type code |
|
ClinicalArea.Code |
|
|
Clinical
area for application/referral. HIS90: Fagområde |
|
ClinicalArea.Text |
|
|
Description for
clinical area |
|
ReceivedDate |
|
|
Date when
referreal is registered/received. HIS90: Application_Date |
|
InDiagnosis.Id |
|
|
Internal Id of in
diagnosis. Valid values for
InDiagnosis.Id an be found by using use the CommonCodesWS.ListMedicalCodes HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
InDiagnosis.Code |
|
|
In diagnosis
using code from medical register, i.e. ICD10 |
|
InDiagnosis.Text |
|
|
|
|
InDiagnosis.MedRegister.Id |
|
|
|
|
InDiagnosis.MedRegister.Code |
|
|
HIS90: N/A |
|
InDiagnosis.MedCode.MedRegister.Text |
|
|
Text |
|
InProcedure.Id |
|
|
HIS90: N/A |
|
InProcedure.Code |
|
|
In
procedure/operation using code from medical register, i.e. NCSP or NCMP |
|
InProcedure.Text |
|
|
HIS90: N/A |
|
InProcedure.MedRegister.Id |
|
|
HIS90: N/A |
|
InProcedure.MedRegister.Code |
|
|
HIS90: N/A |
|
InProcedure.MedRegister.Text |
|
|
HIS90: N/A |
|
DiagnosisGroup.MainCode |
|
|
Main
Waitingtlist Diagnosis Code |
|
DiagnosisGroup.Code |
|
|
Waitingtlist
Diagnosis Code |
|
DiagnosisGroup.Name |
|
|
|
|
PatientClassificationGroup.Code |
|
|
Patient
classification group (Tilstandsgruppe) According to Volven 8478 Type
of code/code set used. If CodeType is set the Code must be filled in. If not
from from a code set/ is free text/comment the leave this NULL/Blank Use
CommonCodesWS.ListCommonCodes with code type PatientClassificationGroup to get valid values. |
|
PatientClassificationGroup.Text |
|
|
Description
of Patient classification group code |
|
PatientClassificationGroup.CodeType |
|
|
Code
set used for Patient classification group code If
the code is taken from a code set in ListCommonCodes this contains the
CommonCodeType enumerator). |
|
RequestFrom.Organization.Id |
|
|
Internal Id If
PaqReqr.Reqr_Type <> 3 the place the requester information in
organization Else if
PaqReqr.Reqr_Type =3 then place the requester information Physican |
|
RequestFrom.Organization.TypeOfId |
|
|
Type of Id
as defined by PAS. Empty/LOC/LOK
= Unkown or 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: Setting LOC as default in WS as this is local
requester code |
|
RequestFrom.Organization.ShortNameId |
|
|
Kortnavn/id
Requesters shortname/id HIS90: Kortnavn/id |
|
RequestFrom.Organization.Name |
|
|
Oragnization/department/unit
name |
|
RequestFrom.Physician.Id |
|
|
Internal Id
for the physican If
PaqReqr.Reqr_Type <> 3 the place the requester information in
organization Else if
PaqReqr.Reqr_Type =3 then place the requester information Physican |
|
RequestFrom.Physician.TypeOfId |
|
|
Type of Id
as defined by PAS. Empty/LOC/LOK
= Unkown or 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: Setting LOC as default in WS as this is local
requester code |
|
RequestFrom.Physician.Code |
|
|
Not
available in HIS90 |
|
RequestFrom.Physician.Name |
|
|
Requesters
name |
|
RequestFrom.CoPhysician.Id |
|
|
Internal Id
for the cophysican If
PaqReqr.Reqr_Type <> 3 the place the requester information in
organization Else if
PaqReqr.Reqr_Type =3 then place the requester information Physican |
|
RequestFrom.CoPhysician.TypeOfId |
|
|
Type of Id
as defined by PAS. Empty/LOC/LOK
= Unkown or 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: Setting LOC as default in WS as this is local
requester code |
|
RequestFrom.CoPhysician.Code |
|
|
Not
available in HIS90 |
|
RequestFrom.CoPhysician.Name |
|
|
Requesters
name |
|
TransferFromOtherHospital |
|
|
True
or False Valid
values in HIS is J/N This
is mapped True=J False=N |
|
OriginalStartDate |
|
|
Original
start date. HIS90: Ansinitetsdato,
Only set
if transfer from other hospitial equals to 'J' |
|
SkipOrginalStartDateChecks |
|
|
Skip checks
on OrginalStartDate when creating the care period. No functions on updateing
an existing care period |
|
FirstEvaluationDate |
|
|
First/inital
evaluation/assement date of refferal HIS90: ORIGINAL_TREATED_DATE |
|
DelayOccured |
|
|
If an delay
has occured. Valid values
is 1,2,3,Space(Blankt) |
|
TreatmentDate |
|
|
Deadline
date for treatment |
|
PatientTreatementConsent |
|
|
Flag for if patient or guardians have
consenteed/agreed to treatment of the patient. True or false if questian is
asked. If this is not asked leave tag null/blank |
|
WaitingListGuarantee |
|
|
Waintiglist guarantee Valid values are: R/B/I/V/Space(blank) (R=med rett til
, B=med behov for
, I=ikke behov for helsehjelp fra
spesialisthelsetjenesten Old values J and N can only be used with
waiting lists that are allready using these values. Waiting lists using new
values R, B and I can only be using the new ones. |
|
FreeHospitalChoice |
|
|
If patient
has used his right for choosing hospital. True if patient has choosed
hospital, else false or missing from response. |
|
NewHealthCondition |
|
|
New health condition
status for the care period (used by waiting list or referrals). Valid values
are: True or False, If
NewHealthCondition is missing/null this is not decided/blank in PAS. |
|
Comorbidity |
|
|
The presence
of coexisting or additional diseases with reference to an initial diagnosis. HIS90: Not Used |
|
Updated.Date |
|
|
Date when
inserted/last modified. |
|
Updated.Organization.Id |
|
|
Internal Organization
responsible for insertion/last modification of the instance. |
|
Updated.Organization.ShortNameId |
|
|
Organization Code |
|
Updated.Organization.Name |
|
|
Organization Name |
|
Updated.SignedBy |
|
|
Initials of
user that inserted/modified the instance. |
|
UpdateCount |
|
|
Count used
for concurrency testing when updated record. |
|
ExternalId |
|
|
Used for
electronic referrals. |
Schema for GetCarePeriodRequest: WaitingListWS.xsd
Schema
documentation for GetCarePeriodRequest: WaitingList.html
Sample xml
file for GetCarePeriodRequest: GetCarePeriodRequest.xml
Schema for GetCarePeriodResponse
: WaitingListWS.xsd
Schema
documentation for GetCarePeriodResponse : WaitingList.html
Sample xml
file for GetCarePeriodResponse : GetCarePeriodResponse .xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx?op=GetCarePeriod
For
description of tag:ErrorDescription see HTML or XML document.
Related
methods or function used:
SaveCarePeriod: Method
is used to save a patients care period
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS-90 spesific information:
Server used for the method is CWCP01 (Service code 54516). If the Id in the request is empty or is validated
false the WS wil return an error. If the response from the server contains an
error, the error information will be a part of the response. Calling system
must respond to error description in response. Header will indicate an error in
run and the TransactionErrorIndicator in message body will also indicate an
error.
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
Saves(creates or updates) one careperiod for a patients according to specified
criteria in the request.
Syntax:
SaveCarePeriodResponse = SaveCarePeriod(SaveCarePeriodRequest)
|
Parameter in |
Type |
Length byte |
Description Data format Valid data |
|
SaveCarePeriodRequest
|
|
N/A Dynamic |
SaveCarePeriodRequest
class according to XML schema WaitingListWS.xsd. |
|
CarePeriodDetailsType |
Datastructure according to WaitingList.xsd |
|
See schema documentation. Containing the
careperiod to be saved. |
|
PatientId |
|
|
Patient Id To get valid patient id use the PatientWS.
ListPatients or GetPatient |
|
Id |
|
|
Internal care period id. An id used to identify
associated waitinglists, contacts or referrals. HIS90: Combined id
CarePeriodId Format: PatientId|CapeNo |
|
SequenceNumber |
|
|
The sequence number of the care period. HIS90: N/A System will
assign SequenceNumber in database based on next
available number. |
|
Status.Code |
|
|
Status code for the careperiod. HIS90: Optional. When Code is given this is used in WS method to
check if correct combination of values/dates are set in WaitingTimeEndedDate
and CarePeriodClosedDate acccording to the status code. See codetable
for valid CerPeriod statuses and combination of dates. |
|
Status.Text |
|
|
Not used for save, only by get method. |
|
Status.WaitingTimeEndedDate |
|
|
Statusdate for when the waiting time has
ended. HIS90: NoDate/Empty = Treatment is not started. Date = Waiting time has ended. Ready for
treatment/booking time. See codetable
for valid combination of dates. |
|
Status.CarePeriodClosedDate |
|
|
Statusdate for careperiod HIS90: NoDate/Empty = CarePeriod i open Date = CarePeriod is closed, and the date
gives when it is closed. See codetable
for valid combination of dates. |
|
ClinicalArea.Code |
|
|
Clinical area for application/referral. To get valid values for ClinicalArea use the CommonCodesWS with code type
ListClinicalAreaGroupCodes. HIS90: Fagområde |
|
ClinicalArea.Text |
|
|
Not used for save, only by get method. |
|
ReceivedDate |
|
|
Date when referreal is
registered/received. HIS90: Application_Date |
|
InDiagnosis.Id |
|
|
Internal Id of in diagnosis. Valid values for InDiagnosis.Id an be found
by using use the CommonCodesWS.ListMedicalCodes
HIS90:
Combined ID: DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
InDiagnosis.Code |
|
|
Not used for save, only by get method |
|
InDiagnosis.Text |
|
|
Not used for save, only by get method. |
|
InDiagnosis.MedRegister.Id |
|
|
Not used for save, only by get method |
|
InDiagnosis.MedRegister.Code |
|
|
Not used for save, only by get method |
|
InDiagnosis.MedCode.MedRegister.Text |
|
|
Not used for save, only by get method. |
|
InProcedure.Id |
|
|
Not used for save, only by get method |
|
InProcedure.Code |
|
|
In procedure/operation using code from
medical register, i.e. NCSP or NCMP |
|
InProcedure.Text |
|
|
Not used for save, only by get method |
|
InProcedure.MedRegister.Id |
|
|
Not used for save, only by get method |
|
InProcedure.MedRegister.Code |
|
|
Not used for save, only by get method |
|
InProcedure.MedRegister.Text |
|
|
Not used for save, only by get method |
|
DiagnosisGroup.MainCode |
|
|
Main Waitingtlist Diagnosis Code Use CommonCodesWS.ListVHDGCodes to get
valid values. |
|
DiagnosisGroup.Code |
|
|
Waitingtlist Diagnosis Code Use CommonCodesWS. ListVDGRCodes to get
valid values. |
|
DiagnosisGroup.Name |
|
|
|
|
PatientClassificationGroup.Code |
|
|
Patient
classification group (Tilstandsgruppe) According to Volven 8478 Type
of code/code set used. If CodeType is set the Code must be filled in. If not
from from a code set/ is free text/comment the leave this NULL/Blank Use
CommonCodesWS.ListCommonCodes with code type PatientClassificationGroup to get valid values. |
|
PatientClassificationGroup.Text |
|
|
Description
of Patient classification group code |
|
PatientClassificationGroup.CodeType |
|
|
Code
set used for Patient classification group code If
the code is taken from a code set in ListCommonCodes this contains the
CommonCodeType enumerator). |
|
RequestFrom.Organization.Id |
|
|
Internal Id To get valid values for a requester use the
RequesterWS. ListRequesters or GetRequester HIS90: If requester type
is 1,7 or 8 then it is required to set TransferFromOtherHospital = J and set
the OriginalStartDate |
|
RequestFrom.Organization.TypeOfId |
|
|
Type of Id as defined by PAS. If Id ise used TypeOfId is requeird. Empty/LOC/LOK = Unkown or 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: Only LOC is
accepted as the local requester code |
|
RequestFrom.Organization.ShortNameId |
|
|
Not used for save, only by get method. |
|
RequestFrom.Organization.Name |
|
|
Not used for save, only by get method. |
|
RequestFrom.Physician.Id |
|
|
Internal Id for the physican To get valid values for a requester use the RequesterWS.ListRequesters or RequesterWS.GetRequester |
|
RequestFrom.Physician.TypeOfId |
|
|
Type of Id as defined by PAS. Empty/LOC/LOK = Unkown or 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 For
HIS90 settes denne til LOC |
|
RequestFrom.Physician.Code |
|
|
Not used for save, only by get method |
|
RequestFrom.Physician.Name |
|
|
Not used for save, only by get method. |
|
RequestFrom.CoPhysician.Id |
|
|
Internal Id
for the cophysican If
PaqReqr.Reqr_Type <> 3 the place the requester information in
organization Else if
PaqReqr.Reqr_Type =3 then place the requester information Physican |
|
RequestFrom.CoPhysician.TypeOfId |
|
|
Type of Id
as defined by PAS. Empty/LOC/LOK
= Unkown or 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: Setting LOC as default in WS as this is local
requester code |
|
RequestFrom.CoPhysician.Code |
|
|
Not
available in HIS90 |
|
RequestFrom.CoPhysician.Name |
|
|
Requesters
name |
|
TransferFromOtherHospital
|
|
|
True or False Valid values in HIS is J/N This is mapped True=J False=N |
|
OriginalStartDate |
|
|
Original start date for the patients
referral/start of care period. If TransferFromOtherHospital is set to J the
OriginalStartDate also is required. HIS90: Ansinitetsdato, Only set if transfer from other hospitial equals
'J' |
|
SkipOrginalStartDateChecks |
|
|
Skip checks
on OrginalStartDate when creating the care period. No functions on updateing
an existing care period |
|
FirstEvaluationDate |
|
|
First/inital
evaluation/assement date of refferal HIS90: ORIGINAL_TREATED_DATE |
|
DelayOccured |
|
|
Not used for save, only by get method. This is set by CancelWaitingList
based on which cancel codes is used. |
|
TreatmentDate |
|
|
Deadline
date for treatment HIS90: NB! See important
information about rules for waitinglist guarantee |
|
PatientTreatementConsent |
|
|
Flag for if patient or guardians have
consenteed/agreed to treatment of the patient. True or false if questian is
asked. If this is not asked leave tag null/blank |
|
WaitingListGuarantee |
|
|
Waintiglist guarantee Valid values are: R/B/I/V/Space(blank) (R=med rett til
, B=med behov for
, I=ikke behov for helsehjelp fra
spesialisthelsetjenesten Old values J and N can only be used with
waiting lists that are allready using these values. Waiting lists using new
values R, B and I can only be using the new ones. |
|
FreeHospitalChoice |
|
|
If patient
has used his right for choosing hospital. True if patient has choosed
hospital, else false or missing from response. |
|
NewHealthCondition |
|
|
New health condition
status for the care period (used by waiting list or referrals). Valid values
are: True or False, If
NewHealthCondition is missing/null this is not decided/blank in PAS. |
|
Comorbidity |
|
|
The presence
of coexisting or additional diseases with reference to an initial diagnosis. HIS90: Not Used |
|
Updated.Date |
|
|
Not used for save, set by PAS server. |
|
Updated.Organization.Id |
|
|
Not used for save, set by PAS server. |
|
Updated.Organization.ShortNameId |
|
|
Not used for save, set by PAS server. |
|
Updated.Organization.Name |
|
|
Not used for save, set by PAS server. |
|
Updated.SignedBy |
|
|
Not used for save, set by PAS server. |
|
UpdateCount |
|
|
Count used for concurrency testing when
updated record. |
|
ExternalId |
|
|
Used for electronic referrals. |
|
Returned
parameter |
Type |
Length
Byte |
Description
Comments |
|
SaveCarePeriodResponse |
|
N/A Dynamic |
SaveCarePeriodResponse class according to XML schema WaitingListWS.xsd. |
|
CarePeriodDetailsType |
Datastructure according
to WaitingList.xsd |
|
See schema documentation. Containing the new saved careperiod. Same Response as GetCarePeriod |
Schema for SaveCarePeriodRequest : WaitingListWS.xsd
Schema
documentation for SaveCarePeriodRequest: WaitingList.html
Sample xml
file for SaveCarePeriodRequest: SaveCarePeriodRequest.xml
Schema for SaveCarePeriodResponse: WaitingListWS.xsd
Schema
documentation for SaveCarePeriodResponse: WaitingList.html
Sample xml
file for SaveCarePeriodResponse: SaveCarePeriodResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx?op=SaveCarePeriod
For
description of tag:ErrorDescription see HTML or XML document.
Related
methods or function used:
GetCarePeriod: Method
is used to get a patients care period before update/change
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS-90 spesific information:
Server used for the method is CWCP01 (Service code 54530). If the Id in the request is empty or is validated
false the WS wil return an error. If the response from the server contains an
error, the error information will be a part of the response. Calling system
must respond to error description in response.
WS gets a beforeimage before trying to update/save
a careperiod. Values in request which is not set will be used from beforeimage.
Because of this it is possible to update only one field at a time and not the
whole structure .
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
Deletes one careperiod according to the spesified parameters in request.
Syntax:
DeleteCarePeriodResponse = DeleteCarePeriod(DeleteCarePeriodRequest)
|
Parameter
in |
Type |
Length
byte |
Description
Data format Valid data |
|
DeleteCarePeriodRequest: |
|
N/A Dynamic |
DeleteCarePeriodRequest class according to XML schema WaitingListWS.xsd. |
|
Id |
string |
|
HIS90: (string) Combined
id containing patientId and CapeNo seperated by | (mandatory) |
|
Returned
parameter |
Type |
Length
Byte |
Description
Comments |
|
DeleteCarePeriodResponse
|
|
N/A Dynamic |
DeleteCarePeriodResponse
class according to XML schema WaitingListWS.xsd. |
Schema for DeleteCarePeriodRequest: WaitingListWS.xsd
Schema
documentation for DeleteCarePeriodRequest: WaitingList.html
Sample xml
file for DeleteCarePeriodRequest: DeleteCarePeriodRequest.xml
Schema for DeleteCarePeriodResponseWaitingListWS.xsd
Schema
documentation for DeleteCarePeriodResponseWaitingList.html
Sample xml
file for DeleteCarePeriodResponse: DeleteCarePeriodResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/WaitingListWS/WaitingListWS.asmx?op=DeleteCarePeriod
For
description of tag:ErrorDescription see HTML or XML document.
Related
methods or function used:
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS-90 spesific information:
Server used for the method is CWCP01 (Service code 54539). If you try to delete a CarePeriod which contains
either a waitingList, booking or a contact the server will return an error. The
error information is part of the response. Calling system must respond to error
description in response. Header will indicate an error in run and the
TransactionErrorIndicator in message body will also indicate an error.
Applicable
systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
The method
is used for listing care periods for a selected patient. The list can be
filtered on either care period status and/or selected clinical area.
ListCarePeriodsResponse
= ListCarePeriods(ListCarePeriodsRequest)
|
Parameter in |
Type |
Length byte |
Description Data format Valid
data |
|
ListCarePeriodsRequest: |
|
N/A Dynamic |
ListCarePeriodsRequest class
according to XML schema WaitingListWS.xsd. |
|
PatientId |
|
|
Internal patient id Patient ids can be found by using PatientWS.ListPatients or PatientWS.GetPatients |
|
Status.Code |
|
|
Status for care periods. HIS90: See codetable for valid CarePeriod statuses. Default is 3 (All not closed) if nothing is set. |
|
ClinicalArea.Code |
|
|
If no code is specified all
clinical areas will be listed. Valid values can be retrieved by
using the CommonCodesWS.ListCliniclaAreaGroupCodes. |
|
Returned parameter |
Type |
Length Byte |
Description Comments |
|
ListCarePeriodsResponse |
|
N/A Dynamic |
ListCarePeriodsResponse class
according to XML schema WaitingListWS.xsd. |
|
CarePeriod |
|
|
See
schema documentation |
|
PatientId |
|
|
Internal patient id |
|
Id |
|
|
Internal
care period id. An id used to identify associated waitinglists, contacts or
referrals. HIS90: Combined id CarePeriodId Format: PatientId|CapeNo |
|
SequenceNumber |
|
|
The
sequence number of the care period. HIS90: CAPE_NO |
|
Status.Code |
|
|
Status for the CarePeriod Status code is derived by the WS from content in StatusDate2 and
StatusDate3 See codetable for valid CerPeriod statuses. |
|
Status.Text |
|
|
Set by the Web service based on Code value |
|
Status.WaitingTimeEndedDate |
|
|
Status date when
the waiting time has ended. HIS90: NoDate/Empty =
Treatment is not started. Date = Waiting
time has ended. Ready for treatment/booking time. |
|
Status.CarePeriodClosedDate |
|
|
Status date of
care period. HIS90: NoDate/Empty =
Care period is open Date = Care period
is closed, the date indicating when it is/was closed. |
|
ClinicalArea.Code |
|
|
Clinical area for application/referral. HIS90: Fagområde |
|
ClinicalArea.Text |
|
|
Description for clinical area |
|
WaitingList.ReceivedDate |
|
|
Date when referreal is registered/received. HIS90:
Application_Date |
|
WaitingList.InDiagnosis.Id |
|
|
Internal Id of in
diagnosis. Valid values for InDiagnosis.Id an be found by using use the CommonCodesWS.ListMedicalCodes HIS90: Combined ID:
DiagnosisMedCodeId. (register id|ICD|inDiagnosis) |
|
WaitingList.InDiagnosis.Code |
|
|
In diagnosis using code from medical register,
i.e. ICD10 |
|
WaitingList.InDiagnosis.Text |
|
|
|
|
WaitingList.InDiagnosis.MedRegister.Id |
|
|
|
|
WaitingList.InDiagnosis.MedRegister.Code |
|
|
HIS90: N/A |
|
WaitingList.InDiagnosis.MedCode.MedRegister.Text |
|
|
Text |
|
WaitingList.InProcedure.Id |
|
|
HIS90: N/A |
|
WaitingList.InProcedure.Code |
|
|
In procedure/operation using code from medical
register, i.e. NCSP or NCMP |
|
WaitingList.InProcedure.Text |
|
|
HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Id |
|
|
HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Code |
|
|
HIS90: N/A |
|
WaitingList.InProcedure.MedRegister.Text |
|
|
HIS90: N/A |
|
WaitingList.DiagnosisGroup.MainCode |
|
|
Main Waitingtlist Diagnosis Code |
|
WaitingList.DiagnosisGroup.Code |
|
|
Waitingtlist Diagnosis Code |
|
WaitingList.DiagnosisGroup.Name |
|
|
|
|
WaitingList.RequestFrom.Organization.Id |
|
|
Internal Id If PaqReqr.Reqr_Type <> 3 the place the
requester information in organization Else if PaqReqr.Reqr_Type =3 then place the
requester information Physican |
|
WaitingList.RequestFrom.Organization.TypeOfId |
|
|
Type of Id as defined by PAS. Empty/LOC/LOK = Unkown or 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: Setting LOC as default in WS as this is local requester code |
|
WaitingList.RequestFrom.Organization.ShortNameId |
|
|
Kortnavn/id Requesters shortname/id HIS90: Kortnavn/id |
|
WaitingList.RequestFrom.Organization.Name |
|
|
Organization/department/unit name |
|
WaitingList.RequestFrom.Physician.Id |
|
|
Internal Id for the physican If PaqReqr.Reqr_Type <> 3 the place the
requester information in organization Else if PaqReqr.Reqr_Type =3 then place the
requester information Physican |
|
WaitingList.RequestFrom.Physician.TypeOfId |
|
|
Type of Id as defined by PAS. Empty/LOC/LOK = Unkown or 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: Setting LOC as default in WS as this is local requester code |
|
WaitingList.RequestFrom.Physician.Code |
|
|
Not available in HIS90 |
|
WaitingList.RequestFrom.Physician.Name |
|
|
Requesters name |
|
TreatmentDate |
|
|
Deadline date for treatment |
|
WaitingListGuarantee |
|
|
Waintiglist guarantee Valid valies is: J/N/V/Space(Blankt) |
Schema for ListCarePeriodsRequest: WaitingListWS.xsd
Schema documentation for ListCarePeriodsRequest:
WaitingList.html
Sample xml file for ListCarePeriodsRequest:
ListCarePeriodsRequest.xml
Schema for ListCarePeriodsResponse: WaitingListWS.xsd
Schema documentation for ListCarePeriodsResponse:
WaitingList.html
Sample xml file for ListCarePeriodsResponse:
ListCarePeriodsResponse.xml
Web Service Response and
Request:
See http://imx-test.tehc.no/PasLink/WaitingListWS/WaitingListWS.asmx?op=ListCarePeriods
For description of
tag:ErrorDescription see HTML or XML document.
Related methods or function used:
Other references:
RequestHeader Information
required calling a method, containing authentication information.
ResponseHeader Information and
messages returned from the method, e.g. error codes/description,
system name or version.
Comments:
To use this method the RequestHeader must contain a valid Authentication Block and the system name is
required. An error will be raised if one of these is missing.
Valid Authentication Block for RequestHeader the can be retrieved by using the method GetUserLogin in Authentication-Web Service.
In return from the method there will
always be a ResponseHeader, which contains Error Information
and System Information. Error Information block must always be checked to
determine if any error has occurred while processing the methods.
HIS-90 spesific information:
Server used for the method is CWCP02 (Service code 54622). If the parameters in the request is empty or
is validated false the WS wil return an error. If the response from the server
contains an error, the error information will be a part of the response.
Calling system must respond to error description in the response.
If patient have more than on patient id in
HIS90 PAS, all care periods regardless of patient id will be listed for the
patient.
Applicable systems for method:
|
|
|
HIS-90 |
|
|
|
|
Description:
The method is used for changing the
care period on a specific waiting list.
Syntax:
ChangeWaitingListCarePeriodResponse =
ChangeWaitingListCarePeriod(ChangeWaitingListCarePeriodRequest)
|
Parameter in |
Type |
Length byte |
Description Data format Valid
data |
|
ChangeWaitingListCarePeriodRequest |
|
N/A Dynamic |
ChangeWaitingListCarePeriodRequest class according to XML
schema WaitingList.xsd. |
|
WaitingListId |
int int |
|
The
internal id for the waitinglist. HIS90: Combined id WaitingListId Format:
PatientId|BookingNo |
|
NewCarePeriodId |
int int |
|
Internal
care period id. An id used to identify associated waitinglists, contacts or
referrals. HIS90: Combined id CarePeriodId Format:
PatientId|CapeNo |
|
Returned parameter |
Type |
Length Byte |
Description Comments |
|
ChangeWaitingListCarePeriodResponse |
|
N/A Dynamic |
ChangeWaitingListCarePeriodResponse
class according to XML schema WaitingList.xsd. |
|
No response body from method, only
error code in ResponseHeader.ErrorInformation if something went wrong or
error occurred. |
|
|
|
Schema for ChangeWaitingListCarePeriodRequest: WaitingList.xsd
Schema documentation for ChangeWaitingListCarePeriodRequest: WaitingList.html
Schema for ChangeWaitingListCarePeriodResponse: WaitingList.xsd
Schema documentation for ChangeWaitingListCarePeriodResponse:
WaitingList.html
Web Service Response and
Request:
For description of
tag:ErrorDescription see HTML or XML document.
Related methods or function used:
WaitlingListWS ListWaitingLists - Listing/searching waiting lists
for patient
WaitlingListWS ListWaitingListsByOrg - Listing/searching waiting
lists for department/unit
WaitlingListWS GetWaitingList - Getting a specific waiting list
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.
A valid Authentication Block for RequestHeader can be retrieved by using the method GetUserLogin in Authentication-Web Service.
In the return data from the method
there will always be a ResponseHeader, which contains Error Information and System Information. The Error
Information block must always be checked to determine if any error has occurred
while processing the methods.
HIS-90 specific information
The server used in
the method is CWBP02 In case of an error,
the WS method or the server responds with an error and an error description in WS
response header.
|
Status code WS |
Description in
english |
Description in norwegian (from WS) |
PaqCape.
Care_Status_Date_2 |
PaqCape.
Care_Status_Date_3 |
Kommentar |
|
0 |
ALL |
ALLE |
N/A |
N/A |
|
|
1 |
OPEN TREATMENT NOT STARTED |
UAVKLART |
Date not set |
Date not set |
Treamtment not started or not evaluated. NO: Behandling ikke påbegynt |
|
2 |
OPEN |
VENTETID SLUTT |
Date set |
Date not set |
Treatment started or decided not given. NO: Behandling
startet/eller bestemt ikke gitt. Care_Status_Date_2 is set: |
|
3 |
ALL NOT CLOSED |
ALLE IKKE LUKKET |
Date not set or Date set[3] |
Date not set or Date set |
All not closed. Default staus code if
nothing is set. |
|
4 |
CLOSED |
LUKKET |
Date set |
Date set |
Responsibility is sent back to requester, or no further follow-up by
the hospital. NO: Ansvar tilbake til henvisende instans, eller ved ingen videre
oppfølging ved sykehuset. Care_Status_Date_3 is set: When last contact related to the actual referral
is closed (Manually). Alternatively the date is set by a batch job (OBICCAP3) in HIS90 PAS
form certain criteria. |
Also to be
found in PaqBook.Booking_status. Valid codes for waitinglist are:
|
Status text |
WaitingList Status |
Where to go for more |
Comments |
|
|
0 |
All waitinglist statuses |
N/A |
WaitingListWS |
List/get all waiting list
statuses. Only used for input in List method. |
|
1 |
WaitingListActive |
Active |
WaitingListWS |
Active waiting list |
|
2 |
WaitinglistCancelled |
Active |
WaitingListWS |
Cancelled waiting list |
|
3 |
WaitingListPostponed |
Active |
WaitingListWS |
Postponed waiting list |
|
4 |
AppointmentBooked |
Active |
WaitingListWS |
Waiting list resultid in a booked
appointment. |
|
5 |
AppointmentCancelled |
Active |
WaitingListWS |
Cancelled appointment |
|
6 |
AppointmentNotMet |
Passive |
ContactWS |
Patient did not meet |
|
7 |
RegisterredDayPatient |
Passive |
ContactWS |
Patient is registert meet as daypatient. (Outpatient). |
|
8 |
Admitted |
Passive |
ContactWS |
Patient is admitted (Inpatient) |
|
9 |
AppointmentPostponed |
Active |
WaitingListWS |
Postponed appointment |
|
10 |
WaitingListNoTreatment |
Active |
WaitingListWS |
Waiting list shall not be further
evalueted or not treatment is given. |
|
100 |
All Active/Booked/Postponed |
Active |
WaitingListWS |
This is a special status only for
use in request. Combination of status 1, 3, 4 and
9 to list all active, postponed and booked waiting lists for the patient |
A passive waitinglist is a waiting list which
has resulted in av contact. The waitinglist is finished and the waiting has
ended. For further information about patient please use ContactWS to get/change
information.
|
Code |
Text |
|
I |
Innleggelse |
|
P |
Poliklinikk |
|
D |
Dagpasient |
|
T |
Telemedisin |
|
F |
Felles |
|
R |
Røntgen |
|
A |
Avvist |
·
Use CommonCodesWS.ListCommonCodes with Type=AdmitCodes
or CommonCodesWS.ListAdmitCodes
to list all available codes. The list is derived from PAQADMI.
Groups of
type of care codes that are valid are as follows:
1.
Available for out-patient treatment and day treatment for out-patient
treatment.
2.
Available for in-patient treatment including day patient treatment on a care
ward.
3.
Available for both in-patient and policlinical treatment.
If type of
care is F then all codes are valid/available although not all are applicable.
As of
9.11.2007 the following codes are valid (according to PAQADMI):
|
(ADMIT_CODE) |
Description (ADMIT_DESC) |
TypeOfCare (LEGAL_CODE) |
|
B |
BREV |
1 |
|
E |
ERKLÆRING/UTTALELSE/MELDING |
1 |
|
EP |
EPOST |
1 |
|
F |
AVSLUTTET
KONSULTASJONSSERIE |
1 |
|
G |
AKTIVITETSGRUPPE |
1 |
|
H |
HJEMMEDIALYSE |
1 |
|
HJ |
HJELPEFUNKSJON |
1 |
|
I |
INNLAGT
PASIENT |
1 |
|
K |
FRA OG M/2. KONSULTASJON I SER |
1 |
|
KK |
KONTROLL AV PAS. MED KRONISK L |
1 |
|
M |
MØTE/SAMARBEID M/ANNET HELSEPE |
1 |
|
NS |
1.
BESØK I SERIE |
1 |
|
T |
TELEFON |
1 |
|
TM |
TELEMEDISIN |
1 |
|
TV |
TELE-/VIDEOKONFERANSE |
1 |
|
A1 |
AKUTT
REINNLEGGELSE STRAKS |
2 |
|
A2 |
AKUTT
REINNL. INNEN 6 TIMER |
2 |
|
A3 |
AKUTT
REINNL. INNEN 6-12 TIMER |
2 |
|
AV |
AVTALT
KONTROLL |
2 |
|
DA |
DØD VED
ANKOMST |
2 |
|
DF |
DØDFØDTE
BARN FØDEAVDELINGA |
2 |
|
DM |
DØD I
MOTTAKELSEN |
2 |
|
FS |
FØDT I
SYKEHUS |
2 |
|
PL |
PLANLAGT
REINNLEGGELSE |
2 |
|
ÅP |
ÅPEN
REINLEGGELSE |
2 |
|
N |
NY
ENKELTKONS./NYHENV.ELEKTIV |
3 |
|
SO |
SECOND
OPINION |
3 |
|
Ø1 |
ØHJELP
STRAKS |
3 |
|
Ø2 |
ØHJELP
INNEN 6 TIMER |
3 |
|
Ø3 |
ØHJELP
INNEN 6 - 24 TIMER |
3 |
·
Valid codes for
policlinical consultation
|
Code |
Text |
|
Ø1 |
Øyeblikkelig hjelp straks |
|
Ø2 |
Øyeblikkelig hjelp innen 6 timer |
|
Ø3 |
Øyeblikkelig hjelp innen 6 - 24 timer |
|
NS |
Første
konsultasjon i en besøksserie |
|
K |
Fra og med andre
konsultasjon i en konsultasjonsserie (en av flere |
|
N |
Enkel konsultasjon
(ikke i serie) |
|
F |
Avsluttet konsultasjonsserie |
|
I |
Innlagt pasient |
|
KK |
Kontroll av
pasient med kronisk lidelse |
|
HJ |
Hjelpefunksjon
(når det ved samme sykdom/behandling er behov for |
|
H |
Hjemmebehandling/hjemmedialyse |
|
SO |
Second opinion |
|
T |
Telefon |
|
TM |
Telemedisin |
|
TV |
Tele-/videokonferanse |
|
B |
Brev |
|
E |
Erklæring/uttalelse/melding |
|
EP |
Epost |
|
G |
Aktivitetsgruppe |
|
M |
Møte/samarbeid med
annet helsepersonell |
·
Valid codes for
in-patient consultation
|
Code |
Text |
|
A1 |
Akutt reinnleggelse straks |
|
A2 |
Akutt reinnleggelse innen 6 timer |
|
A3 |
Akutt reinnleggelse innen 6 - 24 timer |
|
AV |
Avtalt kontroll |
|
DA |
Død ved ankomst |
|
DF |
Dødfødte barn fødeavdelinga |
|
DM |
Død i mottakelsen |
|
FS |
Født i sykehus |
|
N |
Nyhenvist elektiv |
|
PL |
Planlagt reinnleggelse |
|
SO |
Second opinion |
|
Ø1 |
Øyeblikkelig hjelp straks |
|
Ø2 |
Øyeblikkelig hjelp innen 6 timer |
|
Ø3 |
Øyeblikkelig hjelp innen 6 - 24 timer |
|
ÅP |
Åpen reinnleggelse |
[1] For updating existing waiting list
the Ids.iD is required. When inserting new waiting lists the Ids.Id must be 0 (zero)
and the Ids.PatinetId and Ids.CarePeriodId is required
[2] UpdateCount is only requeired when
updating existing waiting list. Set to null or 0 when inserting new waiting
lists.
[3] All where not both dates is set. Set
only one date or none of the dates(both dates blank).