Jämförda versioner

Nyckel

  • Dessa rader lades till.
  • Denna rad togs bort.
  • Formateringen ändrades.

...

Prototyp

Tjänstekontrakt GetAllHealthcareFacilitites

Kommentar

 

Begäran

 

healthcare_facility

HSA-id för mottagning/vårdenhet

subject_of_care

Personnummer för den invånare som bokningen avser. Format enligt yyyymmddxxxx.

Kan användas för att filtrera vad en tjänsteproducent ska returnera för en viss patient (även vid nybokning).

bookingId

Internt bokningsid.

Används ej vid nybokning.

Vid öppen kallelse används bokningsid för att läsa upp den fiktiva bokningen.

Detta bokningsid behövs för att tjänsteproducenten ska kunna filtrera på egenskaper för en grundbokning.

 

Image RemovedImage Added

Svar

 

healthcareFacilityInfos 0..*

Lista med tillgängliga mottagningar/vårdenheter

Om mottagningen returnerar sig själv i GetAllHealthcareFacilities väljs den automatiskt.

Om mottagningen inte returnerar sig själv i GetAllHealthcareFacilities väljs inget i listan utan valet “Välj vårdenhet” visas.

healthcareFacility 1..1

Mottagningens hsa-id. Visas ej i gränssnittet.

healthcareFacility name healthcareFacilityName 0..1

Mottagningens namn. Visas i gränssnittet.

Ignoreras och hämtas istället från HSA, baserat på hsa-id.

...

Gränssnitt

Tjänstekontrakt

GetAvailableTimeslots

Kommentar

 

Begäran

 

healthcare_facility

HSA-id för mottagningen/vårdenheten.

bookingId 0..1

Internt bokningsid.

startDateInclusive 1..1

Datum för de lediga tider som skall sökas ut.

Format: ÅÅÅÅMMDD

Info

Är samma datum som endDateInclusive. Ett datum-spann sätts i tjänstekontraktet GetAvailableDates, medan det här är 1 datum i förfrågan för att få svar på lediga tider för ett specifikt datum.

endDateInclusive 1..1

Datum för de lediga tider som skall sökas ut.

Format: ÅÅÅÅMMDD

Info

Är samma datum som startDateInclusive. Ett datum-spann sätts i tjänstekontraktet GetAvailableDates, medan det här är 1 datum i förfrågan för att få svar på lediga tider för ett specifikt datum.

performer

HSA-id för vårdpersonal.

Info

Kommer endast ha ett värde om vårdpersonallistan finns och om invånaren har valt en personal.

timeTypeName

Namn för tidstypen / vad bokningen avser.

timeTypeID

Id för tidstypen.

careTypeName

Används ej

careTypeID

Används ej

subject_of_care

Invånarens personnummer enligt yyyymmddxxxx.

 

Svar

 

TimeSlotDetail

Lista med tillgängliga tider.

startTimeInclusive

Startdatum och klockslag för ledig tid.

endTimeInclusive

Slutdatum och klockslag för ledig tid.

I gränssnittet visas eventuellt slutdatum och -tid.

Info

Om sluttid ska visas i gränssnittet eller inte väljer verksamheterna själva. Att visa sluttid beställs från e-tjänsternas tekniska support vid anslutning. Per default visas inte sluttid.

Info

Sluttid anges eller anges inte för alla tider på mottagningen, kan ej vara olika.

healthcareFacility

HSA-id för mottagningen/vårdenheten.

Ska matcha begäran.

Visas ej.

healthcareFacilityName

Namn på bokad mottagning/vårdenhet.

Visas ej igen. Visas i Steg 1.

performer

Vårdpersonalens HSA-id.

Visas ej.

performer nameperformerName

Vårdpersonalens namn. Visas bredvid klockslaget.

Ska innehålla en blank-tecken-separerad sammanslagning av yrkestitel, förnamn, mellannamn, efternamn.

Om performerName eller resourceName finns visas en av dessa efter tiden (enligt den prioriteten).

bookingId

Bokningsid för ledig tid/tidslucka.

Visas ej,

purpose

