1.1 PatientWS – Patient

Version: 2.1.19036

The Web Service includes methods that handles demographic data about a patient. New patients can be inserted and patient data can be read and updated.

The PatientWS Web Service contains these methods:

• ListPatients
• GetPatient
• SavePatient
• GetPatientRelatives
• GetPatientIMF
• ListPatientsById
• GetResponsiblePerson
• ListPatientByOrg
• UpdateOfficialId
• GetPlacement
• GetPatientEmployers
• ListPatientsById2G
• ListPatientAdditionalInformations
• SavePatientAdditionalInformations
• ListPatientRelations
• SavePatientRelations

The Web Service reference is: PatientWS.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/PatientWS/PatientWS.asmx

1.1.1 ListPatients

Applicable systems for method:

INFOMEDIX

Classic

HIS-90

HL7

MasterPAS

Description:

Lists patients according to search criteria.

Syntax:

SimplePatientCollection = ListPatients(BirthDate, BirthDateTo, LastName, FirstName, Sex, County, Municipality, MaxRows, UseSoundex, Catastrophe)

Parameter in	Type	Length byte	Description – Data format – Valid data
BirthDate	DateTime	N/A Dynamic	The patients birth date
BirthDateTo	DateTime	N/A Dynamic	Used to search in a date interval. Patients will be listed in the date interval between BirthDate and BirthDateTo.
LastName	String	N/A Dynamic	If soundex is not used, patients with last names that begins with "Last name" will be listed. At least 2 characters must be given.
FirstName	String	N/A Dynamic	If soundex is not used, patients with first names or given names that begins with "First name" will be listed. HIS90 Notes: Soundex is not available. FirstName with an empty LastName parameter is not implemented.
Sex	String	N/A Dynamic	M = male, K = female, blank = both.
County	String	N/A Dynamic	Search on County code. Only available for HIS90.
Municipality			Search on Municipality code. Only available for HIS90.
MaxRows	Number	4 byte	Maximum number of patitens to retrieve. Format N(9) Null/0: List maximum 100 patients. HIS90 Notes: If more records exists, the NextKey field in responseheader is set to a value. Set this value in the NextKey field in requestheader to retrieve the next records of patients.
UseSoundex	String	N/A Dynamic	Use phonetically search for patient’s name. Only available for Infomedix and Classic. “True” if soundex is to be used.
Catastrophe	String	N/A Dynamic	Only available for Infomedix. “True” if searching for patients with catastrophe numbers.

INFOMEDIX: Rules for the use of method PatientWS.ListPatients:

- If both BirthDate and BirthDateTo are not filled in or blank minimum two (2)  character must be used in LastName

- If the interval between BirthDate and BirthDateTo is more than 31 days or less, LastName can be blank or omitted

- If the interval between BirthDate and BirthDateTo is more than 31 days minumum one(1) character must be used in LastName

Returned parameter	Type	Length Byte	Description – Comments
SimplePatientCollection		N/A Dynamic	Patient collection class according to XML schema SimplePatient.xsd.

Schema for SimplePatientCollection: SimplePatient.xsd

Schema documentation for SimplePatient: SimplePatient.html

Sample xml file for SimplePatient: SimplePatient.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=ListPatients

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

1.1.2 GetPatient

Applicable systems for method:

INFOMEDIX

Classic

HIS-90

HL7

MasterPAS

Description:

Gets data about one patient. Search can be made using either the internal patient id or the official id.

Syntax:

Patient = GetPatient(PatientId, OfficialId, TypeOfId)

Parameter in	Type	Length byte	Description – Data format – Valid data
PatientId	Number	4	Internal unique patient id. Use either this or the other parameters for getting a patient.
OfficialId	String	N/A Dynamic	The patient's official id.
TypeOfId	String	N/A Dynamic	Related to OfficialId. F = official id, N = emergency number, K = catastrophy number. Infomedix: F = official id H = new Norwegian emergency number C = new Norwegian catastropy number D = Norwegian D-number N = Swedish emergency number K = Swedish catastropy number. N and K are no longer in use for new Norwegian numbers, only for old id numbers. HIS90: Required only if inserting a new patient. F = official id N = emergency number

Returned parameter	Type	Length Byte	Description – Comments
Patient		N/A Dynamic	Patient class according to schema Patient.xsd. NB! See Patient.html or Patient.xsd for deatled information about fields/tags in Patient object.

Schema for Patient: Patient.xsd

Schema documentation for Patient: Patient.html

Sample xml file for Patient: Patient.xml

HIS90 notes for response:

Please note that the GetPatient only gets information valid at the time of request. No future information os fetched, and very litte historic information is returned.

AdditionalId structure for PID is old and will be obsoleted, Please use AdditionalIds instead.

D-number is listed in Id.AdditionalIds. The rule is that there can be no overlapping(internal date interval in HIS90 PAS) D-numbers. Only ONE D-number can be registred per day. Only D-number valid at request time is returned.

Economy - County, municipality, country and UrbanNeighbourhood is supported for economy. Freepass and Insurance is also return if found. Only Freepass(one) and Insurances(multiple) valid at request time is returned.

Name - Previous family name is set in the GivenName.

Telecom – HomePhoneNumber, OfficePhoneNumber(with extension), MobilePhoneNumber, EmailAddress, MobilePhoneReservation and EmailReservation are supported for Telecom. MobilePhoneReservation and EmailReservation has True/False values. If set to True the patient has reservation about the the uses of his/her mobile phone number and emai address. These can the not be used for regular contact. If set to False the no reservation, and email and mobile can be used for contacting the patient.

PersonalInformation - HealthCareCenter and PatientSecurity for PersonalInformation is not supported. AdditionalInformations for patient is supported. Only AdditionalInformations valid at request time is returned.

Only one of each type can be registred at the time(valid period) and older is automatically out-dated when registering a new AdditionalInformations on same type as already reqisteredand valid at the time.

CurrentContactStatus - The element for LastDateDischarged is set if Last_Date_Out_Meca (PAS) is set to a date.

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=GetPatient

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

1.1.3 SavePatient

Applicable systems for method:

INFOMEDIX

Classic

HIS-90

Description:

Save patient can be used both for inserting and updating a patient. If an official patient id is not given, an emergency number will be created for the patient.

Syntax:

Patient = SavePatient(Patient)

