Page Comparison

Resource.id

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"/>

Resource.meta.security

• meta.security - Tjenesteområde: Skal alltid være med.

  • Se HER for lovlige verdier og når de forskjellige verdiene skal benyttes.

• 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>

• meta.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. 
        

 "Sensitiv avsender"          -->
  <security>
    <system value="http://helsenorge.no/fhir/sensitiv-avsender"/>
    <code value="1"/>
    <display value="Sensitiv avsender"/>
  </security>
</meta>

• meta.security - Hvem som kan utføre/endre på aktuell ressurs.

  • Denne opsjonen kan benyttes dersom det er nødvendig/ønskelig å overstyre det som er standard regler på Helsenorge for hvem som kan utføre en oppgave:

    • Om oppgaven kun skal kunne utføres av innbygger selv, eller om innbygger med spesifikke egenskaper (ungdom eller adressesperre) også skal kunne utføre oppgaven

    • Hvem som skal kunne utføre oppgaver på vegne av innbygger/pasient (forelder eller fullmaktshaver)

  • Denne opsjonen gir ikke mulighet til å bestemme hvem som skal kunne se oppgaven. Dette styres av standardiserte regler på Helsenorge.

    • For å håndheve unntaksbestemmelsen for ungdom, benyttes meta.security - Tilgangsbegrensning

Se HER for lovlige verdier.

For å sikre korrekt bruk bør aktøren ha dialog med sin kontaktperson på Helsenorge.

• For samtykkeforespørsel, verktøystartoppgave og ekstern generisk oppgave gjelder som standard at innbyggere og representanter kan utføre oppgavene, inkludert innbyggere med adressesperre

  • Hvis aktør ønsker begrensninger utover dette skal opsjon benyttes

• For skjemaoppgaver gjelder spesielle regler for innbyggere med adressesperre:

  • Skjemaoppgaver kan pr Q2-2023, ikke utføres av innbyggere med adressesperre. Dette er resultat av en risikoanalyse innen området. Bruk av opsjon på oppgaven som tillater at oppgaven utføres av innbygger med adressesperre vil ikke overstyre dette, dvs opsjonen vil bli avvist av Helsenorge og oppgaven vises for innbygger, men uten mulighet til å fylle ut skjema

  • Det er under vurdering om også skjemaoppgaver kan tillates utført av innbyggere med adressesperre. Dette blir i så fall ingen generell tillatelse. Det vil kreve at det enkelte skjema eksplisitt er merket med attributter i skjemadefinisjonene som tilsier at skjemaet er trygt for slik bruk. (Nærmere informasjon om dette kommer når de nødvendige vurderinger er gjort).

  • Se også generell informasjon om begrensninger i bruk av de forskjellige opsjonskodene i fellesdokumentasjonen for alle FHIR-ressurser.

Eks: Ønsker begrensning for representanter
Oppgaven skal kun utføres av innbygger selv, inkludert innbygger med sperret adresse

<meta>
   <security>
      <system value="http://helsenorge.no/fhir/KanUtforesAv"/>
      <code value="1"/>
      <display value="Kan kun utføres av innbygger selv"/> 
   </security>
   <security>
      <system value="http://helsenorge.no/fhir/KanUtforesAv"/>
      <code value="6"/>
      <display value="Kan utføres selv om innbygger med adressesperree (adressekode 6/7)"/>    
   </security>
</meta>

Eks: Ønsker begrensning for innbygger
Oppgaven skal kun utføres dersom representasjon er foreldrerepresentasjon eller ved fullmakt for ikke samtykkekompetent

<meta>
   <security>
      <system value="http://helsenorge.no/fhir/KanUtforesAv"/>
      <code value="2"/>
      <display value="Kan utføres av foreldre til barn under 12 år"/> 
   </security>
   <security>
      <system value="http://helsenorge.no/fhir/KanUtforesAv"/>
      <code value="3"/>
      <display value="Kan utføres av foreldre til barn mellom 12-16 år"/>    
   </security>
   <security>
      <system value="http://helsenorge.no/fhir/KanUtforesAv"/>
      <code value="4"/>
      <display value="Kan utføres av representant med tildelt fullmakt (ikke samtykkekompetent pasient)"/>    
   </security>
</meta>

Resource.meta.tag

meta.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. Pr. i dag er dette kun mulig for Samtykkeforespørsler. 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>

