pushTimelineItem (REST)

/in /door

Deze REST maakt het mogelijk een afspraak (timeline item) in de agenda van Ysis te plaatsen en/of te updaten.

Endpoints:
Acceptatie1: https://acceptatie1-webservice.ysis.nl/medicalrecord/{bsn}/timeline/item
Acceptatie2: https://acceptatie2-webservice.ysis.nl/medicalrecord/{bsn}/timeline/item 
Production: https://webservice.ysis.nl/medicalrecord/{bsn}/timeline/item

Opmerkingen:

  • activityType: dit bepaald het type timeline item dat in Ysis wordt gemaakt. ‘DBC’ maakt een DBC timeline item, ‘ELZ’ een Eerstelijnszorg timeline item. Het kan ook worden leeg gelaten, dan wordt er een  ‘algemeen’ timeline item aangemaakt. Maar daaraan is dan geen activiteit/registratie gekoppeld.
  • Bij een type DBC moet als activity code een zorgactiviteit worden meegegeven, bij ELZ een eerstelijns activiteitcode. bij een ‘leeg’ type mag dit veld leeg zijn
  • bij ActivityID kan een eigen unieke waarde worden meegegeven. Deze kan gebruikt worden om de afspraak te updaten (via pushTimelineItem) of te deleten met de methode ‘deleteTimelineItem’
  • Het employeeID moet het personeelsnummer van de medewerker zijn voor wie deze afspraak is. Deze medewerker moet dan wel bestaan in Ysis, anders wordt een foutmelding teruggegeven en wordt het timeline item niet aangemaakt.
  • De duur van de afspraak wordt gebruikt als ‘default’ duration in Ysis bij het registreren van DBC en ELZ activiteiten.
  • activityDescription is een optioneel veld dat alleen gebruikt wordt bij ELZ activiteiten, en dan speciaal voor de situatie dat de activiteitcode niet bekend is in Ysis, of niet beschikbaar voor deze patient/of klant. Dus normaal wordt de formele naam van de activiteit als titel van de timeline item afspraak in Ysis gebruikt, maar als deze niet bekend is wordt de ‘activityDescription’ gebruikt als die wordt meegegeven. Als deze niet wordt meegegeven wordt de activiteitCode als titel gebruikt.

Voorbeeld Requests:
“Plan een DBC activiteit van 30 minuten voor medewerker met personeelsnummer ‘P1234’ met als onderwerp ‘afspraak’ “

{ “timelineItem”:
{ “activityId”:”b46ef92d-fb71-4146-8858-793a6f56c307″,
“activityType”:”DBC”,
“activityCode”:”194823″,
“description”:”afspraak”,
“activityDescription”:”behandeling x”,
“startDateTime”:”2021-01-11T14:30:00+02:00″,
“endDateTime”:”2021-01-11T15:00:00+02:00″,
“employeeId”: “122” }
}

“Plan een ELV activiteit van 30 minuten voor medewerker met personeelsnummer ‘P1234’ met als onderwerp ‘afspraak’ ”
{ “timelineItem”:
{ “activityId”:”b46ef92d-fb71-4146-8858-793a6f56c307″,
“activityType”:”ELZ”,
“activityCode”:”1000″,
“description”:”afspraak”,
“startDateTime”:”2021-01-11T14:30:00+02:00″,
“endDateTime”:”2021-01-11T15:00:00+02:00″,
“employeeId”: “122” }
}

Voorbeeld Responses
correcte response

bsn onbekend:
https: 404  error, met de tekst “No medical record found that matches BSN”

bsn niet correct:
https: 400  error, met de tekst “Not a valid bsn”

fout in de aanlevering:
https: 400 error, met een validatie tekst, bijvoorbeeld “JSON parse error: Unexpected character”