Parameter in	Type	Length byte	Description – Data format – Valid data
Patient		N/A	Patient class according to schema Patient.xsd.
Patient.Id.PatientId	Number	4	Internal id for the patients. Required if existing patient data is updated. If 0, a new patient will be inserted.
Patient.Id.OfficialId.TypeOfId	String	N/A Dynamic	Type of Id given in Value Required. F = official id, N = emergency number, K = catastrophy number. Infomedix: Required only if inserting a new patient. F = official id H = new Norwegian emergency number C = new Norwegian catastropy number D = Norwegian D-number N = Swedish emergency number K = Swedish catastropy number. N and K are no longer in use for new Norwegian numbers, only for old id numbers. HIS90: Required only if inserting a new patient. F = official id N = emergency number
Patient.Id.OfficialId.Value	String	N/A Dynamic	The patients id, e.g official id or emergency id. Required if you want to insert a patient and the id is known (TypeOfId = F or D). If you want to generate an emergency number for the patient, OfficialId/Value is not required and should be blank.
Patient.Id.AdditionalIds.Id	String		HIS90 Only information Additional ids for the patient HIS90: Not required. Contains D-number and internal patient ids. Not used when inserting new patients.
Patient.Id.AdditionalIds.TypeOfId	String		HIS90 Only information Type of id in AdditionalIds.Id HIS90: Valid values are: D = D-number DUF = DUF number from UDI LOC = Patient id (Only for read, cannot be inserted or updated) HIS90 restriction on D-number and DUF number, only one D/DUF-number can be added pr day.
Patient.Id.AdditionalIds.FormattedId	String		HIS90 Only information The id in AdditionalIds.Id formatted HIS90: Formatted D-number is DDMMYY NNNN
Patient.PersonalInformation.BirthDate	DateTime	N/A	Patient’s birthdate Required if OfficialId/Type = N and you want to insert a new patient. Infomedix: Norwegian: Not required if OfficialId/Type = H or C. The date of today wil be used for H. When using C, the birthdate will be ignored if it is given. HIS90: Required for inserting a new patient, either with official id or with emergency number. Patient/PersonalInformation/BirthCentury can be used instead of BirthDate if Patient/Id/OfficialId/Value conatins an official id.
Patient.PersonalInformation.Sex.Code	String	N/A Dynamic	Patient’s sex Required. M = male, K = female. HIS90: Sex.OfficialCode can be used instead of Code. Valid values for OfficialCode is 1= male and 2 = female.
Patient.PersonalInformation.Nationality.Code	String	N/A Dynamic	Patient’s nationality Required in HIS90 the create new patient. HIS90: CommonCodesWS and method ListNationalityCodes can be used to get valid codes.
Patient.PersonalInformation.AdditionalInformations.AdditionalInformation.Code	String		Code value, i.e. 2. If additional information is used, code is mandatory. Codes can be retrieved by using CommonCodesWS.ListCommonCodes, Type: PatientAdditionalInformationCodes.
Patient.PersonalInformation.AdditionalInformations.AdditionalInformation.CodeSystemOID	String		OID code for codes used in Patient.PersonalInformation.AdditionalInformations.AdditionalInformation.Code
Patient.PersonalInformation.AdditionalInformations.AdditionalInformation.TextDescription	String		Description of code in Patient.PersonalInformation.AdditionalInformations.AdditionalInformation.Code
Patient.PersonalInformation.AdditionalInformations.AditionalInformation.TypeOfCode.Code	String		Code type used. I.e. BA = Living alone (bor alene)
Patient.PersonalInformation.AdditionalInformations.AditionalInformation.TypeOfCode.CodeSystemOID	String		OID for codes type used in Patient.AdditionalInformations.AditionalInformation.TypeOfCode.Code. The same OID as Patient.AdditionalInformations.AditionalInformation.CodeSystemOID)
Patient.PersonalInformation.AdditionalInformations.AditionalInformation.TypeOfCode.TextDescription	String		Description of type of code
Patient.PersonalInformation.AdditionalInformations.AditionalInformation.ValidPeriode.From	String		Valid period from
Patient.PersonalInformation.AdditionalInformations.AditionalInformation.ValidPeriode.To	String		Valid period to
Patient.Name/...	String	N/A Dynamic	Patinet’s name is required. It is recommended to use LastName, FirstName, possibly MiddleName and GivenName. FormattedName may be used. If only FormattedName is used, this is split into LastName and FirstName. LastName is the characters up to the first space(Infomedix/Classic) or first comma(HIS90). FirstName up to the next space. E.g. format for HIS90 is: Lastname, Firstname
Address.AddressLines.AddressLine.Type	String	N/A Dynamic	Patient’s address Not required. Infomedix: There are three types of addresslines. The xml structure is 0 to many AddressLines. Valid values in AddressLine/Type are: 1: Addressline1 2: Addressline2 CO: C/O address. HIS90: 1: Addressline1
Patient.Address.PostalAddress.Code	String	N/A Dynamic	Patient’s postal code Required for Classic and HIS90.
Patient/Economy/EconomicAddress/Municipality/Code	String	N/A Dynamic	Patient’s municipality code Required for Classic and HIS90. HIS90: Format NNNN
Patient.Economy.Insurance.Id	String	20	HIS90 Only information Patients insurances E.g. EHIC or travel insurances HIS90: A patient can have more than one valid EHIC at the same time. All of these (valid or not) are displayed in response. Patient.Economy.Insurance.Id displays the EHIC number
Patient.Economy.Insurance.Type	String		HIS90 Only information Type of insurance HIS90: If Patient.Economy.Insurance.Id contains an EHIC number, “EHIC” is displayed in Patient.Economy.Insurance.Type.
Patient.Economy.Insurance.Text	String		HIS90 Only information Decsription of the inscurance Not in use for HIS90
Patient.Economy.Insurance.FromDate	Date	8	HIS90 Only information Inscurance valid from date HIS90: If EHIC the valid from dato does not show in respone
Patient.Economy.Insurance.ToDate	Date	8	HIS90 Only information Inscurance valid to date Only HIS90: EHIC: Shows valid to date
Patient.Economy.Insurance.InscuranceOffice.Id	String		HIS90 Only information Id for the foreign social office given on the EHIC card Required if EHIC is registered.
Patient.Economy.Insurance.InscuranceOffice.Name	String		HIS90 Only information Name for the foreign social office given on the EHIC card Required if EHIC is registered.
Patient.Economy.Insurance.InscuranceOffice.ForeignPatientId	String		HIS90 Only information Foreign/national social security number/patient id given on the EHIC card Required if EHIC is registered.
Patient.Economy.Freepass.Number	String		Patient’s freepass number HIS90: Freepass number, only valid freepassnumber is to be displayed
Patient.Economy.Freepass.ValidFrom	Date		Freepass valid from date HIS90: Valid from date for freepass
Patient.Economy.Freepass.ValidTo	Date		Freepass valid to date HIS90: Valid to date for freepass
Patient.Economy.EconomicAddress. UrbanNeighbourhood.Code	String	2	Urban neighbourhood code HIS90: This is a part of city in code, e.g 0101
Patient.Economy.EconomicAddress. UrbanNeighbourhood.Name	String		Urban neighbourhood name HIS90: This is a part of city in name, e.g Majorstuen
Patient.Telecom.MobilePhoneNumber	String	11	Patient’s mobile phone number
Patient.Telecom.MobilePhoneReservation	String	1	HIS90 Only information True if patient has reserved him / herself against contact by mobile phone. True = Patient has reserved for mobile phone use False = Patient has no reservation NULL (Means the XML tag MobilePhoneReservation is set null, MobilePhoneReservationSpecified=false) then MobilePhoneReservation is not decided, SavePatient will not change this for the patient. So if patient has not actively been asked for mobile phone reservation or not, leave this tag null/as is.
Patient.Telecom.EmailAddress	String		Patient’s e-mail address
Patient.Telecom.EmailReservation	String	1	HIS90 Only information True if patient has reserved him / herself against contact by e-mail. True = Patient has reserved for email use False = Patient has no reservation NULL (Means the XML tag EmailReservation and is set null, EmailReservationSpecified=false) then EmailReservation is not decided, SavePatient will not change this for the patient. So if patient has not actively been asked for email reservation or not, leave this tag null/as is.
Patient.CareLivingSituation.Code	string	N/A Dynamic	Code for The patient's living/care situation (Omsorgssituasjon) Ref code set in TypeOfCode below
Patient.CareLivingSituation.Text	string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Patient.CareLivingSituation.TypeOfCode	string	N/A Dynamic	Type of relations caregviver role/relation code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= CareLivingSituation to list valid codes/values. Ref Volven 8419
Patient.CareLivingSituation.Status	string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Patient.CareLivingSituation.ValidDatePeriod.From	string	N/A Dynamic	The period the item is valid from
Patient.CareLivingSituation.ValidDatePeriod.To	string	N/A Dynamic	The period the item is valid to
Patient.LivingWithPartner.Code	string	N/A Dynamic	Code for Patient livings with partner status. (Samlivsstatus) Ref code set in TypeOfCode below
Patient.LivingWithPartner.Text	string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Patient.LivingWithPartner.TypeOfCode	string	N/A Dynamic	Type of relations caregviver role/relation code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= PatientLivingWithPartner to list valid codes/values. Ref Volven 8414
Patient.LivingWithPartner.Status	string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Patient.LivingWithPartner.ValidDatePeriod.From	string	N/A Dynamic	The period the item is valid from
Patient.LivingWithPartner.ValidDatePeriod.To	string	N/A Dynamic	The period the item is valid to
Patient.NeedsTranslator.Code	string	N/A Dynamic	Code for If the patient needs translator Ref code set in TypeOfCode below
Patient.NeedsTranslator.Text	string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Patient.NeedsTranslator.TypeOfCode	string	N/A Dynamic	Type of relations caregviver role/relation code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= PatientTranslatorNeed to list valid codes/values. Ref Volven 8418
Patient.NeedsTranslator.Status	string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Patient.NeedsTranslator.ValidDatePeriod.From	string	N/A Dynamic	The period the item is valid from
Patient.NeedsTranslator.ValidDatePeriod.To	string	N/A Dynamic	The period the item is valid to
Patient.EPRInfoTransferConsent.Code	string	N/A Dynamic	Code for Status for getting the patient's consent to the transfer of medical records information. Ref code set in TypeOfCode below
Patient.EPRInfoTransferConsent.Text	string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Patient.EPRInfoTransferConsent.TypeOfCode	string	N/A Dynamic	Type of relations caregviver role/relation code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= EPRInfoTransferConsent to list valid codes/values. Ref Volven 9064
Patient.EPRInfoTransferConsent.Status	string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Patient.EPRInfoTransferConsent.ValidDatePeriod.From	string	N/A Dynamic	The period the item is valid from
Patient.EPRInfoTransferConsent.ValidDatePeriod.To	string	N/A Dynamic	The period the item is valid to
Patient.DocumentLanguage.Code	string	N/A Dynamic	Code for the patient default language for written communcations. Ref code set in TypeOfCode below
Patient.DocumentLanguage.Text	string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Patient.DocumentLanguage.TypeOfCode	string	N/A Dynamic	Type of relations caregviver role/relation code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= DocumentLanguageCodes to list valid codes/values.
Patient.DocumentLanguage.Status	string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Patient.DocumentLanguage.ValidDatePeriod.From	string	N/A Dynamic	The period the item is valid from
Patient.DocumentLanguage.ValidDatePeriod.To	string	N/A Dynamic	The period the item is valid to
Patient.Consentability.Code	string	N/A Dynamic	Code for the consent ability. Ref code set in TypeOfCode below
Patient.Consentability.Text	string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Patient.Consentability.TypeOfCode	string	N/A Dynamic	Type of consent ability code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= AdmYesNo to list valid codes/values.
Patient.Consentability.Status	string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Patient.Consentability.ValidDatePeriod.From	string	N/A Dynamic	The period the item is valid from
Patient.Consentability.ValidDatePeriod.To	string	N/A Dynamic	The period the item is valid to
Patient/UpdateCount	Number	2	HIS90 Only information HIS90: UpdateCount used for concurrencycheck when updating existing patient. Required for HIS90

Returned parameter	Type	Length Byte	Description – Comments
Patient		N/A Dynamic	Patient class according to schema Patient.xsd.

Schema for Patient: Patient.xsd

Schema documentation for Patient: Patient.html

Sample xml file for Patient: Patient.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=SavePatient

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

1.1.4 GetPatientRelatives

Applicable systems for method:

INFOMEDIX

HIS-90

Description:

Gets all the patient’s relatives.

Syntax:

PatientRelatives GetPatientRelatives(PatientId)

Parameter in		Type	Length byte	Description – Data format – Valid data
PatientId	Number		4	Internal patient id.

Returned parameter	Type	Length Byte	Description – Comments
PatientRelatives		N/A Dynamic	PatientRelatives class according to XML schema PatientRelatives.xsd.

Schema for PatientRelatives: PatientRelatives.xsd

Schema documentation for PatientRelatives: PatientRelatives.html

Sample xml file for PatientRelatives: PatientRelatives.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=GetPatientRelatives

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

1.1.5GetPatientIMF

Applicable systems for method:

INFOMEDIX

HIS-90

Description:

Gets all the patient’s important medical facts. For HIS90 only facts about blood are in response.

Syntax:

PatientIMF = GetPatientIMF(PatientId, Date)

Parameter in		Type	Length byte	Description – Data format – Valid data
PatientId	Int		4	Internal patient id. PatientIds can be found by using PatientWS.ListPatients or PatientWS.GetPatient HIS90: PAQPERS.PATIENT_ID (integer)
Date	DateTime		N/A Dynamic	From date (Not in use for HIS90)