Domainresource.contained

Contained: Requestor vil alltid være en "Contained Resource" som refereres til i FHIR task (dvs. den som er avsender av oppgaven).

• Normalt er dette en organisasjon. Ressursen vil angi hvilken organisasjon som ber om at oppgaven utføres 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.4.101" />
             <value value="983544622" />
          </identifier>
          <!-- Organisasjonen som er avsender av oppgaven sitt navn. Maks 250 tegn. 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. Maks 1024 tegn. -->
              <text value="Her skal det legges inn en beskrivelse av hvor innbygger kan henvende seg ved spørsmål om oppgaven." />
            </purpose>
            <telecom>
              <system value="phone" />
              <!-- Her kan det legges inn et telefonnummer som innbygger kan bruke, for eksempel +47 47472020 -->
              <value value="+4747472020" />
            </telecom>
          </contact>
    </Organization>
</contained>

• Det er nå definert en egen oppgave type der en ber innbygger ta i bruk et digitalt verktøy. Da vil avsender av oppgave være en bestemt behandler. Den refererte ressursen skal i dette tilfelle være av type Practitioner med dennes kontaktdetaljer. Eks:

<contained> 
  <Practitioner>
    <id value="requester-1"/>
    <identifier>
        <!-- Normalt skal behandlers HPR-nummer (2.16.578.1.12.4.1.4.4)angis. 
             Unntaksvis kan FNR (2.16.578.1.12.4.1.4.1) benyttes dersom behandler 
             er situasjonsbetinget helsepersonell uten HPR-nummer (f.eks. sosionom) -->
        <system value="urn:oid:2.16.578.1.12.4.1.4.4" />
        <value value="10020001" />
    </identifier>
    <name>
        <family value="Langhelle"/>
        <given value="Marit"/>
     </name>
     <telecom>
        <system value="phone" />
        <value value="+4755976500" />
     </telecom>
  </Practitioner>
</contained>

Domainresource.extension

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).

Image Added

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:

Image Added

instantiatesUri (conditional):

1. Skal benyttes for å peke til eksterne skjemautfyllere dersom oppgaven er av type Questionnaire. Dvs. dersom en oppgave av type skjema skal utføres i en annen skjemautfyller enn den som finnes på Helsenorge. Dette skal være en full URL med nødvendige parametere slik at ekstern utfyller kan utføre oppgaven.

2. Skal benyttes der man ønsker å peke til et eksternt nettsted der innbygger skal utføre en oppgave, dvs. der Task.focus er av typen “task”. Dette skal være en full URL med nødvendige parametere.

basedOn (optional): Helseaktør kan referere til andre typer ressurser som er “kjent” på Helsenorge for å gi innbygger bedre forståelse for hvilken sammenheng oppgaven kommer i. For eksempel kan oppgaven referere til en henvisning når innbygger bes om å velge time som del av et behandlingsløp, eller til en timeavtale når innbygger bes om å sende inn utfyllende helsestatus. Task.basedOn vil bestå av en eller flere referanser. Disse kan oppdateres.

• “ServiceRequest”: Benyttes for referanse til Henvisning

<basedOn>
  <type value="ServiceRequest" />
  <identifier>
         <!-- Det forutsettes at det benyttes globale unike identifikatorer for henvisningen. -->
         <system value="urn:ietf:rfc:3986"/>
         <value value="urn:uuid:038ba303-0ce5-4e87-aef2-88f8f98183c0"/>
  </identifier> 
  <display value="Henvisning"/>
</basedOn>

• “Appointment”: Benyttes for referanse til Timeavtale

<basedOn>
  <type value="Appointment" />
  <identifier>
     <!-- Det forutsettes at det benyttes globale unike identifikatorer for timeavtalen. 
          Merk! Må samordnes med endelig sepc for nasjonal profil for timeavatale notifikasjon -->
     <system value="urn:ietf:rfc:3986"/>
     <value value="urn:uuid:34d21e1f-67b3-46d6-9caf-90b355709315"/>
  </identifier> 
  <display value="Timeavtale"/>
</basedOn>

Hvordan man kan endre referansen (og andre definerte felt på en eksisterende Task) er beskrevet her: Oppdatering av attributter på Task (FhirPatch)

status (mandatory): Status på oppgaven i henhold til FHIR kodeverk.

