GetMiuForPersonValve
Note
Valve for performing a person lookup against the HSAWS (v2) web service method GetMiuForPerson, to get the commissions (Medarbetaruppdrag) for the user. It is also possible to use the valve to get a specific commission (based on the hsaID of the commissions).
This valve works on a request parameter, an item property or a session property containing the user's HSA identity OR personal number. After execution, an item for each commission is created in the flow. Each item representing a commission contains item properties reflecting the commission property.
The valve can also be used used to fetch a specific commission (using the user hsa ID or personal number in combination with the commission hsa ID).
This valve can perform lookups against the national Inera HSA WS or be used against a local (regional) HSA ws.
Properties
Name | Description | Default value | Mandatory | Supports property expansion. |
---|---|---|---|---|
keystore_path | File path to client certificate p12 file. Ignored if keystore_id is used. | No | No | |
keystore_password | Keystore (p12) password. Ignored if keystore_id is used. | No | No | |
keystore_id | ID of keystore object in configuration. | No | No | |
endpointURL | HSA WS endpoint URL. Example: https://min.region.se/svr-hsaws2/hsaws | Yes | No | |
protocol | SSL/TLS version. | SSLv3 Since 5.0.1: System default |
No | No |
hsaIdentity | HSA identity value. Must not be used in combination with the personalNumber property. | No | Yes | |
personalNumber | Personal number. Must not be used in combination with the hsaIdentity property. | No | Yes | |
logicalAddress | Logical address header to be set in payload. (Usually SE165565594230-1000) | Yes | No | |
searchBase | Search base to be set in payload. If unknown, use c=SE. | Yes | No | |
selected_hsa_id_param | The HSA id of a specific commission. Used to retrieve a specific commission. | No | Yes | |
connectTimeoutMilliseconds | The connect timeout for establishing the connection with the remote server | 60000 | No | No |
requestTimeoutMilliseconds | The timeout for the entire request | 60000 | No | No |
Example Configuration
Get all commissions for user
{
"name": "GetMiuForPersonValve",
"config": {
"keystore_id": "xxxx-yyyy-zzzz-wwww",
"endpointURL" : "https://min.region.se/svr-hsaws2/hsaws",
"hsaIdentity" : "{{session.user_id}}",
"logicalAddress" : "SE165565594230-1000",
"searchBase" : "c=SE"
}
}
Get specific commission for user
{
"name": "GetMiuForPersonValve",
"config": {
"keystore_id": "xxxx-yyyy-zzzz-wwww",
"endpointURL" : "https://min.region.se/svr-hsaws2/hsaws",
"hsaIdentity" : "{{session.user_id}}",
"selected_hsa_id" : "{{session.hsaIdMiu}}",
"logicalAddress" : "SE165565594230-1000",
"searchBase" : "c=SE"
}
}
Requirements
- This information must be obtained from the HSAWS admin:
- Client certificate in p12 format to contact the web service, with permissions to call the GetMiuForPerson method.
- HSAWS endpoint
- Add trust to HSAWS endpoint SSL certificates (if non-global CAs are used) by adding the CA certificate(s) to cacerts.
Item enrichment
After a successful lookup, these item properties will be populated with values in the response. (One item for each commission will be created) :
Item property name | GetMiuForPersonResponse->MiuInformation parameter name |
---|---|
id (item id) | hsaIdentity |
MiuPurpose |
miuPurpose |
careGiver | careGiver |
CareGiverName |
careGiverName |
CareGiverOrgNo |
careGiverOrgNo |
CareUnitHsaIdentity |
careUnitHsaIdentity |
CareUnitName |
careUnitName |
GivenName |
givenName |
HsaIdentity |
middleName |
HsaIdentityPerson |
mobiles |
MiddleAndSurName |
middleAndSurName |
MiuName |
miuName |
PersonalPrescriptionCode |
personalPrescriptionCode |
HsaSystemRoles |
hsaSystemRoles |
HsaTitles |
hsaTitles |
MiuRights |
miuRights |
PaTitleCodes |
paTitleCodes |