Information från verksamhetenvården.

  • “Information från vården” visas alltid som rubrik i gränssnittet om information skickas i fältet.

  • Om text skickas enligt DocBook-format kan en eller flera underrubriker definieras av verksamheten och visas i detta fält. Här finns en sida som visar på skillnader i e-tjänsternas stöd för DocBook i inkorgen och i tidboken: DocBook - skillnad i stödet för 1177 Inkorg och Tidbokning

Fältet visas i steg 5 - Bekräfta bokningen.

Observera

Observera att länkar bör undvikas i GetAvailableTimeslots/timeslot/purpose då invånaren riskerar att tappa bokningen om hen hoppar ut till annat.

reason

Anledning till bokningen.

Kontaktorsak som invånare uppger vid bokning.

Kan visas i gränssnittets steg 4 “Anledning till bokningen” om “message_allowed”=true som ett textfält som invånaren ska fylla i. I steg 5 visas vad som har fyllts i.

Obligatoriskt för invånaren att fylla i om det visas.

Info

Max tecken: 255 st

Info

Giltiga tecken:

  • alfabetet

  • siffrorna 0-9

  • följande tecken: ! % # / ( ) = ? + * _ : ; { } [ ] @ . , \ -

Observera

Observera att message_allowed står beskrivet i tjänstekontraktsbeskrivningen att det ska användas för fälten om- och avbokningsanledning men för GetAvailableTimeslots använder 1177 detta fält till att visa eller dölja bokningsanledning.

resourceName

Namn på resurs.

Ev. resurs visas i listan med lediga tider.

Om performerName eller resourceName finns visas en av dessa efter tiden (enligt den prioriteten).

resourceId

Id för resurs.

Visas ej.

timeTypeName

Namn för vald tidstyp. Ska matcha begäran, men visas inte upp igen (syns i Steg 2 i bokningen)

Info

Max tecken: 100

timeTypeId

Id för tidstyp. Ska matcha begäran. Visas ej.

careTypeName

används ej

careTypeId

används ej

cancelBookingAllowed

Anger om bokningen kan avbokas.

Visas ej vid nybokning.

rebookingAllowed

Anger om bokningen kan ombokas.

Visas ej vid nybokning.

messageAllowed

Anger om orsak till nybokning kan skickas med i berörda tjänster. Orsak kan inte skickas om värdet saknas eller om värdet är false.

Om true, ska fältet reason visas i steg 4 (se nedan).

Observera

Observera att message_allowed står beskrivet i tjänstekontraktsbeskrivningen att det ska användas för fälten om- och avbokningsanledning men för GetAvailableTimeslots använder 1177 detta fält till att visa eller dölja bokningsanledning.

...

  • anledning till bokningen - är obligatoriskt att fylla i om det visas. Om fältet ska visas beror på om verksamheten har angett message_allowed=true i GetAvailableTimeslots

  • telefonnummer - hämtas från inställningarna i 1177 om det finns och visas för invånaren. Kan editeras, men eventuell editering sparas inte i invånarens inställningar i 1177.

...

Steg 5 - bekräfta

...

MakeBooking

...

bokningen

Steg 5 - Bekräfta bokningen innehåller en summering av tidigare genomförda steg som invånaren ska granska och bekräfta genom att klicka på Boka tid. Ett anrop till tidbokningssystemet sker med tjänstekontraktet MakeBooking“Boka tid”. Inget nytt anrop sker förrän invånaren klickar på “Boka tid”.

Gränssnitt

Rubrik + Tjänstekontrakt

MakeBooking

.fält

Kommentar

Image ModifiedImage Modified
 

Begäran

 

healthcare_facility_med

healthcare_facility

Mottagningens hsa-id.

(Det HSA-id som returnerades i GetAvailableTimeslots. Om HSA-id från svaret i GetAvailableTimeslots är null eller blankt så används istället HSA-id som skickades in i begäran till GetAvailableTimeslots)

healthcare_facility_name

Mottagningens namn.

startTimeInclusive

Startdatum och klockslag för den tid invånaren vill boka.

endTimeExclusive

Slutdatum och klockslag för den tid invånaren vill boka.

performer

HSA-id för HoS-person som besöket är bokat hos.

Har ett värde om tidbokningssystemet har skickat ett värde för den tiden.

performerName

Namn på HoS-person som besöket är bokat hos.