Vi benytter dette som følger, og følgende tilstander er implementert på Helsenorge:

• ready: Dette er verdien som eksterne skal sette når de sender en oppgave til innbygger. På Helsenorge vises dette som "Ikke utført". Oppgaven kan da utføres innfor “gyldighetstid”.

• in-progress: Noen arbeidsflyter på Helsenorge har en tilstand der innbygger kan starte en oppgave, men velge å lagre resultatet av delvis utført oppgave. Innbygger kan senere velge å fullføre oppgaven med utgangspunkt i mellomlagrede data. På Helsenorge vises dette som "Påbegynt"

• completed: Dette er tilstand når oppgaven er ferdigstilt. På Helsenorge vises dette som "Utført"

• cancelled: En ekstern aktør kan kansellere en oppgave som tidligere er sendt til innbygger. På Helsenorge vises dette som "Kansellert" (eventuelt sammen med en statusReason)

• entered-in-error: En ekstern aktør kansellere en oppgave på grunn av at den ble feilregistrert. På Helsenorge vises dette som "Kansellert" (eventuelt sammen med en statusReason).

Image Added

statusReason (optional, maks 250 tegn): 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. Det støttes kun følgende to verdier:

• “proposal”: Innbygger kan velge å skru av påminnelser.

• “plan”: Innbygger har ikke anledning til å skru av påminnelser. Skal kun benyttes dersom oppgaven er direkte knyttet til ytelse av helsehjelp.

Image Added

priority (optional): Benyttes ikke av Helsenorge.

code (conditional, max 250 tegn): Her skal tittel på oppgave 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.

Kan utelates for oppgave om å ta i bruk et digitalt verktøy, siden disse oppgavene i stedet får generert en tittel basert på navn på ressurs og requester.

Eks:

<code>
        <!-- Her SKAL oppgavens tittel legges. -->
        <text value="Utfylling av Helseopplysninger før konsultasjon"/>
</code>

description (mandatory, max 1024 tegn): 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:

• "Consent" - Benyttes ved Samtykkeforepørsler

• "Questionnaire" - Benyttes dersom oppgaven er å fylle ut et skjema, da skal skjemasvaret lagres i innbyggers helsearkiv på Helsenorge

• "Task" (uten ytterligere spesifikasjon) - Benyttes for generelle oppgaver innbygger skal utføre i systemer utenfor Helsenorge.

• "Schedule" (kommer H2-2024) - Benyttes der innbygger selv kan velge time for spesialistbehandling etter at det er innvilget rett til helsehjelp.

• "Device" - Benyttes dersom innbygger får i oppgave å ta i bruk et digitalt verktøy.

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)

focus.display (conditional): Visningsnavn for ressursen. Påkrevd for oppgave om å ta i bruk et digitalt verktøy. Kan utelates for andre typer ressurser.

Eksempler:

• Eksempel på samtykkeforespørsel:

<focus>
        <type value="Consent" />
        <identifier>
            <system value="http://helsenorge.no/fhir/personverninnstillingdefinisjon-id"/>
            <value value="fb9214ff-2fcb-4242-a111-7880547c3523"/>
        </identifier>
</focus>

• Eksempel på skjemaoppgave, der Helsenorge sin skjemautfyller benyttes:

  • Der man refererer til et blankett nummer i skjemakatalogen. Et blankett nummer kan inneholde flere instanser, f.eks. for forskjellige språk. Innbygger velger da først språk i skjemautfyller.

    Code Block
    <focus> <type value="Questionnaire"/> <identifier> <system value="http://helsenorge.no/fhir/blankett-nummer"/> <value value="3DHV-IIFJ-1"/> </identifier> </focus>

  • Der man refererer til en bestemt instans av et blankettnummer.

  Code Block
  <focus> <type value="Questionnaire"/> <identifier> <system value="http://helsenorge.no/fhir/skjema-id"/> <value value="8"/> </identifier> </focus>

  • Eksempel der Helsenorge skjemautfyller benyttes, men der selve spørreskjemaet (Questionnaire) sendes med fra avsender sammen men oppgaven:

<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>

• Eksempel på skjemaoppgave, der ekstern utfyller benyttes, Merk: Da angis kun ressurstype og ikke skjemaets “identifier” i “focus”. Oppgavens ID i dte ekstrene systemet er en del av Task.instantiatesUri:

 <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>

