Resource (som alle ressurser arver fra)
(Se her for forklaring av elementer som kan benyttes på Helsenorge for alle typer FHIR-ressurser: Felles for alle FHIR ressurser (Resource) )
id: Dette er ressursens ID når ressursen er lagret på Helsenorge. Denne skal alltid være en GUID.
En “id” kan benyttes for å hente ut en unik ressurs fra Helsenorge eller som identifikator for en ressurs som skal oppdateres. På REST-API’er identifiseres ressursen ved å inkludere id’en i URL'en. Når en ressurs skal oppdateres via meldingsformidling, må ressursen refereres ved hjelp av denne id.
Hvis en avsender ikke setter ressursens “id” i et REST-API, generer Helsenorge id’en (og denne returneres i responsen. Avsender må alltid sette denne ved meldingsformidling for å muliggjøre senere oppdateringer på ressursen.
Eks:
<!-- En unik ressurs GUID for Takset. Vil benyttes avhengig av HTTP-metode. Må være med ved HTTP PUT og ved meldingsbasert integrasjon. --> <id value="fb02b1bb-0942-494a-afce-8671937877f4"/>
Metadata.Security - Tjenesteområde: Skal alltid være med. Eks:
<meta> <!-- For en del FHIR-ressurser skal avsender angi hvilket "område" ressursen faller inn under. Dette benyttes på Helsenorge for å tilordnede riktig tilgansstyringsprofil til det aktuelle objektet. --> <!-- Volven kodeverk 7618 --> <security> <system value="urn:oid:2.16.578.1.12.4.1.1.7618"/> <code value="3"/> <display value="Helsehjelp"/> </security> </meta>
Metadata.Security - Sensitiv avsender: Kan være med og skal være med dersom avsenders navn/identitet anses som personsensitiv. Merk! Dersom ikke satt, vil avsenders navn ikke anses som sensitivt, og dermed inkluderes i varselmeldinger til innbygger på e-pos/SMS. Denne må derfor alltid settes dersom avsenders navn ikke skal inkluderes i varselmeldinger til innbygger.
Eks:
<meta> <!-- For en del FHIR-ressurser skal avsender angi om avsenders navn/identitet er sensitiv eller ikke. Dette benyttes for å avgjøre om avsenders navn skal inkluderes eller ikke når innbygger varsles om mottak på helsenorge. Dette fordi varsel skjer gjennom usikre kanaler (e-post og/eller SMS. Vi så valgt å ikke publisere kodeverdiene på Volven. - 0 = "Ikke sensitiv avsender" - 1 = "Sensitiv avsender" --> <security> <system value="http://helsenorge.no/fhir/sensitiv-avsender"/> <code value="1"/> <display value="Sensitiv avsender"/> </security> </meta>
Metadata.Tag - Innholdstype: Er normalt ikke med. Eventuelt behov for å ha denne med samt hvilken verdi som skal settes må avklares med kontaktperson på NHN. Eks:
<meta> <!-- For en del FHIR-ressurser og i visse contexter skal avsender angi hva slags "innholdstype" ressursen tilhører. Dette må ikke forveksles med Tilgangsområde som benyttes for å tilgangstyre ressursen på Helsenorge. Formålet med "innholdstype" er blant annet å difrensiere varslingstiekster på Helsenorge. Volven kodeverk 7613 benyttes --> <meta> <tag> <system value="urn:oid:2.16.578.1.12.4.1.1.7613"/> <code value="IB"/> <display value="Innkallingsbrev"/> </tag> </meta>
Metadata.Tag - Videreformidling: Kan være med dersom man ønsker at en oppgave skal formidles i fysisk post til innbygger dersom innbygger ikke er digitalt aktiv på Helsenorge. Der angitt i dokumentasjonen for den enkelte oppagvetype om videreformidling støttes eller ikke. Eks:
<meta> <!-- Avsender ønsker doument som erstatter/inneholder oppgaven videreformidlet til fysisk post dersom innbygger ikke er digital aktiv på Helsenoreg. --> <tag> <system value="http://helsenorge.no/fhir/videreformidling"/> <code value="1"/> <display value="Videreformidling hvis ikke aktiv"/> </tag> </meta>
Metadata.Tag - Varsling (kommer Q1 2022): En avsender kan be spesielt om at innbygger ikke varsles om mottak av oppgave/endring på oppgave.
<meta> <tag> <system value="http://helsenorge.no/fhir/varsling"/> <code value="1"/> <display value="Innbygger skal ikke varsles."/> </tag> </meta>
Contained: Requestor vil alltid være en "Contained Resource" som refereres til i FHIR task. Her skal organisasjonen som ber om at oppgaven utføres angis samt kontaktdetaljene der innbygger kan henvende seg ved spørsmål. Eks:
<contained> <Organization> <id value="requester-1"/> <identifier> <!-- Helsedirektoratets org nummer (som register eier). --> <system value="urn:oid:2.16.578.1.12.4.1.2.101" /> <value value="983544622" /> </identifier> <!-- Organisasjonen som er avsender av oppgaven sitt navn. Vil benyttes i "varslingstekst", med mindre "sensitiv avsender" er satt --> <name value="Sædgiverregisteret - Helsedirektoratet"/> <contact> <purpose> <coding> <system value="http://hl7.org/fhir/ValueSet/contactentity-type"/> <code value="PATINF"/> </coding> <!-- Her angis beskrivelse av konaktpunktet der innbygger skal henvende seg, kan inneholde avdelingsnavn om ønskelig --> <text value="Kontaktpunkt for henvendelser knyttet til samtykkeforespørselen." /> </purpose> <telecom> <system value="phone" /> <value value="+4747472020" /> </telecom> </contact> </Organization> </contained>
Extension: Dersom det (i sjeldne tilfeller) skulle være behov for å ha et annet tidspunkt for “dead-line” for utførelse av en task enn det som er angitt som frist for utførelse, kan dette angis i en Helsenorge spesifikk extension (se under).
Ressursens profil (Task)
identifier (mandatory): En identifikator som identifiserer denne oppgaven forretningsmessig uavhengig av ressursens id på en FHIR-server. Skal være en GUID. Kan benyttes for å knytte forskjellige andre type FHIR-ressurser, som oppstår som følge av at oppgaven utføres, sammen med oppgaven de tilhører (f.ek. et Skjemasvar). Kan også benyttes for å søke fram en oppgave når man ikke kjenner oppgavens “id”. Eks: | |
instantiatesUri (conditional):
| |
status (mandatory): Status på oppgaven i henhold til FHIR kodeverk. Vi benytter dette som følger, og følgende tilstander er implementert på Helsenorge:
| |
statusReason (optional): (Ny funksjonalitet Q1 2022): Her kan en ekstern aktør “forklare” hvorfor en tidligere sendt oppgave har endret status f.eks. blitt kansellert. Teksten vil kun vises så lenge status ikke (igjen) endres. Dersom man ønsker å bevare historikk på slike forklaringer må Task.note benyttes, se under. Eks: <statusReason> <text value="Oppgaven er kansellert fordi timen er utsatt på ubestemt tid"/> </statusReason> | |
intent (mandatory): Hensikt med oppgaven i henhold til FHIR kodeverk.
| |
priority (optional): Hvor mye det haster. Dersom ikke angitt, blir denne satt til "routine" som default på Helsenorge. Det benyttes standardiserte regler knyttet til varsling og påminnelser på Helsenorge basert på verdien her. | |
code (mandatory): Her skal oppgave tittelen legges. Dette bør være en kort beskrivende overskrift av hva oppgaven innebærer. Tittel vises i oversikten over oppgaver i Meldingssenteret på Helsenorge. Eks: <code> <!-- Her SKAL oppgavens tittel legges. --> <text value="Her skal oppgavens tittel legges"/> </code> | |
description (mandatory): En tekstlig beskrivelse av oppgaven som vises til innbygger. Bør gi en kort forklaring av oppgavens formål og innhold, og gjerne også noe om hvem som eventuelt får resultatet av utført oppgave. (Dette siste er spesielt relevant for skjemaoppgaver). | |
focus: Dette er en beskrivelse av ressursen som skal modifiseres når oppgaven utføres. Her skal det beskrives hva slags type ressurs som skal håndteres/modifiseres. Ofte skal det også beskrives hvilken ressurs, av aktuell type, som skal modifiseres ved å angi en identifikator for denne slik den er definert på Helsenorge (se under). focus.type (mandatory): Type ressurs. Så langt støttes:
focus.identifier (conditional): Identifikator for en ressurs av aktuell type. Benyttes alltid dersom ikke instantiatesUri benyttes (dvs. kan kun utelates dersom oppgaven utføres i et system utenfor Helsenorge) Eksempler:
<focus> <type value="Consent" /> <identifier> <system value="http://helsenorge.no/fhir/personverninnstillingdefinisjon-id"/> <value value="fb9214ff-2fcb-4242-a111-7880547c3523"/> </identifier> </focus>
<focus> <type value="Questionnaire"/> <identifier> <!-- Peker til skjemadefinisjon i samme bundle. GUID er samme som Questionnaire.id (i bundelen) --> <system value="urn:ietf:rfc:3986"/> <value value="urn:uuid:f3da38c2-594c-4d0a-b969-4ab9dfc0cc3f"/> </identifier> </focus>
<focus> <type value="Questionnaire"/> <!-- Merk at skjemaets identifier ikke er med i "focus" dersom ekstern skjemautfyller benyttes. Denne er da en del av instantiatesUri. --> </focus>
| |
authoredOn (optional): Tidspunkt når oppgaven ble laget. Dette settes normalt automatisk av Helsenorge ved mottak av oppgaven. Dersom det er viktig for avsender å indikere overfor innbygger at oppgaven er opprettet på et tidligere tidspunkt, kan denne settes. . | |
requester (mandatory): Den som ber om at oppgave utføres. Vi referer her til en organisasjon med kontakt detaljer. Organisasjonen inkluderes som en såkalt "contained ressurs". Eks: <!-- Skal alltid være med og SKAL referere til en "contained" ressurs --> <requester> <reference value="#requester-1" /> <type value="Organization" /> </requester> | |
owner (mandatory): Den som "eier" utførelsen av oppgaven. I vårt tilfelle er dette alltid pasienten dvs. innbygger. Skal angis med innbyggers fødselsnummer. Eks: <!-- Skal alltid vøre med, angir hvem som skal utføre oppgaven; her innbygger --> <owner> <type value="Patient" /> <identifier> <system value="urn:oid:2.16.578.1.12.4.1.4.1" /> <value value="13116900216" /> </identifier> </owner> | |
Ny funksjonalitet Q1 - 2022: note (optional): Her kan det legges til en eller flere notater til en eksisterende oppgave. Dette vil skje ved oppdatering av ressursen. Alle noter tas vare på og skal tidsstemples. Eks: <note> <time value="2021-12-10T14:03:42.8007888+02:00"/> <text value="Oppgaven ble opprinneig opprettet som forberedelse til spesialisttime. Oppgaven er nå trukket tilbake fordi timen er utsatt på ubestemt tid."/> </note> | |
restriction (mandatory): Denne skal benyttes for å angi når oppgaven skal/må utføres
<!-- Dette er svarfrist for utførelse av oppgaven. --> <restriction> <period> <end value="2019-12-04T14:03:42.8007888+02:00" /> </period> </restriction>
Dersom man ønsker at innbygger ikke skal kunne påbegynne oppgaven før et bestemt tidspunkt, kan "period" utvides med et "start" element. Eks: <!-- Dette er tidligste startdato og svarfrist for utførelse av oppgaven. --> <restriction> <period> <start value="2019-11-21T14:03:42.8007888+02:00" /> <end value="2019-12-04T14:03:42.8007888+02:00" /> </period> </restriction>
Det er også laget en egen Helsenorge extension til restriction som er kalt "deadline" (ref: https://github.com/helsenorge/helsenorge-fhir/blob/master/StructureDefinition/hn-task-deadline.structuredefinition-extension.xml ). Denne er mulig å bruke dersom man har en svarfrist, men det skal være mulig å utføre oppgaven etter dette tidspunkt. Dersom denne benyttes, må det i "description" ligge en forklaring på dette forholdet som er forståelig for innbygger. Eks: <!-- Dette er svarfrist for utførelse av oppgaven. --> <restriction> <!-- Mulighet for å angi annen deadline enn svarfrist (dvs. etter svarfrist) --> <extension url="http://helsenorge.no/fhir/StructureDefinition/hn-task-deadline"> <valueDate value="2019-12-31"/> </extension> <!-- Her er den ordinære svarfristen --> <period> <end value="2019-12-04T14:03:42.8007888+02:00" /> </period> </restriction> | |
input: Denne benyttes ikke for håndtering av workflow objektet Task. Her kan avsender legge til parametere som eventuelt behøves under selve oppgaveutføreselen. Det vil avhenge av type oppgave om slike input parametere er med eller ikke. Dette er dokumentert her: Task.input for forskjellige oppgavetyper |