Har ett värde om tidbokningssystemet har skickat ett värde för den tiden.

bookingId

Skickas ej

subject_of_care

Personnummer för den invånare som bokningen avser. Format enligt yyyymmddxxxx.

purpose

Returnerar den information som tidbokningssystemet skickat för den valda tiden.

reason

Returnerar bokningsanledning om tidbokningssystemet har efterfrågat informationen.

resourceId

Id för resurs.

Har ett värde om tidbokningssystemet skickat värde för vald tid.

resourceName

Namn på resurs.

Har ett värde om tidbokningssystemet skickat värde för vald tid.

timeTypeName

Tidstyp för det bokade besöket.

timeTypsId

Id för tidstyp.

careTypeName

Skickas ej

careTypeId

Skickas ej

notification

Skickas ej

subject_of_care_info/phone

Invånarens telefonnummer

Hämtas från inställningarna i 1177 och visas om det finns. Kan editeras av invånaren.

subject_of_care_info/email

Skickas ej

subject_of_care_info/address

Skickas ej

subject_of_care_info/coaddress

Skickas ej

subject_of_care_info/firstName

Skickas ej

subject_of_care_info/middleName

Skickas ej

subject_of_care_info/lastName

Skickas ej

 

Svar

 

bookingId

Id för skapad bokning. Ska anges vid genomförd bokning (resultCode OK eller INFO), annars inte (ERROR).

Visas ej.

resultCode

Status för den gjorda bokningen.

OK, INFO, ERROR

Se bild nedan, under Felmeddelande

resultText

Ev. meddelande kopplat till resultatkoden.

Visas om resultCode = ERROR eller INFO

Felmeddelanden

resultCode = ERROR, resultText saknas

Om bokningsförfrågan nått mottagaren, men ett fel uppstår på mottagarens sida, visas ett felmeddelande upp. Om ingen text returneras i resultText visas följande:

...

resultCode = ERROR + resultText returneras

Om bokningsförfrågan nått mottagaren, men ett fel uppstår på mottagarens sida, visas ett felmeddelande upp. Meddelande som visas är från MakeBooking-fältet resultText resultCode = ERROR.

...

resultCode returneras ej

Om en bokningsförfrågan skickas, men ingen resultCode returneras, visas följande felmeddelande:

...

Bokningsbekräftelse i gränssnittet

När bokningen är genomförd skapas en bokningsbekräftelse i gränssnittet baserat på den information som finns innan bokningen är genomförd. Samtidigt skapas en bokningsbekräftelse baserat på samma information som hamnar i 1177 Inkorg.

Information från verksamhetssystemen som visas i bokningsbekräftelsen:

  • Dag & tid

  • Mottagning (+ ev. namn på personal + ev. namn på resurs. Visas ej i skärmdumpen)

    • namnet på mottagningen hämtas från 1177s egna databas.

  • Bokningen avser (tidstyp)

  • Anledning till bokningen

  • Information från vården. Under denna rubrik visas både purpose och ResultText i de fall resultCode=INFO.

Länkar som kan hänvisa invånaren vidare:

  • Bekräftelsen finns i din inkorg

  • Se bokade tider (länk till mottagningens bokade tider)

  • <namn på mottagning>

...

Dag & tid

GetAvailableTimeslots.startTimeInclusive

GetAvailableTimeslots.endTimeInclusive

Datum och klockslag för starttid och ev. sluttid som ska bokas

Mottagning

(hämtas från HSA)

Namn på bokad mottagning/vårdenhet.

Bokningen avser

GetAllTimeTypes.timeTypeName

Namn för tidstyp som ska bokas (vad bokningen avser).

Anledning till bokningen

GetAvailableTimeslots.reason

Eventuell anledning till bokningen. Visas endast om verksamheten har bett om att invånaren ska fylla i.

Information från vården

GetAvailableTimeslots.purpose

Information från vården.

  • “Information från vården” visas alltid som rubrik i gränssnittet om information skickas i fältet.

  • Om text skickas enligt DocBook-format kan en eller flera underrubriker definieras av verksamheten och visas i detta fält. Här finns en sida som visar på skillnader i e-tjänsternas stöd för DocBook i inkorgen och i tidboken: DocBook - skillnad i stödet för 1177 Inkorg och Tidbokning