Returned parameter	Type	Length Byte	Description – Comments
PatientIMF		N/A Dynamic	PatientIMF class according to XML schema PatientIMF.xsd.
Description for HIS90:
PatientId	Int		Internal patient id. (PAQPERS.PATIENT_ID)
Infections			HIS90: N/A
Cave			HIS90: N/A
Facts			HIS90: N/A
BloodInfo.BloodType	string	N/A Dynamic	HIS90: Patient blood type according to ABO-system. PAQPERS.BLOOD_TYPE. (char(3))
BloodInfo.RhesusType	string	N/A Dynamic	HIS90: Patient rhesus type. PAQPERS.RHESUS_TYPE. (char(1))
BloodInfo.GenoType	string	N/A Dynamic	HIS90: Patient genotype. PAQPERS.GENOTYPE. (char(6))
BloodInfo.Infection	string	N/A Dynamic	HIS90: Code that tells if there is an infection risk regarding patient blood. Ex. HIV-positive, Hepatitt BS-antigen positive or Hepatitt C-virus positive. The result is ‘JA’ if there is an infection risk. Method user must have PMED on level 6, 7 or 8 to se if patient has blood infection risk. If method user has no right to infection information than ‘*’ is default response. Based on PAQPERS.BLOOD_INFECTION. (char(2))
BloodInfo.Comment	string	N/A Dynamic	HIS90: Free text that in HIS90 is used to describe other factors than blood type, rhesus type, geno type or infection risk. Example: special blood factors. HIS90: Example – IKKE FORLIK. PAQPERS.BLOOD_INFORMATION_TEXT. (char(18))

Schema for PatientIMF: PatientIMF.xsd

Schema documentation for PatientIMF: PatientIMF.html

Sample xml file for PatientIMF: PatientIMF.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=GetPatientIMF

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

HIS90 specific information:

Server used for the method is CWMEDI1 and service code 51079. IPC: PWS9121.

The logged on user must have PMED function set to accesslevel 6, 7 or 8 to see if patient has blood infection risk. If the logged on user has no right to infection information, than ‘*’ is default in BloodInfo.Infection

1.1.6 ListPatientsById

Applicable systems for method:

INFOMEDIX

HIS-90

MasterPAS

Description:

Gets data about a list of patients. Search can be made using either the internal patient id or the official id.

Syntax:

PatientCollection = ListPatientsById(PatientIdSearch)

Parameter in	Type	Length byte	Description – Data format – Valid data
PatientIdSearch		N/A Dynamic	Patient Id collection class according to XML schema PatientIdSearch.xsd. Each record contains either the internal patient id or the official id.

Returned parameter	Type	Length Byte	Description – Comments
PatientCollection		N/A Dynamic	Patient collection class according to XML schema Patient.xsd. See GetPatientResponse

Schema for PatientIdSearch: PatientIdSearch.xsd

Schema documentation for PatientIdSearch: PatientIdSearch.html

Sample xml file for PatientIdSearch: PatientIdSearch.xml

Schema for PatientCollection: Patient.xsd

Schema documentation for PatientCollection: Patient.html

Sample xml file for PatientCollection: Patient.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=ListPatientsById

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

1.1.7 GetResponsiblePerson

Applicable systems for method:

INFOMEDIX

Description:

Gets responsible person of a given type for one patient. Search can be made using either the org. unit id, or a ContactId which in turn defines org. unit id.

Syntax:

