FHIR Task - Oppgave
DomainResource (som alle ressurser arver fra)
(Se her for forklaring av elementer og gyldige kodeverdier som kan benyttes på Helsenorge for alle typer FHIR-ressurser: Meta informasjon som kan benyttes for alle FHIR ressurser )
Element | Bruk |
---|---|
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>
<!-- 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>
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>
Se HER for lovlige verdier. For å sikre korrekt bruk bør aktøren ha dialog med sin kontaktperson på Helsenorge.
Eks: Ønsker begrensning for representanter <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 <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).
<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>
<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). |
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):
| |
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.
<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>
<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:
| |
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:
| |
priority: 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. 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:
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:
<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>
<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>
<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.
<!-- 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>
<!-- 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="Patient" />
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.4.1" />
<value value="13116900216" />
</identifier>
</owner> | |
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>
<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 MERK! Helsenorge benytter kun angitte datoer i forretningslogikken. (Dvs. eventuell angivelse av time, minutt etc., tas ikke hensyn til):
<!-- Dette er svarfrist for utførelse av oppgaven. -->
<restriction>
<period>
<end value="2019-12-04T00:00:00.0000000+02:00" />
</period>
</restriction>
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: <!-- Dette er tidligste startdato og svarfrist for utførelse av oppgaven. -->
<restriction>
<period>
<start value="2019-11-21T00:00:00.0000000+02:00" />
<end value="2019-12-04T00:00:00.0000000+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-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 |