Avbokning, avboka tid

Ingång till flödet för avbokning startar i Avboka eller omboka / Mina bokade tider.

Avboka - Villkorssida, avboka tid

getBookingDetails

Namn	Typ	Kommentar
Begäran
healthcare_facility	HsaIdType	HSA-id för mottagning/vårdenhet
bookingId	BookingIdType	Intern bokningsidentitet.
Svar
TimeSlotDetail	TimeslotType	Information om den aktuella tiden

TimeSlotDetail [1..1]
- startTimeInclusive [0..1]
- endTimeExclusive[0..1]
- healthcare_facility [1..1]
- performer[0..1]
- bookingId[0..1]
- subject_of_care[1..1]
- purpose[0..1]
- reason[0..1]
- resourceName[0..1]
- healthcare_facility_name[0..1]
- performerName[0..1]
- resourceID[0..1]
- timeTypeName[0..1]
- timeTypeID[0..1]
- careTypeName[0..1]
- careTypeID[0..1]
- cancel_booking_allowed[1..1]
- rebooking_allowed[1..1]
- message_allowed[1..1]
- isInvitation [0..1]

Den valda bokningen hämtas med getBookingDetails för att kunna visa upp tillgänglig information i den gula sammanfattningsrutan. Först visas:

startTimeInclusive
endTimeInclusice

endTimeInclusive visas beroende av inställningar på mottagningsnivå i Mina Vårdkontakter

Efter den bokade tiden i rubriken visas (om detta finns, enligt priolista):

performerName
resourceName
careTypeName
finns ingen av dessa visas det ingen text

Mottagning:

healthcareFacilityName

Typ av tid:

timeTypeName

Anledning till besöket:

reason
[visa mer], visar hela meddelandet (länken visas bara ifall meddelandet är mer än 90 tecken)
[dölj text], visar bara 90 tecken

Övrigt:

purpose (kan vara DocBook eller vanlig text)
[visa mer], visar hela meddelandet (länken visas bara ifall meddelandet är mer än 90 tecken)
[dölj text], visar bara 90 tecken

Villkorstext

Villkorstext tillhörande vald mottagning. Koppling mellan mottagning och specifika villkorstexter ställs in i Mina Vårdkontakter.

Avboka - Avbokningssida, avboka tid

getBookingDetails

Namn	Typ	Kommentar
Begäran
healthcare_facility	HsaIdType	HSA-id för mottagning/vårdenhet
bookingId	BookingIdType	Intern bokningsidentitet.
Svar
TimeSlotDetail	TimeslotType	Information om den aktuella tiden

TimeSlotDetail [1..1]
- startTimeInclusive [0..1]
- endTimeExclusive[0..1]
- healthcare_facility [1..1]
- performer[0..1]
- bookingId[0..1]
- subject_of_care[1..1]
- purpose[0..1]
- reason[0..1]
- resourceName[0..1]
- healthcare_facility_name[0..1]
- performerName[0..1]
- resourceID[0..1]
- timeTypeName[0..1]
- timeTypeID[0..1]
- careTypeName[0..1]
- careTypeID[0..1]
- cancel_booking_allowed[1..1]
- rebooking_allowed[1..1]
- message_allowed[1..1]
- isInvitation [0..1]

Den valda bokningen hämtas med getBookingDetails för att kunna visa upp tillgänglig information i den gula sammanfattningsrutan. Först visas:

startTimeInclusive
endTimeInclusice

endTimeInclusive visas beroende av inställningar på mottagningsnivå i Mina Vårdkontakter

Efter den bokade tiden i rubriken visas (om detta finns, enligt priolista):

performerName
resourceName
careTypeName
finns ingen av dessa visas det ingen text

Mottagning:

healthcareFacilityName
finns inte denna parameter visas ingen text

Typ av tid:

timeTypeName

Anledning till besöket:

reason
[visa mer], visar hela meddelandet (länken visas bara ifall meddelandet är mer än 90 tecken)
[dölj text], visar bara 90 tecken
finns inte denna parameter visas ingen text

Information:

Om resultCode är "INFO" visas resultText
Om resultCode är "OK" visas ingen text

Övrigt:

purpose (kan vara DocBook eller vanlig text)
[visa mer], visar hela meddelandet (länken visas bara ifall meddelandet är mer än 90 tecken)
[dölj text], visar bara 90 tecken
finns inte denna parameter visas ingen text

Anledning till avbokning

I svaret från anropet med getBookingDetails inkluderas parametern "messageAllowed" som styr om kommentarsfältet visas eller ej. Om messageAllowed är "true" är det obligatoriskt att skriva in en kommentar, finns inget ifyllt i fältet visas ej "Ja, avboka tiden"-knappen. Om messageAllowed är "false" visas ingen kommentarsruta och "Ja, avboka tiden"-knappen är synlig.

Ja, avboka tiden (cancelBooking)

Namn	Typ	Kommentar
Begäran
healthcare_facility	HsaIdType	HSA-id för mottagning/vårdenhet
bookingId	BookingIdType	Intern bokningsidentitet
message	string	Patientens beskrivning av orsak för avbokning. Fältet kan bara skickas om värdet på message_allowed är ”true” i svaret från GetBookingDetails.
Svar
resultCode	ResultCodeEnum	Status för den gjorda avbokningen. Returkoder enligt beskrivning i kapitel 5.7
resultText	string	Ev. meddelande kopplat till resultatkoden.

Avbokning - Fel vid avbokning

Om avbokningen misslyckades efter att man klickat på knappen "Ja, avboka tiden" visas en felsida när resultCode är "ERROR". Texten "Tiden är inte avbokad. Var vänlig försök igen!" visas alltid på sidan.

resultCode = "ERROR" och ingen resultText returneras:

resultCode = "ERROR" och resultText returneras:

resultText visas i sidan, i exemplet nedan som "ResultText är detta, bokningssystemet uppdateras och ligger nere under blabla ...".

Avboka - Bekräftelsesida, avboka tid

Denna sida visar endast upp en bekräftelse på att tiden är avbokad och således görs inga anrop.