• Eksempel på ekstern oppgavehåndtering, der arbeidsflyt for oppgaven skjer utenfor Helsenorge. I disse tilfellene så må eksternt system oppdatere status på oppgaven når den er utført. URL for utførelse av ekstern oppgave (inklusiv oppgavens Id) finnes i Task.instantiatesUri.

  Code Block
  language xml
  <focus> <type value="Task"/> <!-- Merk at oppgavens identifier ikke er med i "focus" dersom ekstern oppgavehåndtering benyttes. (Denne er i instantiatesUri) --> </focus>

• Eksempel på referanse til Schedule som det kan velges time fra (kommer H1-2025)

<focus>
	<type value="Schedule"/>
	<identifier>
      <!-- Peker til en unik identifikator for en Schedule som kan benyttes fra Helsenorge mot Timeløsningen hos spesialist.
           Det hentes et antall Slots der innbygger kan velge en for å opprette en Appointment. Oppgaven utføres på Helsenorge, 
           i samvirke med spesialist sin Timeløsning. -->
	  <system value="urn:ietf:rfc:3986"/>
	  <value value="urn:uuid:f3da38c2-594c-4d0a-b969-4ab9dfc0cc3f"/>
   </identifier>
</focus>

• Eksempel på referanse til et digitalt verktøy (det forutsettes at verktøyet allerede ligger i Verktøykatalogen på Helsenorge):

<focus>
   <!-- Eksempel på referenase til et Verktøy som ligger i Verktøykatalogen på Helsenorge -->
    <type value="Device" />
    <identifier>
       <system value="http://nhn.no/helsenorge/verktoyid" />
       <value value="6aaa34b9-103a-4d6c-a850-6cbfebb16348"/>
    </identifier>
    <display value="Assistert Selvhjelp Mestringsverktøy"/>
</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.

• ‘Organization’: Som regel er det en organisasjon som er avsender av oppgave. I slikt tilfelle refereres det til en FHIR ressurs av type “Organization”. Denne er som tidligere beskrevet inkludert som en "contained resource". Vi referer her til en organisasjon med kontakt detaljer. Organisasjonen inkluderes som en såkalt "contained resource". Eks: 

<!-- Skal alltid være med og SKAL referere til en "contained" ressurs -->
    <requester>
        <!-- Her referers til en organisasjon -->
        <reference value="#requester-1" />
        <type value="Organization" />
    </requester>

• ‘Practitioner’: Dersom oppgaven er å ta i bruk et digitalt verktøy er avsender av oppgave en bestemt behandler. Den refererte ressursen skal i slikt tilfelle være av type “Practitioner” med dennes kontaktdetaljer. Eks:

<!-- Skal alltid være med og SKAL referere til en "contained" ressurs -->
    <requester>
        <!-- Her referers til en individuell behandler -->
        <reference value="#requester-1" />
        <type value="Practitioner" />
    </requester>

owner (mandatory): Den som ‘eier’ utførelsen av oppgaven. I vårt tilfelle er dette alltid pasienten. (Oppgaver kan på Helsenorge utføres av andre enn pasienten, f.eks. foreldre på vegne av barn, men oppgaven skal alltid sendes til pasienten.) Skal angis med innbyggers fødselsnummer. Eks:

<!-- Skal alltid være med, angir pasienten oppgaven er relatert til -->
    <owner>
        <type value="

note (optional, maks 2048 tegn): Kan kun være med ved senere oppdatering av oppgaven. 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>

restriction (mandatory): Denne skal benyttes for å angi når oppgaven skal/må utføres

MERK! Helsenorge benytter kun angitte datoer i forretningslogikken. (Dvs. eventuell angivelse av time, minutt etc., tas ikke hensyn til):

• Angivelse av ordinær svarfrist

<!-- Dette er svarfrist for utførelse av oppgaven. -->
    <restriction>
        <period>
            <end value="2019-12-04T00:00:00.0000000+02:00" />
        </period>
    </restriction>

• (Støttes ikke pr. nå)Angivelse av tidligste startdato

Det er under vurdering om man skal kunne angi at innbygger ikke skal kunne påbegynne oppgaven før et bestemt tidspunkt, I slikt tilfelle kan "period" utvides med et "start" element. Eks: 

<!-- 

</restriction>

• Mulig angivelse av “deadline”

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-04T00:00:00.0000000+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