ResponsiblePersonResponseCollection= GetResponsiblePerson(ResponsiblePersonsRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
ResponsiblePersonsRequest		N/A Dynamic	ResponsiblePersonsRequest class according to XML schema ResponsiblePersonsRequest.xsd.

Returned parameter	Type	Length Byte	Description – Comments
ResponsiblePersonResponseCollection		N/A Dynamic	ResponsiblePersonResponse collection class according to XML schema ResponsiblePersonResponse.xsd.

Schema for PatientIdSearch: ResponsiblePersonsRequest.xsd

Schema documentation for PatientIdSearch: ResponsiblePersonsRequest.html

Sample xml file for PatientIdSearch: ResponsiblePersonsRequest.xml

Schema for PatientCollection: ResponsiblePersonResponse.xsd

Schema documentation for PatientCollection: ResponsiblePersonResponse.html

Sample xml file for PatientCollection: ResponsiblePersonResponse.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=GetResponsiblePerson

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

1.1.8 UpdateOfficialId

Applicable systems for method:

Classic

HIS-90

Description:

The method is used for updating Official Id(s).

Syntax:

UpdateOfficialIdResponse = UpdateOfficialId(UpdateOfficialIdRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
UpdateOfficialIdRequest		N/A Dynamic	UpdateOfficialIdRequest class according to XML schema Pasientws.xsd.

Returned parameter	Type	Length Byte	Description – Comments
UpdateOfficialIdResponse		N/A Dynamic	UpdateOfficialIdResponse class according to XML schema Pasientws.xsd.

Schema for UpdateOfficialIdRequest: PasientWS.xsd

Schema documentation for UpdateOfficialIdRequest: PasientWS.html

Sample xml file for UpdateOfficialIdRequest: UpdateOfficialIdRequest.xml

Schema for UpdateOfficialIdResponse: PatientWS.xsd

Schema documentation for UpdateOfficialIdResponse: PatienWS.html

Sample xml file for UpdateOfficialIdResponse: UpdateOfficialIdResponse.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=UpdateOfficialId

Related methods or functions 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.

HIS90 spesific information:

As both emergency number and the new official Id are retrieved from official sources in pares no validation is done on gender. The first 2 characters in emergency number person-number part are validated in the web service. The characters must be equal as ‘0’. Only emergency numbers can be modified.

Server used for the method is CWPA90. All transactions in the request are committed at the same time. If there is an error in a transaction an error message is issued and there is a rollback. The server validates the new officialId using modulus11.

The UpdateOfficialId method checks if the operator using the method has user rights PPAS equal or higher than 8.

1.1.9 GetPlacement

Applicable systems for method:

HIS90

Description:

The method is used for retrieving placement information for a set of patients.

Syntax:

GetPlacementResponse = GetPlacement(GetPlacementRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
Patients		N/A Dynamic	Array of OfficialId

Returned parameter	Type	Length Byte	Description – Comments
GetPlacementResponse		N/A Dynamic	GetPlacementResponse class according to XML schema GetPlacement.xsd.

Schema for GetPlacement: GetPlacement.xsd

Schema documentation for GetPlacement: GetPlacementRequest GetPlacementResponse

Sample xml file for GetPlacement: GetPlacementRequest.xml GetPlacementResponse.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=GetPlacement

Related methods or functions 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.

1.1.10 ListPatientByOrg

Applicable systems for method:

INFOMEDIX

Classic

HIS-90

Description:

The method is used for listing patients based on organization search. The result collection can be filtered by:

organization (Medical Unit, Care Unit (is mandatory for INFOMEDIX/CLASSIC), Section (HIS90 only) and Care Group (HIS90 only)). If the result is to be filtered by Care Group then Medical Unit and/or Care Unit can not be used. Valid values for organization ids can be found by using OrganizationWS methods ListOrganizations, GetOrganization (INFOMEDIX) or GetOrganization2G (HIS90). Use the internal id from OrganizationWS.

period (from/to date (time)). Patient contact’s in selected period is to be listed.
HIS90 specific: If period is not in input then the from date is defaulted to start of current year and the to date to current date-time. Except for Status = AK where default from date is today if fromdate is missing or null in request.
INFOMEDIX/CLASSIC specific: If period is not in input then all active patients today will be listed.
If from date is in input and to date is not then to date will be defaulted to current date-tim. If the time period exceeds 60 days, it will be set to 60 days.

Type of Care.

Code:

For HIS90 Type of Care is mandatory input and type of care can only be I (in patients) or P (OutPatients/poliklinic).
For INFOMEDIX/CLASSIC Type of Care is not mandatory input and type of care can only be I (in patients), P (OutPatients/poliklinic) and D (in hospital only in day time).

CategoryCode: HIS90 only. Used for giving more details about type of care. If TypeOfCare.Code = I, valid subtypes are D (daypatient), E (stay without unit), H (24 hours), L (retinue), N (newborn), P (patienthotel), S (ward hospital). If TypeOfCare.Code = P, categorycode is ignored.

Status. One or more of following statuses can be used for filter the output list.
HIS90 only:

For type of care I: NY (NB! See fotnote. A new inpatient – with a contact period from-date in selected query period)[1], AK (active), FB (treatment finished but not discharged), UT (discharged), AL (NB! See footnote. Patients treated in the period)

For type of care P: AK (outpatient visit arrival registered), UT (outpatient visit finished registered)

INFOMEDIX/CLASSIC only:

AK (active patient) and UT (discharged).

OnlyMedicalUnitInfo. Return only information about the contact for the medical unit level. Only valid when Organization.MedicalUnit.Id is used. True = return only medical unit info for the contact. False = return all care units information for the contacts.

Response elements. Response elements can be used to further filter the result list (if equal to true then the contact information is listed. The default is false.)

o Patient_contact_all: All contact information is listed.

o Patient_contact_MedicalUnit: Information about Medical Unit is listed.

o Patient_contact_CareGroup (HIS90 only): Information about Care Group is listed. A Care Group is a collection of Care Units from different Medical Units grouped together.

o Patient_contact_Section (HIS90 only): Information about Section is listed. A Section is a group/collection of Care Units that are part of the same Medical Unit.

o Patient_contact_CareUnit: Information about the Care Unit is listed.

o Patient_contact_Placement: Information about patient placement is listed. This includes permanent placement at the Care Unit, temporary placement (for HIS90 this is regarded as technical bed) and temporary unit.

o Patient_contact_Leave (HIS90 only): Information about active leave for inpatient is listed.

o Patient_contact_CareResponsible: Name of person responsible for treatment of patient is listed. This is not in use for HIS90.

o Patient_contact_PatientResponsible: Name of person responsible for the patient. For HIS90 this is used for responsible treater. For INFOMEDIX/CLASSIC this is used for responsible medical person.

o Patient_contact_Confidential: Information about patient confidentiality/reservations is listed. For HIS90 this code is 0 – 3 where 3 is the most confidential level.
For INFOMEDIX this code is just an alphabetic code.
For CLASSIC this code is not in use.

Syntax:

ListPatientByOrgResponse = ListPatientByOrg(ListPatientByOrgRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
ListPatientByOrgRequest		N/A Dynamic	ListPatientByOrgRequest class according to XML schema Pasientws.xsd.

Returned parameter	Type	Length Byte	Description – Comments
ListPatientByOrgResponse		N/A Dynamic	ListPatientByOrgResponse class according to XML schema Pasientws.xsd.

Schema for ListPatientByOrgRequest: PasientWS.xsd

Schema documentation for ListPatientByOrgRequest: PatientWS.html

Sample xml file for ListPatientByOrgRequest: ListPatientByOrgRequest.xml

Schema for ListPatientByOrgResponse: PatientWS.xsd

Schema documentation for ListPatientByOrgResponse: PatientWS.html

Sample xml file for ListPatientByOrgResponse: ListPatientByOrgResponse.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=ListPatientsByOrg

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.

HIS90 spesific information:

Server used for the method is CWLP01. All patient contact information is retrieved and the method filters it internally.

Organization Ids in Request

The organization ids in the request are for HIS90 the internal numbers in the tables for DEPT and UNTE.

MedicalUnit.Id = PAQDEPT.DEPT_CODE (MedicalUnit.ShortName in OrganizationWS response)

CareUnit.Id = PAQUNTE.UNIT_ID (CarelUnit.ShortName in OrganizationWS response)

Section.Id = PAQUNTE.SECTION_CODE (Section.Id in OrganizationWS response)

CareGroup.Id = Inpatients(CareType=I) PAQSTAY.GROUP_CODE and OutPatients(CareType=P) PAQVIST.GROUP_CODE

1.1.11 GetPatientEmployers

Applicable systems for method:

HIS-90

Description:

Gets all patient’s Employers that are registrated in pasient system.

Syntax:

GetPatientEmployersResponse = GetPatientEmployers(GetPatientEmployersRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
GetPatientEmployersRequest		N/A Dynamic	GetPatientEmployersRequest class according to XML schema GetPatientEmployers.xsd
Description:
Id	Int	4	Internal patient id. . PatientIds can be found by using PatientWS.ListPatients or PatientWS.GetPatient Either internal or official id is mandatory as input to the method. HIS90: PAQPEMP.PATIENT_ID (integer)
OfficialId.Id	string	N/A Dynamic	Patient official Id. Either internal or official id are mandatory as input to the method. HIS90: PAQPERX.B_DATE + PAQPERX.P_NO (char(6)+char(5))
OfficialId.TypeOfId	string	N/A Dynamic	Type of official Id. Not used in HIS90.

Returned parameter	Type	Length Byte	Description – Comments
GetPatientEmployersResponse		N/A Dynamic	GetPatientEmployersResponse class according to XML schema GetPatientEmployers.xsd
Description:
PatientId	Int	4	Internal patient id. HIS90: PAQPEMP.PATIENT_ID. (integer)
PatientEmployer.Company	string	N/A Dynamic	Employers/Company name HIS90: PAQPEMP.COMPANY. (char(3))
PatientEmployer.Address	string	N/A Dynamic	Employers address. HIS90: Only one addressline pr. employer. PAQPEMP.PEMP_ADDRESS. (char(30))
PatientEmployer.PostalCode	string	N/A Dynamic	Employers postal number HIS90: PAQPEMP.POST_NO. (char(5))
PatientEmployer.PostalPlace	string	N/A Dynamic	Post office accourding to employers postal number. HIS90: PAQPOST.POST_OFFICE. (char(20))
PatientEmployer.PhoneNumber.Text	string	N/A Dynamic	Employers phone HIS90: PAQPEMP.PEMP_PHONE. (char(15))
PatientEmployer.PhoneNumber.Comment	string	N/A Dynamic	Comment or description regarding employer phone. Example: Phone type. HIS90: Not used for HIS90.
PatientEmployer.Profession.Code	string	N/A Dynamic	Patient profession by employer. HIS90: PAQPEMP.PROF_CODE. Description and definition of code is found in PAQPROF. (char(3))
PatientEmployer.Profession.Text	string	N/A Dynamic	Description of patient profession by employer. HIS90: PAQPROF.PROF_DESC. (char(20))
PatientEmployer.OfficialEmployerNumber	string	N/A Dynamic	Official employer number. HIS90: Not used.
PatientEmployer. InternalEmployerNumber	string	N/A Dynamic	HIS internal employer number. HIS90: Combined id (PatientId | SerialNoPemp). Serial number in combination with patient internal id identifies a instance of patient employer.
PatientEmployer.FromDate	dateTime	N/A Dynamic	From date for employment periode HIS90: Currently not used in HIS90. But if used than the date is in PAQPEMP.FROM_DATE. (char(8))
PatientEmployer.ToDate	dateTime	N/A Dynamic	To date for employment periode HIS90: Currently not used in HIS90. But if used than the date is in PAQPEMP.TO_DATE. (char(8))
PatientEmployer. UpdateCount	string	N/A Dynamic	Update count is used when updating an employer and for concurrency testing. HIS90: PAQPEMP.UPDATE_COUNT. (smallint)

Schema for GetPatientEmployers: GetPatientEmpoyers.xsd

Schema documentation for GetPatientEmployers: GetPatientEmpoyers.html

Sample xml file for GetPatientEmployers: GetPatientEmployersRequest.xml GetPatientEmployersResponse.xml

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=GetPatientEmployers

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

HIS90 specific information:

Server used for the method is CWMEDI1 and service code 51100.

There are no access restrictions for users using this method.

1.1.12 ListPatientsById2G

Applicable systems for method:

HIS-90

Description:

The method gets a list of patients by using the id (either internal pid or official id).

The response is a sub set of data as in GetPatient.

To avoid the performance issues with the method there is a limitation on 500 patienst per web service call.

Syntax:

ListPatientsById2GResponse = ListPatientsById2G(ListPatientsById2GRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
ListPatientsById2GRequest		N/A Dynamic	ListPatientsById2GRequest class according to schema PatientWS.xsd
Description:
Id			List Of Ids
Id.OfficialId.Value	string	N/A Dynamic	Patient’s Official id. Can also be an emergency number. Either OfficialId.Value or PatientId must be set. If both ids are missing in the request an error message is returned. If both OfficialId.Value and PatientId is given then PatientId is used.
Id.OfficialId.TypeOfId	string	N/A Dynamic	Type of OfficialId Valid values in code set are: F = official id N = Local Emergency number K = Catastrophy number U = Non human number D = Official D-number H = Emergency number HIS90: Only F and N are used here: N = 00 in two first in PAQPERS_P_NO F= All not N
Id.PatientId	Int		Internal patient id for the HIS Either OfficialId.Value or PatientId must be set. If both ids are missing in the request an error message will be returned. If both OfficialId.Value and PatientId is given then PatientId is used.

Returned parameter	Type	Length Byte	Description – Comments
ListPatientsById2GResponse		N/A Dynamic	ListPatientsById2GResponse class according to schema PatientWS.xsd
Description:
Id.Official.Id	string		Patient’s OfficialId (Fødselsnummer)
Id.Official.TypeOfId	string		TypeOfId in Id Valid values in code set are: F = official id N = Local Emergency number K = Catastrophy number U = Non human number D = Official D-number H = Emergency number LOC= LocalId/PID/PatientId HIS90: Only F and N are used D is placed in AdditionlaIds as all D-number patient in HIS90 always has a N-number also
Id.Official.FormattedId	string		The official id formatted to be used for viewing the number, ie. the Norwegian number 010133 56789. Only used when the Id have a special format.
Id.PatientId	int		Main Internal patient id in PAS HIS90: Additional internal patient ids is placed in AdditionalIds
Id.AdditionalIds.Id	string		Additional ids for a patient. This can be additional internal patient ids, previous N-number, D-number etc. TypeOfId below is used for setting id type. Fetching Previous Ids as earlier OfficialId or Reserve (N) number from PAQPERL PAQPERL.B_DATE PAQPERL.P_NO should be implemented in GetPatient and not ListPatientsById2G
Id.AdditionalIds.TypeOfId	string		TypeOfId in Id Valid values in code set are: LOC = LocalId/PID/PatientId F = official id N = Local Emergency/reserve number K = Catastrophy number U = Non human number D = Official D-number H = Emergency/reserve number with official format FH = Official Emergency/reserve DUF=UDI’s DUF number HIS90: Only LOC, F, N, D and DUF are used N = 00 in two first in PAQPERS.P_NO F= All not N in PAQPERL D = Values from PAQPEXI where INFO_TYPE=D DUF = Values from PAQPEXI where INFO_TYPE=DU
Id.AdditionalIds.FormattedId	string		The additional id formatted to be used for viewing the number HIS90: Usually not used.
Name.FormattedName	string		The person's names formatted in one string according to national or application's rules.
Name.LastName	string		Patient’s last name HIS90: Name is extracted from formatted name by same rules as in GetPatient/ListPatients
Name.MiddleName	string		Patient’s middle name HIS90: Name is extracted from formatted name by same rules as in GetPatient/ListPatients
Name.FirstName	string		Patient’s first name HIS90: Name is extracted from formatted name by same rules as in GetPatient/ListPatients
Name.GivenName	string		Patient’s given name HIS90: This previous last name, maiden last name.
Address			Address structure is used for where person/patient is living, either permanent and/or temporary. Economic addresses are in Economy structure and nationality is in PersonalInformation HIS90: Only permanent address available
Address.AddressLines.AddressLine.TypeOfText	string		TypeOfText is coding the type of address, Valid values for TypeOfText are: STR = Streetname and number POB=Postbox CO= CO address GPS=GPS coordinates HIS90: Set to STR in WS
Address.AddressLines.AddressLine.Text	string		Address, e.g. street name and number, house number, postbox etc.
Address.AddressLines.AddressLine.Sequence	N/A		Sequence of address if several of same type, if sequence is important
Address.PostalAddress.Code	string		Postal code where person/patient is living
Address.PostalAddress.Name	string		Postal address/city where person/patient is living
Address.Country.Code	N/A		Country code where person/patient is living HIS90: Det finnes ingen felt i HIS90 for å registrere bosteds land på utenlandske borgere. Men adresse og land kan registreres i POST_ADR feltet som fritekst dersom postkode (PostalAddress.Code) sette til 8888
Address.Country.Name	N/A		Country name where person/patient is living HIS90: Finnes ikke i HIS90
Address.County.Code	string		County code where person/patient is living
Address.County.Name	string		County name where person/patient is living
Address.Municipality.Code	string		Municipality code where person/patient is living
Address.Municipality.Name	string		Municipality name where person/patient is living
Address.UrbanNeighbourhood.Code	string		Urban neighborhood code where person/patient is living
Address.UrbanNeighbourhood.Name	string		Urban neighborhood name where person/patient is living
Address.AddiotionalAddresses	string		List of additional addresses, if no addresses then AddiotionalAddresses is null/omitted form the response
Address.AddiotionalAddresses.AddressLines.AddressLine.TypeOfText	N/A		TypeOfText is coding the type of adress, Valid values for TypeOfText are: STR = Streetname and number POB=Postbox CO= CO address GPS=GPS coordinates
Address.AddiotionalAddresses.AddressLines.AddressLine.Text	N/A		Address, e.g. streetname and number, house numbre, postboks etc.
Address.AddiotionalAddresses.AddressLines.AddressLine.Sequence	N/A		Sequence of address if several of same type, if sequence is important
Address.AddiotionalAddresses.PostalAddress.Code	N/A		Postal code
Address.AddiotionalAddresses.PostalAddress.Name	N/A		Postal address/city
Address.AddiotionalAddresses.Country.Code	N/A		Country code
Address.AddiotionalAddresses.Country.Name	N/A		Country name
Address.AddiotionalAddresses.AddressType	N/A		Adress type Valide vaules are: H Bostedsadresse HP Folkeregisteradresse HV Ferieadresse INV Faktureringsadresse PST Postadresse RES Besøksadresse TMP Midlertidig adresse WP Arbeidsadresse BAD Ubrukelig adresse
Telecom.Telephones	string		A list of telephones numbers
Telecom.Telephones.TypeOfText	string		Type of telephone number Valid TypeOfText values are: H Hjemme eller ukjent MC Mobiltelefon HV Ferietelefon F Fax Telefaks WC Arbeidsplass sentralbord WP Arbeidsplass
Telecom.Telephones.Text	string		Patient’s telephone number. HIS90: PHONE_HOME is type=H PHONE_WORK is type=WP PHONE_MOBILE is type=MC
Telecom.Telephones.Reservation	string		Boolean to show if patient has reserved the used of his/hers phone number (usually used with mobile phone number). Set to true if the patients has reservations about using his telephone number/email address
Telecom.Telephones.Extensions	string		Extension on phone number if applicable
Telecom.Emails	string		A list of emails numbers
Telecom.Emails.TypeOfText	string		Type of email addresses. Valid TypeOfText values are: EM Hjemme eller ukjent EMH Email home/private EMW Email work HIS90: Settes til EM
Telecom.Emails.Text	string		Pasients e-mail adresse
Telecom.Emails.Reservation	string		Boolean to show if patient has reserved the used of his/hers email address. Set to true if the patients has reservations about using his telephone number/email address
PersonalInformation.BirthDate	string		Birthdate of person Complete birthdate including century
PersonalInformation.BirthMunicipality.Code	string		Municipality code where person/patient was born
PersonalInformation.BirthMunicipality.Name	string		Municipality name where person/patient was born
PersonalInformation.Sex.Code	string		Person's sex HIS90: M = male, K = female, blank/space=Unknown
PersonalInformation.Sex.OfficialCode	string		Official code HIS90: Uses KITH standard as 1 = Male / Mann 2 = Female / Kvinne 9 = Unknown / Ukjent
PersonalInformation.Sex.Text	string		Description of code. Set in WS
PersonalInformation.Dead.DeathDate	dateTime		Death date of person, only set if dead
PersonalInformation.Nationality.Code	string		Nationality code of patient
PersonalInformation.Nationality.Text	string		Description of nationality code
PersonalInformation.Language.Code	string		Language of patient
PersonalInformation.Language.Text	string		Description of language code
PersonalInformation.ExternalDoctor.Id	string		External doctor’ s id Norway: Primaray care doctor (Fastlege) for patient
PersonalInformation.ExternalDoctor.Code	string		External doctor’ s code HIS90: Not Used
PersonalInformation.ExternalDoctor.Name	string		External doctor’ s name
Economy.SocialInsuranceNation.Code	string		Social insurance nation code of patient. Country/nation code
Economy.SocialInsuranceNation.Text	string		Description of social insurance nation code. Country name
Economy.Freepass.Number	string		Free pass number or text about having free pass. Only free passes valid on today will be shown. Please us the tag/field HaveFreepass if only interested in checking if having free pass. HIS90: Either free pass number is shown or the letter J(for YES) if patient have an free pass.
Economy.Freepass.ValidPeriod.FromDate	dateTime		From date for pree pas. Usually set to the date when free pass is acquired.
Economy.Freepass.ValidPeriod.ToDate	dateTime		To date for the free pass HIS90/Norway: Usually set to end of year 31.12.20xx
Economy.Freepass.HaveFreepass	boolean		If Patient have free pass True = Have free pass False = Not free pass Missing/Blank = Not known if have free pass
Economy.Insurance	string		List of patients insurance or EHIC(EU Health Insurance Card)
Economy.Insurance.Id	string		Insurance card number or policy
Economy.Insurance.Type	string		Type of card or policy Hvis Patient.Economy.Insurance.Id inneholder EHIC nummer vises teksten ’EHIC’ i feltet
Economy.Insurance.Text	string		Description of card or policy
Economy.Insurance.ValidPeriodFromDate	dateTime		Valid period for insurance, from date
Economy.Insurance.ValidPeriod.ToDate	dateTime		Valid period for insurance, to date
Economy.Insurance.InsuranceOffice.Id	string		Id for Social security office or Insurance company
Economy.Insurance.InsuranceOffice.Name	string		Name for Social security office or Insurance company
Economy.Insurance.InsuranceOffice.ForeignPatientId	string		External or foreign patient id related to the insurance
ContactStatus.Current			Current contact, only displayed if patient is an active in-patient or has an out-patient registration same day as query is done. If not this node will be omitted/NULL
ContactStatus.Current.ContactId	string		Contact id, only if patient hav an active contact at the tome of WS call. Use ContactWS.GetContact to get more details of the contact if applicable.
ContactStatus.Current.TypeOfCare.Code	string		Type of care code. Valid values are: P = Outpatient (MECA/STAY) I = Inpatient (VIST)
ContactStatus.Current.TypeOfCare.Text	string		Description of TypeOfCare Valid values are: P = Outpatient I = Inpatient
ContactStatus.Current.Institution.Id	string		Institution id Detail about Institution can be fetched with OrganizationWS.GetOrganization2G
ContactStatus.Current.Institution.TypeId	string		Type of id above Is set to LIN to idetu it as Institution
ContactStatus.Current.Institution.ShortNameId	string		Shortname /code for Institution HIS90: Example TR or LE
ContactStatus.Current.Institution.Name	string		Institution name
ContactStatus.Current.MedicalUnit.Id	string		Internal medical unit id Detail about Institution can be fetched with OrganizationWS.GetOrganization2G
ContactStatus.Current.MedicalUnit.TypeId	string		Set to “LAV” for medical unit
ContactStatus.Current.MedicalUnit.ShortNameId	string		Short name /code for medical unit
ContactStatus.Current.MedicalUnit.Name	string		Name for medical unit
ContactStatus.Current.CareUnit.Id	string		Care unit wher patient is active or is visting. Detail about Institution can be fetched with OrganizationWS.GetOrganization2G
ContactStatus.Current.CareUnit.TypeId	string		Set to “LEN” for care unit
ContactStatus.Current.CareUnit.ShortNameId	string		Short name /code for care unit
ContactStatus.Current.CareUnit.Name	string		Name for care unit

Schema for ListPatientsById2G: PatientWS.xsd

Schema documentation for ListPatientsById2G: PatientWS.html

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=ListPatientsById2G

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

HIS90 specific information:

Server used for the method is CWMEDI4 and service code 56471.

There are no access restrictions for users using this method.

1.1.13 ListPatientAdditionalInformations

Applicable systems for method:

HIS-90

Description:

The method gets a list of additional information on patients, by using the id internal pid.

The response is a list of entries registered on the patient.

Syntax:

ListPatientAdditionalInformationsResponse = ListPatientAdditionalInformations(ListPatientAdditionalInformationsRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
ListPatientAdditionalInformationsRequest		N/A Dynamic	ListPatientAdditionalInformationsRequest class according to schema PatientWS.xsd
Description:
PatientId	string		Internal patient id.
AdditionalInformationId	string	N/A Dynamic	Internal id of additional patient information. HIS90: Combined id: PatientId|InfoType|InfoCode|ToDate
TypeOfCode	struct		Type of code given in AdditionalInformationId.Code. Valid TypeOfCode can be found using CommonCodesWS.ListCommonCodes.
TypeOfCode.Code	string	N/A Dynamic	Code value. HIS90: PAQPEXI.INFO_TYPE
PatientId	string		Internal patient id.
AdditionalInformationId	string	N/A Dynamic	Internal id of additional patient information. HIS90: Combined id: PatientId|InfoType|InfoCode|ToDate
TypeOfCode	struct		Type of code given in AdditionalInformationId.Code. Valid TypeOfCode can be found using CommonCodesWS.ListCommonCodes.

Returned parameter	Type	Length Byte	Description – Comments
ListPatientAdditionalInformationsResponse		N/A Dynamic	ListPatientAdditionalInformationsResponse class according to schema PatientWS.xsd
Description:
PatientId	string	N/A Dynamic	Internal patient id.
AdditionalInformationId	string	N/A Dynamic	Internal id of additional patient information. If given other input parameters will be ignored. HIS90: Combined id: PatientId|InfoType|InfoCode|ToDate
TypeOfCode	struct		Type of code given in AdditionalInformationId.Code. Valid TypeOfCode can be found using CommonCodesWS.ListCommonCodes.
TypeOfCode.Code	string	N/A Dynamic	Code value. HIS90: PAQPEXI.INFO_TYPE
TypeOfCode.Text	string	N/A Dynamic	Type of code description.
TypeOfCode.TypeOfCode	string	N/A Dynamic	Type of code.
Code	struct		Code registered on patient.
Code.Code	string	N/A Dynamic	Code value. HIS90: PAQPEXI.INFO_CODE
Code.Text	string	N/A Dynamic	Code description. HIS90: PAQPEXI.INFO_TEXT
Code.TypeOfCode	string	N/A Dynamic	Type of code. HIS90: PAQPEXI.OID
ValidDatePeriod.FromDate	DateTime		Valid date from of listed codes.
ValidDatePeriod.ToDate	DateTime		Valid date to of listed codes.
AdditionalInfo	struct		Additional information on type and code.
AdditionalInfo.Code	string	N/A Dynamic	Code value.
AdditionalInfo.Text	string	N/A Dynamic	Code description. Further/additional description of the code.
AdditionalInfo.TypeOfCode	string	N/A Dynamic	Contains the type description. Valid values in this context (used with EHIC only): LSSN = Foreign/other social security number. LINSNO = Local/foreign insurance office number. LINSNAME = Local/foreign insurance office name.

Schema for ListPatientAdditionalInformations: PatientWS.xsd

Schema documentation for ListPatientAdditionalInformations: PatientWS.html

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=ListPatientAdditionalInformations

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

HIS90 specific information:

Server used for the method is CWMEDI3 and service code 55451.

There are no access restrictions for users using this method.

1.1.14 SavePatientAdditionalInformations

Applicable systems for method:

HIS-90

Description:

The method saves a list of additional information on patients, by using the internal pid.

The response is a list of entries registered on the patient.

Syntax:

SavePatientAdditionalInformationsResponse = SavePatientAdditionalInformations(SavePatientAdditionalInformationsRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
SavePatientAdditionalInformationsRequest		N/A Dynamic	SavePatientAdditionalInformationsRequest class according to schema PatientWS.xsd
Description:
PatientId	string		Internal patient id.
AdditionalInformationId	string	N/A Dynamic	Internal id of additional patient information. Only used for updated of exsiting record. Is returned from the List methods. HIS90: Combined id: PatientId|InfoType|InfoCode|ToDate
TypeOfCode	struct		Type of code given in AdditionalInformationId.Code. Valid TypeOfCode can be found using CommonCodesWS.ListCommonCodes.
TypeOfCode.Code	string	N/A Dynamic	Code value. HIS90: PAQPEXI.INFO_TYPE
TypeOfCode.Text	string	N/A Dynamic	Type of code description.
TypeOfCode.TypeOfCode	string	N/A Dynamic	Type of code.
Code	struct		Code registered on patient.
Code.Code	string	N/A Dynamic	Code value. HIS90: PAQPEXI.INFO_CODE
Code.Text	string	N/A Dynamic	Code description. HIS90: PAQPEXI.INFO_TEXT
Code.TypeOfCode	string	N/A Dynamic	Type of code. HIS90: PAQPEXI.OID
ValidDatePeriod.FromDate	DateTime		Valid date from of saved codes.
ValidDatePeriod.ToDate	DateTime		Valid date to of saved codes.
AdditionalInfo.Code	string	N/A Dynamic	Code value.
AdditionalInfo.Text	string	N/A Dynamic	Code description. Further/additional description of the code.
AdditionalInfo.TypeOfCode	string	N/A Dynamic	Contains the type description. Valid values in this context (used with EHIC only): LSSN = Foreign/other social security number. LINSNO = Local/foreign insurance office number. LINSNAME = Local/foreign insurance office name.

Returned parameter	Type	Length Byte	Description – Comments
SavePatientAdditionalInformationsResponse		N/A Dynamic	SavePatientAdditionalInformationsResponse class according to schema PatientWS.xsd
Description:
PatientId	string	N/A Dynamic	Internal patient id.
AdditionalInformationId	string	N/A Dynamic	Internal id of additional patient information. HIS90: Combined id: PatientId|InfoType|InfoCode|ToDate
TypeOfCode	struct		Type of code given in AdditionalInformationId.Code. Valid TypeOfCode can be found using CommonCodesWS.ListCommonCodes.
TypeOfCode.Code	string	N/A Dynamic	Code value. HIS90: PAQPEXI.INFO_TYPE
TypeOfCode.Text	string	N/A Dynamic	Type of code description.
TypeOfCode.TypeOfCode	string	N/A Dynamic	Type of code.
Code	struct		Code registered on patient.
Code.Code	string	N/A Dynamic	Code value. HIS90: PAQPEXI.INFO_CODE
Code.Text	string	N/A Dynamic	Code description. HIS90: PAQPEXI.INFO_TEXT
Code.TypeOfCode	string	N/A Dynamic	Type of code. HIS90: PAQPEXI.OID
ValidDatePeriod.FromDate	DateTime		Valid date from of codes listed.
ValidDatePeriod.ToDate	DateTime		Valid date to of codes listed.
AdditionalInfo	struct		Additional information on type and code.
AdditionalInfo.Code	string	N/A Dynamic	Code value.
AdditionalInfo.Text	string	N/A Dynamic	Code description. Further/additional description of the code.
AdditionalInfo.TypeOfCode	string	N/A Dynamic	Contains the type description. Valid values in this context (used with EHIC): LSSN = Foreign/other social security number. LINSNO = Local/foreign insurance office number. LINSNAME = Local/foreign insurance office name.

Schema for SavePatientAdditionalInformations: PatientWS.xsd

Schema documentation for SavePatientAdditionalInformations: PatientWS.html

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=SavePatientAdditionalInformations

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

HIS90 specific information:

Server used for the method is CWPA99 and service code 55455.

There are no access restrictions for users using this method.

1.1.15 ListPatientRelations

Applicable systems for method:

HIS-90

Description:

The method list relations for a given patient, by using the internal pid where from/to dates and filters ar optional parameters.

Syntax:

ListPatientRelationsResponse = ListPatientRelations(ListPatientRelationsRequest)

Parameter in	Type	Length byte	Description – Data format – Valid data
ListPatientRelationsRequest		N/A Dynamic	See ListPatientRelationsRequest class according to schema PatientWS.xsd
Description:
PatientId	string		Internal patient id. Use PatientId for listing relation to a patient or use PatientRelationId to get a specific relation.
RelationType.Code	string	N/A Dynamic	The type of relation with the patient. Use code set PatientRelationRole with CommonCodesWS.ListCommonCodes to get valid values. HIS90: PAQPARE.REL_VALUE
RelationType.Text	string	N/A Dynamic	Not used in the request
RelationType.TypeOfCode	string	N/A Dynamic	The code set used, if any. Valid code sets can be found in CommonCodesWS.ListCommonCodes HIS90: PAQPARE.INTERNAL_TYPE_OF_REL
ValidDatePeriod.From	DateTime	N/A	Valid date from for relation. If null/misssing deafult is valid from today/now.
ValidDatePeriod.To	DateTime	N/A	Valid date to for relation. If null/misssing deafult is valid until max date.(31.12.9999)
Filters	N/A	N/A	Filters to show active, future and/or all (including historical/deleted/outdated/future) items. If filter is excluded/NULL then only active items is shown. For most cases this will be enough.
Filters.AllRelations	Boolean	N/A	Filter to show all relations and properties, if TRUE then show historical (outdated) relations (Deleted not shown). Default if not set is FALSE. Only show valid relations as of today,
Filters. AllProperties	Booelan	N/A	Filter to also show all deleted properties, if TRUE then show properties (like adresses, telecom, codes like Custody, Language etc) that are also deleted relation properties. Default if not set is FALSE. Only show valid properties as of today.
PatientRelationId	string	N/A Dynamic	Internal id for patient Relation item If PatientRelationId is given then other input parameters is ignored as this gets the specific item. HIS90: NOT IMPLMENTETD YET FOR HI90 Combined id: PatientId|ISerialNoPare

Returned parameter		Type	Length Byte	Description – Comments
ListPatientRelationsResponse			N/A Dynamic	See ListPatientRelationsResponse class according to schema PatientWS.xsd
Description:
PatientRelations.PatientRelation			List	PatientRelations is al ist with relations and information about the relation (PatientRelation)
PatientId		string		Internal Patient id
PatientRelationId		string		Internal id for patient's relation. HIS90: Combined id. PatientId|SerailNoPare
RelationType.Code		string	N/A Dynamic	The type of relation with the patient. Use code set PatientRelationRole with CommonCodesWS.ListCommonCodes to get valid values, code set will give attributes in AddtionalCodes about if code is patient or requester context. HIS90: PAQPARE.REL_VALUE
RelationType.Text		string	N/A Dynamic	Description of relation type code HIS90: PAQGECO.DESC
RelationType.TypeOfCode		string	N/A Dynamic	The code set used, if any. Valid code sets can be found in CommonCodesWS.ListCommonCodes HIS90: PAQPARE.INTERNAL_TYPE_OF_REL
RelationId.Id		string	N/A Dynamic	The id for relation with the patient. This can for example be internal pids, official ids(fødselsnummer), requeste code No code set defined, see CodeSetId for valid type of ids HIS90: PAQPARE.ID_VALUE
RelationId.TypeOfId.CodesetId		string	N/A Dynamic	Code type iused in id above. Valid values are: FNR - Fødselsnummer/OfficialId where the official id(fødselsnummer) is valid in the PAS patietnt registry. LRC - Requester code where the requester code is valid in the PAS requester registry. Person - Fødselsnummer/OfficialId (as free text) Requester - Requester code (as free text) HIS90: PAQPARE.INTERNAL_TYPE_OF_ID
Name.FormattedName		string	N/A Dynamic	Name of the relation The person's names formatted in one string according to national or application's rules. HIS90: PAQPARE.PERSON_NAME
Name.LastName		string	N/A Dynamic	Patient last name HIS90: Derived from PAQPARE.PERSON_NAME
Name.MidleName		string	N/A Dynamic	Patient middel name HIS90: Derived from PAQPARE.PERSON_NAME
Name.FirstName		string	N/A Dynamic	Patient first name HIS90: Derived from PAQPARE.PERSON_NAME
Name.GivenName		string	N/A Dynamic	Patient given/maiden name HIS90: N/A not used
Addresses		N/A	N/A Dynamic	Addresses are a list for zero ti multiple address, where address ttpe is used to differe the addresses
Addresses.AddressLines		N/A	N/A Dynamic	Patient's street, postbox addresses, GPS coordinates etc..
Addresses.AddressLines.AddressLine.TypeOfText		string	N/A Dynamic	TypeOfText is coding the type of adress, Use CommonCodesWS.ListCommonCodes with CommonCodeType=AddressLineTypes to list valid values for AddressType.
Addresses.AddressLines.AddressLine.Text		string	N/A Dynamic	Address, e.g. streetname and number, house number, postboks etc.
Addresses.AddressLines.AddressLine.Sequence		string	N/A Dynamic	Sequence of address if several of same type, if sequence is important to sort correctly
Addresses.PostalAddress.Code		string	N/A Dynamic	Relations postal code Use CommonCodesWS.ListCommonCodes with CommonCodeType= PostCode to list valid values for post codes.
Addresses.PostalAddress.Name		string	N/A Dynamic	Realtions postal office/city
Addresses.Country.Code		string	N/A Dynamic	Relations country code Use CommonCodesWS.ListCommonCodes with CommonCodeType= NationalityCode to list valid values for post codes.
Addresses.Country.Name		string	N/A Dynamic	Country name
Addresses.AddressType		string	N/A Dynamic	Adresse type Use CommonCodesWS.ListCommonCodes with CommonCodeType=AddressPostalTypes to list valid values for AddressType.
Addresses.ValidDatePeriod.From		string	N/A Dynamic	The period the address is valid from
Addresses.ValidDatePeriod.To		string	N/A Dynamic	The period the address is valid to
Addresses.Id		string	N/A Dynamic	Internal id for the address. Is set and parsed by WS only. Is required for updating an existing item/address
Addresses.Status		string	N/A Dynamic	The status for the item/address If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
SendNotification		string	N/A Dynamic	Sending notfication to the relation. E.g. about appointment If not set or null then no notification is sent. Valid values are: - SMS - Letter (not used yet) - Email (not used yet) Read only in List method (not used in Save method), derived from Telecom.Telephones.Reservation where TypeOfText=MC (mobile)
Telecom.Telephones.TypeOfText		string	N/A Dynamic	Type of telephone number Use CommonCodesWS.ListCommonCodes with CommonCodeType=AddressTelephoneTypes to list valid values for TypeOfText.
Telecom.Telephones.Text		string	N/A Dynamic	Telephone number
Telecom.Telephones.Reservation		string	N/A Dynamic	Set to true if the patients has reservations about using his telephone number/email address
Telecom.Telephones.Id		string	N/A Dynamic	Internal id for the telephone. Is set and parsed by WS only. Is required for updating an existing item/telephone
Telecom.Telephones.Status		string	N/A Dynamic	The status for the item/telephone If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Telecom.Telephones.Extension		string	N/A Dynamic	Extension on phone number if applicable
Telecom.Emails.TypeOfText		string	N/A Dynamic	Type of email address Use CommonCodesWS.ListCommonCodes with CommonCodeType=AddressEmailTypes to list valid values for TypeOfText.
Telecom.Emails.Text		string	N/A Dynamic	Email address
Telecom.Emails.Reservation		string	N/A Dynamic	Set to true if the patients has reservations about using his telephone number/email address
Telecom.Emails.Id		string	N/A Dynamic	Internal id for the email address. Is set and parsed by WS only. Is required for updating an existing item/email
Telecom.Emails.Status		string	N/A Dynamic	The status for the item/email address If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Language.Code		string	N/A Dynamic	Code for the Relations main language Ref code set in TypeOfCode below
Language.Text		string	N/A Dynamic	Description/text of the language code above
Language.TypeOfCode		string	N/A Dynamic	Type of language code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=LanguageCode to list valid codes/values. Ref Volven 3303 HIS90 PAS: table PAQLANG
Language.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Language.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
Language.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
Language.Id		string	N/A Dynamic	Internal id for the item. Is set and parsed by WS only. Is required for updating an existing item
NeedsTranslator.Code		string	N/A Dynamic	Code for If the relation needs translator Ref code set in TypeOfCode below
NeedsTranslator.Text		string	N/A Dynamic	Description/text of the translator code above
NeedsTranslator.TypeOfCode		string	N/A Dynamic	Type of needs translator code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=PatientTranslatorNeed to list valid codes/values. Ref Volven 8418
NeedsTranslator.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
NeedsTranslator.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
NeedsTranslator.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
NeedsTranslator.Id		string	N/A Dynamic	Internal id for the item. Is set and parsed by WS only. Is required for updating an existing item
PatientConsentForContact.Code		string	N/A Dynamic	Code for the patient have given consent for contacting the relation Ref code set in TypeOfCode below
PatientConsentForContact.Text		string	N/A Dynamic	Description/text of the consent code above
PatientConsentForContact.TypeOfCode		string	N/A Dynamic	Type of consent code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=AdmYesNoUnknown to list valid codes/values. Ref Volven 1103
PatientConsentForContact.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
PatientConsentForContact.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
PatientConsentForContact.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
EthnicGroupAffiliation.Code		string	N/A Dynamic	Code for the relations ethnic group (Etnisk tilhørighet) Ref code set in TypeOfCode below
EthnicGroupAffiliation.Text		string	N/A Dynamic	Description/text of the relations ethnic group code above
EthnicGroupAffiliation.TypeOfCode		string	N/A Dynamic	Type of relations ethnic group code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=PatientEthnicAffiliation to list valid codes/values. Ref Volven 8423
EthnicGroupAffiliation.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
EthnicGroupAffiliation.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
EthnicGroupAffiliation.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
Custody.Code		string	N/A Dynamic	Code for if relation have custody of the patient Ref code set in TypeOfCode below
Custody.Text		string	N/A Dynamic	Description/text of the custody code above
Custody.TypeOfCode		string	N/A Dynamic	Type of relations custody code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=AdmYesNo to list valid codes/values. Ref Volven 1101
Custody.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Custody.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
Custody.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
CaregiverRelation.Code		string	N/A Dynamic	Code for the relation's caregviver role/relation for the patient. Ref code set in TypeOfCode below
CaregiverRelation.Text		string	N/A Dynamic	Description/text of the caregviver role/relation code above
CaregiverRelation.TypeOfCode		string	N/A Dynamic	Type of relations caregviver role/relation code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= PatientCaregiverRelations to list valid codes/values. Ref Volven 8422
CaregiverRelation.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
CaregiverRelation.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
CaregiverRelation.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
Consentability.Code		string	N/A Dynamic	Code for the consent ability of the relation. Ref code set in TypeOfCode below
Consentability.Text		string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Consentability.TypeOfCode		string	N/A Dynamic	Type of consent ability code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= AdmYesNo to list valid codes/values.
Consentability.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Consentability.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
Consentability.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
ValidDatePeriod.From		string	N/A Dynamic	The relation is valid from
ValidDatePeriod.To		string	N/A Dynamic	The relation is valid to
Status		string	N/A Dynamic	The status for the relation If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Registration.Date	DateTime				(Information on first registration of this decision instance.) Date and time of first registration.
Registration.Name	String				Name of person responsible for registration of the row. HIS90: N/A
Registration.Organization.Id	String				Code of organization that first registered this contact.
Registration.Organization.TypeOfId	String				Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: Set to “LAV” by web service.
Registration.Organization.ShortNameId	String				Short name/code of organization. HIS90: Department code.
Registration.Organization.Name	String				Name of organization. HIS90: Department name.
Registration.SignedBy	String				Initials of person who originally created this contact.
Update.Date	String				(Information on updated/current decision instance.) Date and time of updating.
Update.Organization.Id	String				Code of organization updating contact instance.
Update.Organization.TypeOfId	String				Type of organization id. Valid values: Empty/LOC = Unknown/local id in PAS LIN = Local institution id LAV = Local medical unit/department id LEN = Local care unit id LUI = Local unique id HER = HER id HIS90: Set to “LAV” by web service.
Update.Organization.ShortNameId	String				Short name/code of organization. HIS90: Department code.
Update.Organization.Name	String				Name of organization. HIS90: Department name.
Update.SignedBy	String				Initials of person updating contact instance.
Update.UpdateCount	Integer				Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact. Set to blank/0 if new contact.

Request and response object definitions and documentation for the web service method:

Schema for ListPatientRelations: PatientWS2G.xsd

Schema documentation for ListPatientRelations: PatientWS2G.html

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=ListPatientRelations

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

HIS90 specific information:

Server used for the method is CWPI01 and services PWS1140 and 1142.

There are no access restrictions for users using this method.

1.1.16 SavePatientRelations

Applicable systems for method:

HIS-90

Description:

The method list relations for a given patient, by using the internal pid where from/to dates and filters ar optional parameters.

Syntax:

SavePatientRelationsResponse = SavePatientRelations(SavePatientRelationsRequest)

Parameter in		Type	Length byte	Description – Data format – Valid data
SavePatientRelationsRequest			N/A Dynamic	See SavePatientRelationsRequest class according to schema PatientWS.xsd
Description:
PatientRelations.PatientRelation			List	PatientRelations is al ist with relations and information about the relation (PatientRelation)
PatientId		string		Internal Patient id
PatientRelationId		string		Internal id for patient's relation. HIS90: Combined id. PatientId|SerailNoPare
RelationType.Code		string	N/A Dynamic	The type of relation with the patient. Use code set PatientRelationRole with CommonCodesWS.ListCommonCodes to get valid values, code set will give attributes in AddtionalCodes about if code is patient or requester context. HIS90: PAQPARE.REL_VALUE
RelationType.Text		string	N/A Dynamic	Description of relation type code HIS90: PAQGECO.DESC
RelationType.TypeOfCode		string	N/A Dynamic	The code set used, if any. Valid code sets can be found in CommonCodesWS.ListCommonCodes HIS90: PAQPARE.INTERNAL_TYPE_OF_REL
RelationId.Id		string	N/A Dynamic	The id for relation with the patient. This can for example be internal pids, official ids(fødselsnummer), requeste code No code set defined, see CodeSetId for valid type of ids HIS90: PAQPARE.ID_VALUE
RelationId.TypeOfId.CodesetId		string	N/A Dynamic	Code type iused in id above. Valid values are: FNR - Fødselsnummer/OfficialId where the official id(fødselsnummer) is valid in the PAS patietnt registry. LRC - Requester code where the requester code is valid in the PAS requester registry. Person - Fødselsnummer/OfficialId (as free text) Requester - Requester code (as free text) HIS90: PAQPARE.INTERNAL_TYPE_OF_ID
Name.FormattedName		string	N/A Dynamic	Name of the relation The person's names formatted in one string according to national or application's rules. HIS90: PAQPARE.PERSON_NAME
Name.LastName		string	N/A Dynamic	Patient last name HIS90: Derived from PAQPARE.PERSON_NAME
Name.MidleName		string	N/A Dynamic	Patient middel name HIS90: Derived from PAQPARE.PERSON_NAME
Name.FirstName		string	N/A Dynamic	Patient first name HIS90: Derived from PAQPARE.PERSON_NAME
Name.GivenName		string	N/A Dynamic	Patient given/maiden name HIS90: N/A not used
Addresses		N/A	N/A Dynamic	Addresses are a list for zero to multiple address, where address type is used to differe the addresses
Addresses.AddressLines		N/A	N/A Dynamic	Patient's street, postbox addresses, GPS coordinates etc..
Addresses.AddressLines.AddressLine.TypeOfText		string	N/A Dynamic	TypeOfText is coding the type of adress, Use CommonCodesWS.ListCommonCodes with CommonCodeType=AddressLineTypes to list valid values for AddressType.
Addresses.AddressLines.AddressLine.Text		string	N/A Dynamic	Address, e.g. streetname and number, house number, postboks etc.
Addresses.AddressLines.AddressLine.Sequence		string	N/A Dynamic	Sequence of address if several of same type, if sequence is important to sort correctly
Addresses.PostalAddress.Code		string	N/A Dynamic	Relations postal code Use CommonCodesWS.ListCommonCodes with CommonCodeType= PostCode to list valid values for post codes.
Addresses.PostalAddress.Name		string	N/A Dynamic	Realtions postal office/city
Addresses.Country.Code		string	N/A Dynamic	Relations country code Use CommonCodesWS.ListCommonCodes with CommonCodeType= NationalityCode to list valid values for post codes.
Addresses.Country.Name		string	N/A Dynamic	Country name
Addresses.AddressType		string	N/A Dynamic	Adresse type Use CommonCodesWS.ListCommonCodes with CommonCodeType=AddressPostalTypes to list valid values for AddressType.
Addresses.ValidDatePeriod.From		string	N/A Dynamic	The period the address is valid from
Addresses.ValidDatePeriod.To		string	N/A Dynamic	The period the address is valid to
Addresses.Id		string	N/A Dynamic	Internal id for the address. Is set and parsed by WS only. Is required for updating an existing item/address
Addresses.Status		string	N/A Dynamic	The status for the item/address If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
SendNotification		string	N/A Dynamic	N/A not used in the save method
Telecom.Telephones.TypeOfText		string	N/A Dynamic	Type of telephone number Use CommonCodesWS.ListCommonCodes with CommonCodeType=AddressTelephoneTypes to list valid values for TypeOfText.
Telecom.Telephones.Text		string	N/A Dynamic	Telephone number
Telecom.Telephones.Reservation		string	N/A Dynamic	Set to true if the patients has reservations about using his telephone number/email address
Telecom.Telephones.Id		string	N/A Dynamic	Internal id for the telephone. Is set and parsed by WS only. Is required for updating an existing item/telephone
Telecom.Telephones.Status		string	N/A Dynamic	The status for the item/telephone If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Telecom.Telephones.Extension		string	N/A Dynamic	Extension on phone number if applicable
Telecom.Emails.TypeOfText		string	N/A Dynamic	Type of email address Use CommonCodesWS.ListCommonCodes with CommonCodeType=AddressEmailTypes to list valid values for TypeOfText.
Telecom.Emails.Text		string	N/A Dynamic	Email address
Telecom.Emails.Reservation		string	N/A Dynamic	Set to true if the patients has reservations about using his telephone number/email address
Telecom.Emails.Id		string	N/A Dynamic	Internal id for the email address. Is set and parsed by WS only. Is required for updating an existing item/email
Telecom.Emails.Status		string	N/A Dynamic	The status for the item/email address If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Language.Code		string	N/A Dynamic	Code for the Relations main language Ref code set in TypeOfCode below
Language.Text		string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Language.TypeOfCode		string	N/A Dynamic	Type of language code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=LanguageCode to list valid codes/values. Ref Volven 3303 HIS90 PAS: table PAQLANG
Language.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Language.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
Language.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
Language.Id		string	N/A Dynamic	Internal id for the item. Is set and parsed by WS only. Is required for updating an existing item
NeedsTranslator.Code		string	N/A Dynamic	Code for If the relation needs translator Ref code set in TypeOfCode below
NeedsTranslator.Text		string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
NeedsTranslator.TypeOfCode		string	N/A Dynamic	Type of needs translator code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=PatientTranslatorNeed to list valid codes/values. Ref Volven 8418
NeedsTranslator.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
NeedsTranslator.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
NeedsTranslator.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
NeedsTranslator.Id		string	N/A Dynamic	Internal id for the item. Is set and parsed by WS only. Is required for updating an existing item
PatientConsentForContact.Code		string	N/A Dynamic	Code for the patient have given consent for contacting the relation Ref code set in TypeOfCode below
PatientConsentForContact.Text		string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
PatientConsentForContact.TypeOfCode		string	N/A Dynamic	Type of consent code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=AdmYesNoUnknown to list valid codes/values. Ref Volven 1103
PatientConsentForContact.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
PatientConsentForContact.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
PatientConsentForContact.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
EthnicGroupAffiliation.Code		string	N/A Dynamic	Code for the relations ethnic group (Etnisk tilhørighet) Ref code set in TypeOfCode below
EthnicGroupAffiliation.Text		string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
EthnicGroupAffiliation.TypeOfCode		string	N/A Dynamic	Type of relations ethnic group code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=PatientEthnicAffiliation to list valid codes/values. Ref Volven 8423
EthnicGroupAffiliation.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
EthnicGroupAffiliation.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
EthnicGroupAffiliation.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
Custody.Code		string	N/A Dynamic	Code for if relation have custody of the patient Ref code set in TypeOfCode below
Custody.Text		string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Custody.TypeOfCode		string	N/A Dynamic	Type of relations custody code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType=AdmYesNo to list valid codes/values. Ref Volven 1101
Custody.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Custody.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
Custody.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
CaregiverRelation.Code		string	N/A Dynamic	Code for the relation's caregviver role/relation for the patient. Ref code set in TypeOfCode below
CaregiverRelation.Text		string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
CaregiverRelation.TypeOfCode		string	N/A Dynamic	Type of relations caregviver role/relation code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= PatientCaregiverRelations to list valid codes/values. Ref Volven 8422
CaregiverRelation.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
CaregiverRelation.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
CaregiverRelation.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
Consentability.Code		string	N/A Dynamic	Code for the consent ability of the relation. Ref code set in TypeOfCode below
Consentability.Text		string	N/A Dynamic	Only set if the code above is not from a code set(TypeOfCode), else if code set is used the text is taken from the code set internally in WS
Consentability.TypeOfCode		string	N/A Dynamic	Type of consent ability code Use CommonCodesWS.ListCommonCodes with code set CommonCodeType= AdmYesNo to list valid codes/values.
Consentability.Status		string	N/A Dynamic	The status for the item If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Consentability.ValidDatePeriod.From		string	N/A Dynamic	The period the item is valid from
Consentability.ValidDatePeriod.To		string	N/A Dynamic	The period the item is valid to
ValidDatePeriod.From		string	N/A Dynamic	The relation is valid from
ValidDatePeriod.To		string	N/A Dynamic	The relation is valid to
Status		string	N/A Dynamic	The status for the relation If blank or null then item is active. Enumerator with valid values: NotSet – Not set status, treat as active item Active – Active itme Deleted – Deleted item OutOfDate – Old/historical item
Registration.Date	DateTime				N/A in the save method
Registration.Name	String				N/A in the save method
Registration.Organization.Id	String				N/A in the save method
Registration.Organization.TypeOfId	String				N/A in the save method
Registration.Organization.ShortNameId	String				N/A in the save method
Registration.Organization.Name	String				N/A in the save method
Registration.SignedBy	String				N/A in the save method
Update.Date	String				N/A in the save method
Update.Organization.Id	String				N/A in the save method
Update.Organization.TypeOfId	String				N/A in the save method
Update.Organization.ShortNameId	String				N/A in the save method
Update.Organization.Name	String				N/A in the save method
Update.SignedBy	String				N/A in the save method
Update.UpdateCount	Integer				Count used for concurrency testing when contact is updated. Required only if ContactId is set, i.e. updating existing contact. Set to blank/0 if new contact.

Returned parameter	Type	Length Byte	Description – Comments
SavePatientRelationsResponse		N/A Dynamic	See SavePatientRelationsResponse class according to schema PatientWS.xsd
Description:
See ListPatientRelations for detailed informations about the response as same response is used.

Request and response object definitions and documentation for the web service method:

Schema for SavePatientRelations: PatientWS2G.xsd

Schema documentation for SavePatientRelations: PatientWS2G.html

Web Service Response and Request:

See https://linkws.service.tieto.com/PasLinkWS/PatientWS/PatientWS.asmx?op=SavePatientRelations

Related methods or functions used:

GetUserLogin Used to verify a 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 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.

HIS90 specific information:

Server used for the method is CWPI01 and services PWS1141 and 1143.

There are no access restrictions for users using this method.

---

[1] Status NY for Type OF Care = I is not implemented for HIS90 yet. Sending in Status NY gives error wrong status type.

Status AL for Type of Care = I is only implemented for HIS90. This status will list all patients which have received treatement in the specified period.