Oppdater status på oppgave med forenklet API

Oppgaver som allerede er innsendt kan oppdateres når visse kriterier er oppfylt. Det er to måter å oppdatere oppgaver på:

Via forenklet API for ren statusoppdatering
Via FHIR Patch for oppdatering av et større utvalg attributter på oppgaven

På denne siden beskrives enkel oppdatering av status.

Oppdatering av status på oppgave - forenklet API

Helseaktører har behov for å oppdatere status på oppgaver som utføres av innbygger utenfor Helsenorge, f.eks angi at en oppgave er påbegynt eller utført.

Det er kun oppgaver som har status “Aktiv” (ready) eller “Påbegynt” (in progress) på Helsenorge som kan oppdateres. Innbygger varsles ikke når operasjonen er gjennomført.

Tjenesten er av typen REST og oppdaterer kun status, men gir også mulighet for å sende med begrunnelse av statusendringen.

For endring av andre attributter eller ved behov for varsling av endringer må FHIR Patch benyttes (se https://helsenorge.atlassian.net/wiki/x/AYBCaw ).

Regler for oppdatering av status

Følgende begrensninger/forretningsregler er definert på Helsenorge for når status kan oppdateres:

Oppdateringen er initiert av innbygger, dvs som resultat av innbyggers handlinger
Status kan ikke oppdateres dersom:
- Status på Helsenorge = “completed”', “cancelled” eller “entered-in-error” (Task.status)
- Oppgavens gyldighet er passert, dvs. nåværende tidspunkt er etter det siste av:
  - Regulær frist (Task.restriction.periode.end)
  - Gyldighetsperiode utover regulær frist (Task.restriction)
    - http://helsenorge.no/fhir/StructureDefinition/hn-task-deadline

Status-attributtet i FHIR Task er beskrevet i detalj her: FHIR Task - Oppgave | Ressursens profil (Task)

Detaljer om API-et

Tjenesten benytter system-til-system kommunikasjon, og det kreves at klienten har tilgang til å skrive til løsningsområdet.

Tjenesten konsumerer og produserer application/json.

HTTP metode og rute

POST [baseUrl]/oppgave/v1/OppdaterStatus

Der baseUrl er til aktuelt Helsenorge system. Se her: Testmiljøer og endepunkter - Helsenorge - Helsenorge dokumentasjon

Request

Requestmodell: OppdaterOppgaveStatusRequest

Parameternavn	Type	Beskrivelse

Parameternavn	Type	Beskrivelse
fnr	string	Innbygger fødselsnummer som eier oppgaven, påkrevd
oppgaveGuid	guid	Id på oppgaven som skal oppdateres, påkrevd
status	string	Ny status, påkrevd
statusReason	string	Forklaring på f.eks kansellering av oppgave. Ikke påkrevd, maks 250 tegn.

Verdier som aksepteres for status (case sensitiv):

“in-progress”
"completed"
"cancelled"
"entered-in-error"

Eksempel:

{
  "fnr": "24916298869",
  "oppgaveGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "cancelled",
  "statusReason": “Årsak til kansellering" 
}

HTTP statuskoder

200 OK: Status oppdatert
400 Bad Request: Ugyldig payload/valideringsfeil
401/403: Mangler autorisasjon