Bokningsbekräftelse i gränssnittet

När invånaren klickat på “Boka tid” sker ett anrop till tidbokningssystemet med tjänstekontraktet MakeBooking. En bokningsbekräftelse visas för invånaren i gränssnittet och samtidigt skapas en bokningsbekräftelse baserat på samma information som hamnar i 1177 Inkorg.

Förutom fälten beskrivna i nedan tabell finns även länkar som kan hänvisa invånaren vidare:

  • Bekräftelsen finns i din inkorg i e-tjänsterna på 1177.

  • Se bokade tider (länk till mottagningens bokade tider)

  • <namn på mottagning> (länk till mottagningens startsida)

MakeBooking

Tjänstekontraktet MakeBooking används för att skicka en bokningsbegäran till verksamhetssystemet.

Gränssnitt

Tjänstekontrakt

MakeBooking

Kommentar

 

Image Added

Begäran

 

healthcare_facility_med

healthcare_facility

Mottagningens hsa-id.

(Det HSA-id som returnerades i GetAvailableTimeslots. Om HSA-id från svaret i GetAvailableTimeslots är null eller blankt så används istället HSA-id som skickades in i begäran till GetAvailableTimeslots)

healthcare_facility_name

Mottagningens namn.

startTimeInclusive

Startdatum och klockslag för den tid invånaren vill boka.

endTimeExclusive

Slutdatum och klockslag för den tid invånaren vill boka.

performer

HSA-id för HoS-person som besöket är bokat hos.

Har ett värde om tidbokningssystemet har skickat ett värde för den tiden.

performerName

Namn på HoS-person som besöket är bokat hos.

Har ett värde om tidbokningssystemet har skickat ett värde för den tiden.

bookingId

Skickas ej

subject_of_care

Personnummer för den invånare som bokningen avser. Format enligt yyyymmddxxxx.

purpose

Returnerar den information som tidbokningssystemet skickat för den valda tiden.

reason

Returnerar bokningsanledning om tidbokningssystemet har efterfrågat informationen.

resourceId

Id för resurs.

Har ett värde om tidbokningssystemet skickat värde för vald tid.

resourceName

Namn på resurs.

Har ett värde om tidbokningssystemet skickat värde för vald tid.

timeTypeName

Tidstyp för det bokade besöket.

timeTypsId

Id för tidstyp.

careTypeName

Skickas ej

careTypeId

Skickas ej

notification

Skickas ej

subject_of_care_info/phone

Invånarens telefonnummer

Hämtas från inställningarna i 1177 och visas om det finns. Kan editeras av invånaren.

subject_of_care_info/email

Skickas ej

subject_of_care_info/address

Skickas ej

subject_of_care_info/coaddress

Skickas ej

subject_of_care_info/firstName

Skickas ej

subject_of_care_info/middleName

Skickas ej

subject_of_care_info/lastName

Skickas ej

 

Svar

 

bookingId

Id för skapad bokning. Ska anges vid genomförd bokning (resultCode OK eller INFO), annars inte (ERROR).

Visas ej.

resultCode

Status för den gjorda bokningen.

OK, INFO, ERROR

resultText för resultCode=INFO är texten där det står “Här får du lite informationstext att visa upp”

Image Added

resultText för resultCode = ERROR:

Se bilder nedan, under Felmeddelande

resultText

Ev. meddelande kopplat till resultatkoden.

Visas om resultCode = ERROR eller INFO

Felmeddelanden

resultCode = ERROR, resultText saknas

Om bokningsförfrågan nått mottagaren, men ett fel uppstår på mottagarens sida, visas ett felmeddelande upp. Om ingen text returneras i resultText visas följande:

...

resultCode = ERROR + resultText returneras

Om bokningsförfrågan nått mottagaren, men ett fel uppstår på mottagarens sida, visas ett felmeddelande upp. Meddelande som visas är från MakeBooking-fältet resultText resultCode = ERROR.

...

resultCode returneras ej

Om en bokningsförfrågan skickas, men ingen resultCode returneras, visas följande felmeddelande:

...

Bekräftelse i 1177 inkorg

...