Version: 2.1.19073
Web Service
with methods to get and list organizations, and get resources within the
organization.
All methods
require a correct and verified Authentication Block from AuthenticationWS to
get any information from the HIS.
The
OrganizationWS Web Service contains these methods:
The Web Service reference is: OrganizationWS.asmx
Open in a
Web Browser for more detailed information about each method. The Web Service's WSDL, SOAP request and
response is described.
For more
detailed information as the Web Service's WSDL, SOAP request and response see:
https://linkws.service.tieto.com/PasLinkWS/OrganizationWS/OrganizationWS.asmx
Applicable
systems for method:
|
INFOMEDIX |
HIS-90 |
OFSP |
|
|
|
|
|
Description:
Lists a
hierarchical organizationunit structure under a specified organizationunit
node.
Syntax:
Organizations
= ListOrganization(OrganizationUnitId)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
OrganizationUnitId |
Number |
4 byte |
Organization's id in the HIS. Format N(9) Required. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
Class |
N/A Dynamic |
Organizations class according to schema
Orghierarchysimple.xsd |
|
|
Organization |
Class |
N/A Dynamic |
One organzation element within Organizations |
|
Id |
String |
|
Internal id for the organizationunit. HIS90: Not a unique id, only unique in combination with
TypeOfId |
|
TypeOfId |
String |
|
Type of Id as defined. Valid values for TyepOfId are: HIS90: Empty/LOC/LOK = Unkown or local id in PAS LIN = Local institution id LAV = Local medical unit /department id LAVC = Local medical unit code/shortname LEN = Local care unit id LENC = Local care unit code/shortname LUI = Local Unique Id (HIS90) HER = HER id (Norway) RSH = RESH id (Norway) REQRSH=RESH id form requester table Infomedix: LIN = Local institution id LCL = Local MedicalClinicRegistration and LAV = Local MedicalSpecialityRegistration and LEN = Local CareRegistration and CareList LVE = Virtual CareList unit id LV =
Vrtual MiedicalList and CareList unit id LGA = Grouping MedicalList unit id LGE = Grouping CareList unit id LG =
Grouping MedicalList and CareList unit For filtering of
units to be used in Infomedix listboxes, a typical TypeOfId filter
could be like this (used in RoS): For a registration
listbox: Medical units (sections) : LAV, LCLAV Care units (departments): LEN For a list group/report listbox: Medical
responsibility : LAV, LCLAV, Care
responsibility : LEN, LG, |
|
AdditionalIds.AdditionalId.Id |
String |
|
Additional ids for the organization unit E.g. can be HER-id, RESH-id, UniqueId etc |
|
AdditionalIds.AdditionalId.Type |
String |
|
Type for additional id. For valid values see description for TypeOfId
above. |
|
AdditionalIds.AdditionalId.Description |
String |
|
Description of the type of id |
|
ShortName |
String |
|
Short name/code of the organization unit. |
|
Name |
String |
|
Name of the organization unit. |
|
ParentId |
String |
|
Internal identificator for the parent of the
organization unit. |
|
AccessLevel |
Int |
|
Users accesslevel to this organization unit. |
|
VirtualUnit |
Bool |
|
True if unit is a virtual organization unit. I.
e. if it does not belong to any unit, but consists of other units (which does
not belong to this virtual unit). VirtualUnit is not a part of the formal
hierarchical tree HIS90: N/A |
|
ValidPeriod.ValidFrom |
DateTime |
|
From date for valid period |
|
ValidPeriod.ValidTo |
DateTime |
|
To date
for valid period |
|
Type |
String |
|
Type of unit HIS90: Valid values are: For medical units/departments (TypeOfId=LAV): A –
Administration I –
Sengepost (Inpatients) and Poliklinikk (Outpatients) M –
Mottagelse (Reception) R –
Røntgen B -
Blodbank For
CareUnits(TypeOfId = LEN) Enhet P –
Poliklinikk (Outpatients) I –
Sengepost (Inpatients) R –
Røntgen |
|
Properties.Property.MedicalSpeciality Registration.ValidPeriod.ValidFrom |
|
|
Infomedx
only information Valid period for medicalspeciality HIS90:
N/A |
|
Properties.Property.MedicalSpeciality Registration.ValidPeriod.ValidTo |
|
|
Infomedx
only information Valid period for medicalspeciality HIS90:
N/A |
|
Properties.Property.CareRegistration. ValidPeriod.ValidFrom |
|
|
Infomedx
only information Valid period for CareRegistration HIS90:
N/A |
|
Properties.Property.CareRegistration. ValidPeriod.ValidTo |
|
|
Infomedx
only information Valid period for CareRegistration HIS90:
N/A |
|
Properties.OrgProperty.Code |
|
|
Lists the properties an organization unit can
have. Valid values for code and text are: PESC - extra security/sensitive unit PPSYC – Psychiatriy PWOMD - Womens Department PLTTR - (Long Time Treatement) PPBFU -
Productivity Based Funding EXTECONOMY – Department uses external
economy(e.g. SAP) DEFLANG
– Default communication language for unit |
|
Properties.OrgProperty.Text |
|
|
Decsription of the OrgProperty.Code |
|
Properties.OrgProperty.
OrgPropertyValidPeriod.ValidFrom |
|
|
From date for valid period of a property |
|
Properties.OrgProperty.
OrgPropertyValidPeriod.ValidTo |
|
|
To date for valid period of a property |
|
SubsidiaryOrganization |
|
|
Sub organization units, Type Organization is
same as parent. Only different fields can be used |
|
OfficialID |
String |
|
Id compounded by INST_SHORTNAME + DEPT_CODE +
PAQUNIT.UNIT_CODE |
|
SectionCode |
String |
|
Section code for grouping units togheter HIS90: Only used for careunits(TypeOfId=LEN) Internal code for which section the care unit
participates in |
|
Clinic |
|
|
N/A For future use only |
|
Location |
|
|
N/A For future use only |
Schema for Organizations Orghierarchysimple.xsd
Schema
documentation for ContactProcedures: Orghierarchysimple.html
Sample xml
file for ContactProcedures: Orghierarchysimple.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/OrganizationWS/OrganizationWS.asmx?op=ListOrganization
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
HIS90 notes:
Server used for the
method is CWLO01. Service code for the method is 50512. There are no access restrictions for
users using this method.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
Tip:
The method ListOrganization can be very timeconsuming if there is many
Organization units to list, and the results from the method can therefore be
buffered by the caller to avoid repeating calls.
Applicable
systems for method:
|
INFOMEDIX |
|
|
|
|
|
|
Description:
Gets detailed
information about a specified organizationunit.
Syntax:
OrganizationDetails
= GetOrganization(OrganizationUnitId)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
OrganizationUnitId |
Number |
4 byte
Integer |
Organization id in the HIS. Format N(9) Required. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
OrganizationDetails |
class |
N/A Dynamic |
OrganizationDetails class according to schema
OrgDetails.xsd |
Schema for OrganizationDetails: OrgDetails.xsd
Schema
documentation for ContactProcedures: OrgDetails.html
Sample xml
file for ContactProcedures: OrgDetails.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/OrganizationWS/OrganizationWS.asmx?op=GetOrganization
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
INFOMEDIX |
HIS-90 |
|
|
|
|
|
Description:
Lists a
hierarchical organizationunit structure under a specified organizationunit
node.
List the
resources for a specified organization unit. The properties
wanted for thw resources can be specified with the date the resource is valid
to.
Syntax:
ResourceCollection =
ListResources(OrganizationUnitId, Properties, ValidFromDate)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|||
|
OrganizationUnitId |
Number |
4 byte |
Organization's id in the HIS. Format N(9) Required. |
|||
|
Properties |
String
Array |
N/A Dynamic |
An string containing from none to many properties, used to
select resources from PAS database. The properties can be delimited by
"|" character E.g. MEDRESP|CAREGROUP|CARERESP If this parameter is omitted or blank - all
properties for resources will be returned. |
|||
|
ValidFromDate |
DateTime |
N/A Dynamic |
The date for when the resource is valid. If omitted, blank date or not a valid date the
system time for now(currenttime) will be used when the method is called. |
|||
|
OfficialId |
String |
N/A |
Organization's official id in the HIS. Format string. Not Required. (Not used in Infomedix) |
|||
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|||
|
ResourceCollection
|
|
N/A Dynamic |
Resource collection class according to Resource
type XML schema Resource.xsd. |
|||
Schema for Resource type in ResourceCollection : Resources.xsd
Schema
documentation for Resource
: Resources.html
Sample xml
file for Resource : Resource.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/OrganizationWS/OrganizationWS.asmx?op=ListResources
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
Description of returned data:
If a
resource has several properties, one Resource record for every property will
exists in the ResourceCollection.
A resource's id, code and name can exists several
places in the collection, and is not necessarily an unique combination for the
resource and properties.
Tip:
The method ListResources can be very timeconsuming if there is many
Resources to list, and it is recommended the results from the method is
buffered by the caller to avoid repeating calls.
Applicable
systems for method:
|
INFOMEDIX |
|
|
|
|
|
|
Description:
Gets address
information for a specified organization unit .
Syntax:
OrganizationAddresses
GetOrganizationAddresses(OrganizationUnitId, ValidDate)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
OrganizationUnitId |
Number |
4 byte |
Organization's id in the HIS. Format N(9) Required. |
|
ValidDate |
DateTime |
N/A Dynamic |
The date for when the address is valid. If omitted, blank date or not a valid date the
system time for now(currenttime) will be used when the method is called. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
OrganizationAddresses
|
|
N/A Dynamic |
OrganizationAddresses class according to the XML
schema OrganizationAddresses.xsd. |
Schema for Organization
addresses in OrganizationAddresses : OrganizationAddresses.xsd
Schema
documentation for OrganizationAddresses
: OrganizationAddresses.html
Sample xml
file for OrganizationAddresses: OrganizationAddresses.xml
Web Service Response and Request:
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
INFOMEDIX |
|
|
|
|
|
|
Description:
Gets address
information for the institution of a specified organization unit
.
Syntax:
OrganizationAddresses
GetInstitutionAddresses(OrganizationUnitId, ValidDate)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
OrganizationUnitId |
Number |
4 byte |
Organization's id in the HIS. Format N(9) Required. |
|
ValidDate |
DateTime |
N/A Dynamic |
The date for when the address is valid. If omitted, blank date or not a valid date the
system time for now(currenttime) will be used when the method is called. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
OrganizationAddresses
|
|
N/A Dynamic |
OrganizationAddresses class according to the XML
schema OrganizationAddresses.xsd. |
Schema for Organization
addresses in OrganizationAddresses : OrganizationAddresses.xsd
Schema
documentation for OrganizationAddresses
: OrganizationAddresses.html
Sample xml
file for OrganizationAddresses: OrganizationAddresses.xml
Web Service Response and Request:
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
|
HIS-90 |
|
|
|
|
|
Description:
Get’s
detailed and extend information about a specified Organization, that is Institution,
department (MedicalUnit) or unit (CareUnit). If department is in request the
result includes accumulated information for the department.
Syntax:
GetOrganization2GResponse = GetOrganization2G(GetOrganization2GRequest)
|
Parameter
in |
Type |
Length
byte |
Description
|
|
GetOrganization2GRequest |
Class |
N/A Dynamic |
GetOrganization2GRequest class according to
schema Organization2G.xsd |
|
Id |
String |
|
Internal id for unit Required |
|
Type |
String |
|
Type of id in Id Required |
|
Returned
parameter |
Type |
Length
Byte |
Description
|
|
GetOrganization2GRepsponse
|
Class |
N/A Dynamic |
GetOrganization2GResponse class according to
schema Organization2G.xsd |
|
Id |
String |
|
Internal Id HIS90: Institution Code
/ Internal department number (Medical Unit number) / internal CareUnit
number. |
|
TypeOfId |
String |
|
Description/Type of Id Valid values are: LIN = Local Institution Id LAV= Local Department Id LEN = Local Unit Id |
|
AdditionalIds.AdditionalId.Id |
String |
|
Additional ids for the unit. This can both be internal and official ids. |
|
AdditionalIds.AdditionalId.Type |
String |
|
Type of additional id Valid values are: LIN = Local Institution Id LAV= Local Department Id LEN = Local Unit Id LAVC = Local Medical Unit Code/shortname LENC = Local Care Unit Code/shortname LUI = Local Unique Id HER= Her id RSH= Resh id HIS90: Uses/returns additional ids with LUI, LAVC.
LENC, HER or RSH |
|
AdditionalIds.AdditionalId.Description |
String |
|
Description of additional id |
|
ShortName |
String |
|
Short name/code for unit |
|
Name |
String |
|
Name of unit |
|
ParentId |
String |
|
Internal id for parent for unit, null/blank if
no parent. |
|
SectionCode |
String |
|
Section code. A section is a grouping of several
units |
|
Clinic.Id |
String |
|
Clinic id HIS90: N/A |
|
Clinic.TypeOfId |
String |
|
Type of id in clininc id HIS90: N/A |
|
Clinic.Code |
String |
|
Code for clinic HIS90: N/A |
|
Clinic.Name |
String |
|
Name for clinic HIS90: N/A |
|
Location.Id |
String |
|
Location id HIS90: N/A |
|
Location.TypeOfId |
String |
|
Type of id in Location id HIS90: N/A |
|
Location.Code |
String |
|
Code for Location HIS90: N/A |
|
Location.Name |
String |
|
Name for Location HIS90: N/A |
|
UnitStatus.Text |
String |
|
Status for unit HIS90: N/A |
|
UnitStatus.Comment |
String |
|
Comment for status for unit HIS90: N/A |
|
UnitStatus.ValidPeriod.ValidFrom |
DateTime |
|
Valid period for unit, startdate/(time) |
|
UnitStatus.ValidPeriod.ValidTo |
DateTime |
|
Valid period for unit, enddate/(time) |
|
Detail.ValidPeriode.ValidFrom |
DateTime |
|
Valid period for detail belonging to the unit,
startdate/(time) |
|
Detail.ValidPeriode.ValidTo |
DateTime |
|
Valid period for detail belonging to the unit,
enddate/(time) |
|
Detail.Type |
String |
|
Detail type HIS90: Medical Unit valid
values are: A-Administrasjon, I-Seng og Poliklinikk, M-Mottakelse, R-Røntgen, B-Blodbank Care unit valid values
are: P-Poliklinikk, I-Sengepost, R-Røntgen |
|
Detail.TypeOfWard |
String |
|
Type of ward HIS90: N/A |
|
Detail.NumberOfBedsNormal |
String |
|
Number of standardized beds at the unit |
|
Detail.NumberOfBedsForActualUse |
String |
|
Number of available beds at the unit |
|
DetailsUnitHistory.NumberOfTechnicalBeds |
String |
|
Number of technical beds available at the unit |
|
Detail.NumberOfDayPatientsNormal |
String |
|
Number of standardized day patients at the unit |
|
Detail.NumberOfDayPatientsAvailable |
String |
|
Number of day patients the unit can take |
|
Detail.ReasonForBedsNotInUse |
String |
|
Reason why not beds are in use |
|
Detail.WorkingDaysPrWeek |
String |
|
Number of working days at the unit |
|
Detail.Accumulation |
String |
|
The unit maximum number of days for accumulation |
|
Detail.Economy.CostCenter |
String |
|
The unit’s cost centre |
|
Detail.Economy.PaymentMethod.Code |
String |
|
Default payment method used at the unit |
|
Detail.Economy.PaymentMethod.Comment |
String |
|
Comment for payment method |
|
Detail.Economy.TransportCodes.Code |
String |
|
Default transport codes use for the unit HIS90: 1. Ledsager nødvendig, 2. Ledsager ikke nødvendig, 3. Lege/sykepleier nødvendig, 4. Ekstra skyss ikke nødvendig, 5. Ekstra skyss nødvendig for tur, 6. Ekstraskyss nødvendig for tur/retur, 7. Ekstraskyss nødvendig for retur, 9 ikke møtt. |
|
Detail.Economy.TransportCodes.Comment |
String |
|
Comments for the transport codes |
|
Detail.LetterDetails.LetterDetail.Code |
String |
|
Code for the default letters at the unit. The LetterDetails is a list with letter codes,
so the unit can have multiple codes. HIS90: Letter code |
|
Detail.LetterDetails.LetterDetail.Type |
String |
|
Type of letter code HIS90: Valide values are: LPAV – Deafult letter code for postponed
waitinglists/booking LELPA – Letter to the patients about evaluation
of waitinglist/waiting list received LCADV– Letter to the patients about policlinic
booking/visit (out-patient) LCELPA– Letter to the patients about
cancellation of waitinglists/booking LCADVLR– Letter to the patients about
cancellation of policlinic booking/visit (out-patient) LRELPA– Letter to the requester about
admittance/booking LRADV– Letter to the requester about policlinic
booking/visit (out-patient) |
|
Detail.LetterDetails.LetterDetail.Comment |
String |
|
Comment for the letter code |
|
Detail.Printers.Printer.Type |
String |
|
Code for the default printers at the unit. The Printers is a list with letter codes, so the
unit can have multiple printers. HIS90: Printer code |
|
Detail.Printers.Printer.Code |
String |
|
Type of printer code HIS90: Defaukt printer
codes for the unit Valide values are: PRLIN – Line printer PRLET –
Letter printer PRLAB –
Lab printer PRCRD – Card printer PRGIR – Giro printer |
|
Detail.Printers.Printer.Comment |
String |
|
Comment for the printer code |
|
Properties.TypeOfProperty |
String |
|
Properties is a list of properties TypeOfProperty tells which type of property the
unit has. HIS90: Valide values are: PPSYC - Psychiatric unit PWOMD – Womens only unit PLTTR – Long term treatment unit PISF – Unit with productivity based funding PESC – Unit with extra security EXTECONOMY – Department uses external
economy(e.g. SAP) DEFLANG
– Default communication language for unit |
|
Properties.Description |
String |
|
Description of the property |
|
Properties.ValidPeriod.ValidFrom |
DateTime |
|
Valid from date(time) of the property |
|
Properties.ValidPeriod.ValidTo |
DateTime |
|
Valid to date(time) of the property |
|
OrganizationAddressInformation.ContactPerson.Text |
String |
|
Name/Text of contact person for the unit |
|
OrganizationAddressInformation.ContactPerson.Comment |
String |
|
Comment for contact person |
|
OrganizationAddressInformation.EMailAddress.Text |
String |
|
Email address to the unit |
|
OrganizationAddressInformation.EMailAddress.Comment |
String |
|
Comment for email address |
|
OrganizationAddressInformation.Address.UnitMainEntrance |
String |
|
Description/Location for the unit main entrance |
|
OrganizationAddressInformation.Address.AddressLines.Code |
String |
|
Code for a addressline |
|
OrganizationAddressInformation.Address.AddressLines.Text |
String |
|
Addressline, it the street address and/or postal
address or other addresses the unit have. |
|
OrganizationAddressInformation.Address.AddressLines.Comment |
String |
|
Comment for the address line |
|
OrganizationAddressInformation.Address.PostalAddress.Code |
String |
|
Postal address code |
|
OrganizationAddressInformation.Address.PostalAddress.Text |
String |
|
Postal address city |
|
OrganizationAddressInformation.Address.PostalAddress.Comment |
String |
|
Comment for postal address |
|
OrganizationAddressInformation.PhoneNumber.Text |
String |
|
Phone number for the unit |
|
OrganizationAddressInformation.PhoneNumber.Extension |
String |
|
Extension for the unit |
|
OrganizationAddressInformation.PhoneNumber.Comment |
String |
|
Comment for the phone number |
|
OrganizationAddressInformation.FaxNumber.Text |
String |
|
Fax number for the unit |
|
OrganizationAddressInformation.FaxNumber.Comment |
String |
|
Comment for the fax number |
|
Registration.Date |
DateTime |
|
Information on first registration of this
organization. Date and time of first registration. HIS90: Set by PAS server program. |
|
Registration.Name |
String |
|
Name for user HIS90: Set by PAS server program. |
|
Registration.Organization.Id |
String |
|
Code of organization that first registered this
organization. HIS90: Set by PAS server program. |
|
Registration.Organization.TypeOfId |
String |
|
Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: N/A |
|
Registration.Organization.ShortNameId |
String |
|
Short name/code of organization. HIS90: Set by PAS server program. |
|
Registration.Organization.Name |
String |
|
Name of organization. HIS90: Set by PAS server program. |
|
Registration.SignedBy |
String |
|
Initials of person who originally created this
organization. HIS90: Set by PAS server program. |
|
Update.Date |
String |
|
Information on updated/current organization
instance. Date and time of updating. HIS90: Set by PAS server program. |
|
Update.Organization.Id |
String |
|
Code of organization updating organization
instance. HIS90: Set by PAS server program. |
|
Update.Organization.TypeOfId |
String |
|
Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: N/A |
|
Update.Organization.ShortNameId |
String |
|
Short name/code of organization. HIS90: Set by PAS server program. |
|
Update.Organization.Name |
String |
|
Name of organization. HIS90: Set by PAS server program. |
|
Update.SignedBy |
String |
|
Initials of person updating organization
instance. HIS90: Set by PAS server program. |
|
Update.UpdateCount |
Int |
|
Count used for concurrency testing when
organization is updated. |
Schema for
GetOrganization2G: Organization2G.xsd
Schema
documentation for GetOrganization2G: Organization2G.html
Sample xml
file’s for GetOrganization2G: GetOrganization2GRequest.xml GetOrganization2GResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/OrganizationWS/OrganizationWS.asmx?op=GetOrganization2G
Related methods
or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS90 specific information:
Server used for the
method is CWLO01. Service code for getting institution information is 51087,
for getting department information the service code is 51091 and for getting
service code for care unit is 51098.
There are
no access restrictions for users using this method.
Applicable
systems for method:
|
|
HIS-90 |
|
|
|
|
|
Description:
The method
is used for getting capacity and occupied beds in a care unit on selected date
and time. If date and time is not in input the capacity and occupancy is shown
as is on current date and time.
Syntax:
OrganizationStatus
= GetOrganizationStatus(CareUnitId, FromDate)
|
Parameter
in |
Type |
Length
byte |
Description
|
|
CareUnitId |
string |
N/A Dynamic |
Care unit Id. HIS90: Internal Id for CareUnit. PAQUNITE.UNIT_NO (integer) |
|
FromDate |
DateTime |
N/A Dynamic |
Query date and time. HIS90: Defaulted to current date and time. Care
Unit Status is to be shown on date and time in input. |
|
Returned
parameter |
Type |
Length
Byte |
Description
|
|
OrganizationStatus
|
Class |
N/A Dynamic |
OrganizationStatus class according to schema
OrgDetails.xsd |
|
Description: |
|
|
|
|
OrganizationStatus.OccupiedBeds.NoOfOccupiedBeds |
int |
|
Total number of all occupied beds in unit |
|
OrganizationStatus.OccupiedBeds.NoOfPatientBeds |
int |
|
Total difference between availability and
capacity in unit. |
|
OrganizationStatus.OccupiedBeds.NoOfTechnicalBeds |
int |
|
Number of all occupied technical beds, occupied
with patients with stay type "normal" or "day" in
selected unit |
|
OrganizationStatus.OccupiedBeds.Details.NoOfNormal |
int |
|
Number
of in-patients |
|
OrganizationStatus.OccupiedBeds.Details.NoOfDayPatients |
int |
|
Number of day and out patients. |
|
OrganizationStatus.OccupiedBeds.Details.NoOfEscort |
int |
|
Number of escorts that occupy beds. |
|
OrganizationStatus.OccupiedBeds.Details.NoOfHotel |
int |
|
Number of patients with stay type defined as
hotel |
|
OrganizationStatus.OccupiedBeds.Details.NoOfPatientHotel |
int |
|
Number of patients with stay type defined as
patient hotel |
|
OrganizationStatus.OccupiedBeds.Details.NoOfNewborn |
int |
|
Number
of newborn |
|
OrganizationStatus.OccupiedBeds.Details.NoOfReasearch |
int |
|
Number of patients with stay due to research |
|
OrganizationStatus.OccupiedBeds.Details.NoOfLeaves |
int |
|
Number of patients on leave in selected unit |
|
OrganizationStatus.OccupiedBeds.Details.NoOfMale |
int |
|
Combined count from number of male's that
occupies beds and male's that are day patients in selected unit |
|
OrganizationStatus.OccupiedBeds.Details.NoOfFemale |
int |
|
Combined count from number of females that
occupies beds and females that are day patients in selected unit |
|
OrganizationStatus.Capacity.NoOfBeds |
int |
|
Number of beds in selected unit |
|
OrganizationStatus.Capacity.NoOfAvailableBeds |
int |
|
Available bed capacity that can be used
in selected unit. |
|
OrganizationStatus.Capacity.NoOfTechnicalBeds |
int |
|
Number of technical beds in
the unit. ( A tecknical bed is a bed that is to be occupied with a pasient
from another department or care unit.) |
|
OrganizationStatus.Capacity.NoOfDayPlaces |
int |
|
Normalized capacity for day
patients in care unit. |
|
OrganizationStatus.Capacity.NoOfDayAvailableDayPlaces |
int |
|
Available capacity for day
patients in care unit. |
|
OrganizationStatus.LastDay.NoOfIn |
int |
|
Number of admitted patients
for selected unit on current date or date in query. |
|
OrganizationStatus.LastDay.NoOfOut |
int |
|
Number of discharged patients
for selected unit on current date or date in query. |
|
OrganizationStatus.LastDay.NoOfEmergency |
int |
|
Number of emergency
admittance on current date or date in query. |
Schema for
GetOrganizationStatus: OrgDetails.xsd
Schema
documentation for GetOrganizationStatus: OrgDetails.html
Sample xml
file for GetOrganizationStatus: OrganizationStatus.xml
Web Service Response and Request:
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS90 specific information:
Server used for the
method is CWLO01. Service code for the method is 50806. There are no access restrictions for
users using this method.
Applicable
systems for method:
|
|
HIS-90 |
|
|
|
|
|
Description:
The method lists the
organizations in PAS. The listing is a hierarchical organizationunit structure
starting with the organization(Institution, medical or care unit) specified in
the request/input.
The listing can be
more detailed by setting valid from and to dates for the organization units.
The response is the
same as for ListOrganizations
Syntax:
ListOrganizations2GResponse
= ListOrganizations2G(ListOrganizations2GRequest)
|
Parameter
in |
Type |
Length
byte |
Description
|
|
ListOrganizations2GRequest |
|
|
|
|
UnitId.Id |
String |
N/A Dynamic |
Id for parent unit to start the list from. HIS90: Internal Id. For Institution Id = 0 or the exact institution
id. If blank/null/omitted the default is all
organization(same as Id=0) |
|
UnitId.Type |
String |
|
Type of id in input/request. Valid vaules are: LIN = institution id LAV = department/medical unit id LEN = care unit id LINC = institution code/shortname LAVC = department/medical unit code/shortname LENC = care unit code/shortname HIS90: Optional, if Id is numeric and Type is not given
(Id is null, blank or 0) Type will be set to LAV (Institution). And if Id is
> 0 the Tyep is set to LAV (Department/avdeling). LENC is not supported by HIS90 |
|
ValidPeriod.ValidFrom |
DateTime |
|
Valid from date for the unit |
|
ValidPeriod.ValidTo |
DateTime |
|
Valid to date for the unit |
|
Returned
parameter |
Type |
Length
Byte |
Description
|
|
ListOragizationss2GResponse |
Class |
N/A Dynamic |
OrganizationStatus class according to schema
OrgDetails.xsd |
|
Organizations |
|
|
Same repsone as for ListOrganizations
method. See ListOrganizationsRepsonse for details. |
|
|
|
|
|
Schema for ListOrganization2G: Organization2G.xsd
Schema
documentation for ListOrganization2G: Organization2G.html
Sample xml
file for ListOrganization2G
Request: ListOrganizations2GRequest.xml
Sample xml
file for ListOrganization2G
Response: ListOrganizations2GResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/OrganizationWS/OrganizationWS.asmx?op=ListOrganizations2G
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS90 specific information:
Server used is same
sa for ListOrganization. This is PAS server CWLO01. Service code for the method
is 50512. There are no
access restrictions for users using this method.
Applicable
systems for method:
|
INFOMEDIX |
HIS-90 |
|
|
|
|
|
Description:
Get one specfic
resource based on an id and type of id
Syntax:
GetResourceResponse =
GetResource(GetResourceRequest)
|
Parameter
in |
Type |
Length
byte |
Description
|
|
GetResourceRequest |
|
|
|
|
ResourceId |
String |
N/A Dynamic |
Resource id HIS90:
Mandatory Either resource id og unique id ResourceId is a combined idDept_No|Resource_Code Or an uniqueid |
|
TypeOfResourceId |
String |
|
TypeOfId in ResourceId Valid values are: LOC=Local resource id Null/Blank=Local resource id LUI= Unique id in HIS90 PAS |
|
Returned
parameter |
Type |
Length
Byte |
Description
|
|
GetResourceResponse |
Class |
N/A Dynamic |
OrganizationStatus class according to schema
OrgDetails.xsd |
|
ResourceId |
String |
|
Resource
id HIS90: Mandatory ResourceId
is a combined idDept_No|Resource_Code |
|
TypeOfResourceId |
String |
|
TypeOfId
in ResourceId Valid
values are: LOC=Lokal
resource id |
|
AditionalIds.AdditionalId.Id |
String |
|
Other
additional ids for a resource. Use
AdditionalResourceIds |
|
AditionalIds.AdditionalId.Type |
String |
|
Type of
Id can be: LUI =
Local Unique Id HER =
HERid HPR =
HPR number |
|
AditionalIds.AdditionalId.Description |
String |
|
N/A |
|
Code |
String |
|
Resource
code |
|
Name |
String |
|
Resource
name |
|
ValidPeriod.ValidFrom |
DateTime |
|
Resource
valid from date |
|
ValidPeriod.ValidTo |
DateTime |
|
Resource
valid to date |
|
Properties.Property.Code |
String |
|
Property
code the resource have or category/type. |
|
Properties.Property.Text |
String |
|
Property
description the resource have or category/type. |
|
Properties.Property.ValidePeriod.ValidFrom |
DateTime |
|
Property
valid from date |
|
Properties.Property.ValidePeriod.ValidTo |
DateTime |
|
Property
valide to date |
|
AdditionalResourceIds.Id |
String |
|
AdditionalIds
if the resource have more ids. The value of the id as it is stored in the
database AdditionalResourceIds
can be a list/array if more than one id exists for resource |
|
AdditionalResourceIds.TypeOfId |
String |
|
Type of
id in Id. Valid
values are: UID =
User Id/Name FNR =
Persons official id LOC=
Local Id LUI =
Local Unique Id HER =
HERid HPR =
HPR number |
|
ResourceUnits.Id |
String |
|
Unit
the resource belongs to Internal
Id for the unit ResourceUnits
can be a list/array if more than one unit exists for resource |
|
ResourceUnits.TypeOfId |
String |
|
Type of
Id as defined by PAS. Empty/LOC
= Unkown lLocal 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 |
|
ResourceUnits.ShortNameId |
String |
|
Short
name/code for unit |
|
ResourceUnits.Name |
String |
|
Name of
unit |
|
ResourceUnits.AdditionalIds.Id |
String |
|
Additional
ids for the unit |
|
ResourceUnits.AdditionalIds.TypeOfId |
String |
|
KITH
code standard 8268 Some of the types
are: ENH=Off. org.no in Br.sund HER=HER-id RSH=RESH-id NPR=
NPR nr LOK=
Local id XXX=Annet Other
Tieto codes are: For
HIS90: LUI=UniqueId |
|
ResourceUnits.DefaultUnit |
Boolean |
|
The
resource default unit releated to this resource code |
|
LastChangedDate |
DateTime |
|
Date
(and Time if exists) when resource was last changed/updated |
|
|
|
|
|
Schema for Resource type in ResourceCollection : Resources.xsd
Schema
documentation for Resource
: Resources.html
Sample xml
file for Resource : Resource.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/OrganizationWS/OrganizationWS.asmx?op=GetResource
Related
methods or functions used:
GetUserLogin Used
to verify as user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain
a valid Authentication Block and the system name is required. An error will be
raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
form the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.