...
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. | |
<skärmdump> | 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 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 GetAvailableDates | Kommentar | |
---|---|---|---|
| Begäran |
| |
healthcare_facility | Hsa-Id för mottagning/vårdenhet | ||
bookingId | Internt bokningsid. | ||
startDateInclusive | Datum från och med för de lediga tider som skall sökas ut, på formatet ÅÅÅÅMMDD. | ||
endDateInclusive | Datum till och med för de lediga tider som skall sökas ut, på formatet ÅÅÅÅMMDD. | ||
timeTypeName | Namn för tidstypen / vad bokningen avser. | ||
timeTypeID | Id för tidstypen. 1177 skickar den kod som tidbokningssystemet returnerat i ett tidigare steg. | ||
careTypeName | Används ej | ||
careTypeID | Används ej | ||
performer | HSA-id för vårdpersonal.
| ||
subject_of_care | Invånarens personnummer enligt format yyyymmddxxxx. | ||
Dag&tid vyn fortsätter, se nedan | Svar |
| |
performerAvailabilityByDate 0..* | Kalendervy visar dagar med lediga tider. Invånaren kan söka vidare, en månad i taget. Första lediga dag med tider visas som förvald i kalendervyn. | ||
healthcare_facility | Id för mottagningen. Ska matcha begäran. Visas ej i gränssnittet | ||
performer | Hsa-id för ev. vald personal. Ska matcha begäran. Visas ej. | ||
performerName | Vårdpersonalens namn. Ska visas. | ||
date | Ett datum där lediga tider finns. Visas med blå ring runt i kalendern. Utan kalender kan invånaren navigera mellan lediga tider med pilknapparna. | ||
resourceName | Används ej. | ||
resourceID | Används ej | ||
timeTypeName | Namn för vald tidstyp. Ska matcha begäran, men visas inte upp igen (syns i Steg 2 i bokningen.) | ||
timeTypeID | Id för tidstyp. Ska matcha begäran. Visas ej i gränssnittet | ||
careTypeName | Används ej | ||
careTypeID | Används ej |
...
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
| ||||||
endDateInclusive 1..1 | Datum för de lediga tider som skall sökas ut. Format: ÅÅÅÅMMDD
| ||||||
performer | HSA-id för vårdpersonal.
| ||||||
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.
| ||||||
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 name | 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 verksamheten.
Fältet visas i steg 5 - Bekräfta bokningen.
| ||||||
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.
| ||||||
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)
| ||||||
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).
|
...
Gränssnitt | Tjänstekontrakt AddMessage | Kommentar |
---|---|---|
(Sista raden “Om du vill av- eller omboka tiden, gå till Testvårdcentral A“, är en bug och ska tas bort) | Begäran |
|
subjectOfCareId | Invånarens personnummer | |
threadId | Meddelandets tråd-id. Utgörs av hsaId+bookingId. | |
threadTitle | Trådtitel sätts alltid till “Tidbokning“. | |
threadLabel | Skickas ej | |
message |
| |
message.title | Meddelandets titel | |
message.text | Meddelandets text i DocBook-format. Här visas: Dag och tid: startTimeInclusive (samt eventuellt endTimeInclusive) Mottagning: namnet kommer från e-tjänsterna Bokningen avser: timeTypeName Anledning till bokning: reason Information: resultText i de fall resultCode=INFO. Information från vården: purpose | |
message.organisationUnit |
| |
message.organisationUnit.unitId | hsaId | |
message. organisationUnit.unitName | Mottagningsnamn | |
message.serviceLink | Skickas ej | |
message.serviceLink.serviceId | Skickas ej | |
message.serviceLink.queryString | Skickas ej | |
message.serviceLink. hasAttachment | Skickas ej | |
message.actions | En action skickas bara om mottagningen har tjänsten VISATID utdelad på sig. | |
message.actions.queryString | queryString innehåller hsaid+dynamicId. Används för att skapa en knapp till bokade tider på mottagningen. | |
message.actions.text | Text som visas på knappen i bokningsbekräftelsen. Tidboken sätter alltid texten till “Till bokningen“. | |
message.actions.serviceId | Tidboken skickar serviceTypeCode VISATID. | |
message.actions.displayType | Tidboken skickar displayType BUTTON | |
notify | Skickas som false | |
queueForDays | Skickas ej | |
approve | Skickas som false | |
accountableOrganisation | Tidboken skickar 1177 e-tjänsters hsaId. | |
| Svar |
|
threadId | Meddelandets tråd-id. | |
resultCode | Status för AddMessage-anropet. OK, INFO, ERROR. | |
resultText | Ev. meddelande kopplat till resultatkoden. Vid resultCode INFO visas meddelandet upp i bokningsbekräftelsen. |
...