CommunicationRequest - Hendelsesvarsel

Metainformasjon

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

id: Dette er ressursens ID når ressursen er lagret på Helsenorge. Denne genereres av Helsenorge og er alltid en GUID.
meta.security - Tjenesteområde (obligatorisk):
- Skal alltid være med for CommunicationRequest (se HER for ytterligere forklaring og gyldige kodeverdier)

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.tag - Varsling (frivillig)
Parameteren bør benyttes for å angi hvordan avsender organisasjonen skal framstå (navn) i SMS- og e-post varsler til innbygger. Dersom ikke angitt, inkluderes ikke navnet til avsender av Hendelsesvarselet i SMS/e-post varsel til innbygger om ny hendelse.
Kodesystem: http://helsenorge.no/fhir/varsling
Verdisett (gyldige kodeverdi for ServiceRequest):
- 9 - Benytt angitt navn som avsender i varsel til innbygger
Eksempler:

<meta>
   <tag>
       <extension url="http://helsenorge.no/fhir/extension/varselorganisasjon">
         <valueString value="Ullevål sykehus, OUS"/>
       </extension>
       <system value="http://helsenorge.no/fhir/varsling"/>
       <code value="9"/>
       <display value="Benytt angitt navn som avsender i varsel til innbygger"/>
   </tag>
</meta>

Ressursens profil (CommunicationRequest)

identifier (mandatory): En identifikator som identifiserer det enkelte Hendelsesvarsel forretningsmessig uavhengig av ressursens id på en FHIR-server. Skal være en GUID. Kan benyttes for å knytte denne Hendelsesvarsel sammen med eventuelle etterfølgende Hendelsesvarseler. Eksempel på bruk under:

<identifier>
        <!-- GUID satt av den som har generert Hendelsesvarselet. Benyttes for å referer til dette Hendelsesvarselet unikt -->
        <system value="urn:ietf:rfc:3986"/>
        <value value="urn:uuid:aa54d29e-4009-49cb-9ec4-847a6469459d"/>
</identifier>

status (mandatory): Status på CommunicationRequest i henhold til FHIR kodeverk, skal alltid være “active” og er påkrevd.

<status value="active" />

category (mandatory): Type CommunicationRequest i henhold til FHIR kodeverk.

Gyldige kodeverdier for Hendelsesvarselet:

“notification”: Benyttes normalt ved nye meldinger
“reminder”: Benyttes når innbygger minnes på noe man tidligere er gjort kjent med

<!-- Hendelsesvarsel skal angi kategori -->
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/communication-category "/>
            <code value="notification"/>
        </coding>
    </category>

subject (mandatory): Dette identifiser innbygger som skal ha Hendelsesvarselet og det skal benyttes fødselsnummer eller d-nummer.

Eksempel på bruk under:

<subject>
       <type value="Patient" />
        <identifier>
           <system value="urn:oid:2.16.578.1.12.4.1.4.1" />
           <value value="13116900216" />
       </identifier>
</subject>

about (betinget): Dersom Hendelsesvarsel referer til en konkret ressurs som er tilgjengelig på Helsenorge, kan det legges inn en referanse til denne her. Med tilgjengelig menes at ressursen enten er lagret på Helsenorge eller at Helsenorge kan hente denne på vegne av innbygger fra den eksterne aktøren. Helsenorge kan da vise detaljene til innbygger. For ressurser som hentes eksternt, må avsender av hendelse verifisere at innbygger som mottar hendelse også har tilgang til ressursen. Eksempelvis skal det ikke sendes varsel om prøvesvar som ikke er tilgjengelig for innbygger.

Må inneholde verdi for følgende (så langt) definrete typer Hendelsesvarsel (se under for elementet “payload”):

1001: Nytt prøvesvar - Må være med
1002: Endrede pørvesvar - Må være med
1010: Påminnelse fra verktøy - Må være med
1020: Nytt dokument - Varsel om at de finnes et nytt dokument som omhandler innbygger - Må være med
1030: Endret DHG status - Varsel om endret status i det Digitale Helsekortet for gravide - Må være med

1001 og 1002: Eksempler for en hendelsevarsel som angår nytt eller endret prøvesvar.

Pr. i dag har vi 3 forskjellige kilder for prøvesvar:

Pasientens Prøvesvar (sentral tjeneste under utprøving)

<about>
    <!-- Her legges inn referanse til FHIR-ressurs som finnes, eller kan hentes, på Helsenorge -->
    <!-- Eksempel fra Pasientens Prøvesvar -->
    <type value="Observation" />
    <identifier>
       <system value="http://nhn.no/pps/ressursid"/>
       <value value="aa54d29e-4009-49cb-9ec4-847a6469459d"/>
    </identifier>
</about>

Dokumentbaserte prøvesvar (via nasjonal XDS-løsning)

<about>
    <!-- Her legges inn referanse til FHIR-ressurs som finnes, eller kan hentes, på Helsenorge -->
    <!-- Eksempel fra dokumentbaserte prøvesvar fra speialisthelsetjenesten -->
    <type value="Observation" />
    <identifier>
       <system value="http://nhn.no/xds/dokumentlokaliseringsinformasjon"/>
       <value value="[Home Community Id]:[Repository Unique Id]:[Document Unique Id]"/>
    </identifier>
</about>

FHI sine korona prøvesvar

<about>
    <!-- Her legges inn referanse til FHIR-ressurs som finnes, eller kan hentes, på Helsenorge -->
    <!-- Eksempel fra FHI korona prøvesvar -->
    <type value="Observation" />
    <identifier>
       <system value="http://fhi.no/provesvar/provesvarid"/>
       <value value="83099085-ebce-4352-9df3-c8e16d85b47c"/>
    </identifier>
</about>

1010: Eksempel på hendelsevarsel som inneholder påminnelse fra et Verktøy

<about>
    <!-- Her legges inn referanse til FHIR-ressurs som finnes, eller kan hentes, på Helsenorge -->
    <!-- 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>
</about>

1020: Eksempel på varsel om at det finnes et nytt dokument (via den nasjonale dokumentdelingstjenesten)

<about>
    <!-- Her legges inn referanse til FHIR-ressurs som finnes, eller kan hentes, på Helsenorge -->
    <!-- Eksempel på referenase til et dokument som kan ses via nasjonal dokumentdelingstjeneste -->
    <type value="DocumentReference" />
    <identifier>
       <system value="http://nhn.no/xds/dokumentlokaliseringsinformasjon"/>
       <value value="[Home Community Id]:[Repository Unique Id]:[Document Unique Id]"/>
    </identifier>
</about>

1030: Eksempel på varsel om at status er endret i Digitalt Helsekort for Gravide.

<about>
    <type value="DocumentReference" />
    <identifier>
       <system value="http://nhn.no/dhg/recordid"/>
       <value value="d3fbcccd-1a75-41c6-94e2-8bf49f85911d"/>
    </identifier>
</about>

payload: Referanse til en Hendelsestype på Helsenorge. Disse er forhåndsdefinert og nye legges til ved behov. Teksten som vises for innbygger i Hendelsesmenyen vil være funksjon av Hendelsestype og “category” og vedlikeholdes av Helsenorge.

Foreløpig er følgende Hendelsestyper definert:

1001: Nytt prøvesvar - Det sendes varsel av type “obligatorisk”. Innbygger varsles alltid (uavhengig av hvilken varslingsprofil innbygger selv har valgt)
1002: Endrede pørvesvar - Det sendes varsel av type “obligatorisk”. Innbygger varsles alltid (uavhengig av hvilken varslingsprofil innbygger selv har valgt)
1010: Påminnelse fra verktøy - Innbygger varsles ikke fra Helseorge om hendelsen (men ser den ved første innlogging)
1020: Nytt dokument -Varsel om at de finnes et nytt dokument som omhandler innbygger. Varselet er av viktighet “Normal”. Dvs. Innbygger varsles med mindre innbygger eksplisitt har sagt at de vil ha så få varsler som mulig i sitt varseloppsett på Helsenorge.
(under implementering)1030: Endret DHG status - Varsel om endret status i det Digitale Helsekortet for gravide. Skal kun sendes fra eksternt system når status i DHG endres til Delivered eller Terminated.

Eks: 1001: Nytt prøvesvar

<payload>
   <contentReference>
       <identifier>
           <system value="http://helsenorge.no/fhir/hendelsestype"/>
            <value value="1001"/>
         </identifier>
        <display value="Nytt prøvesvar"/>
    </contentReference>
</payload>

Eks: 1002: Endret prøvesvar

<payload>
   <contentReference>
       <identifier>
           <system value="http://helsenorge.no/fhir/hendelsestype"/>
            <value value="1002"/>
         </identifier>
        <display value="Endret prøvesvar"/>
    </contentReference>
</payload>

Eks: 1010: Påminnelse fra verktøy

<payload>
   <contentReference>
       <identifier>
           <system value="http://helsenorge.no/fhir/hendelsestype"/>
            <value value="1010"/>
         </identifier>
        <display value="Påminnelse fra verktøy"/>
    </contentReference>
</payload>

Eks: 1020: Nytt dokument

<payload>
   <contentReference>
       <identifier>
           <system value="http://helsenorge.no/fhir/hendelsestype"/>
            <value value="1020"/>
         </identifier>
        <display value="Nytt dokument"/>
    </contentReference>
</payload>

Eks: 1030: Endret DHG status

<payload>
   <contentReference>
       <identifier>
           <system value="http://helsenorge.no/fhir/hendelsestype"/>
            <value value="1030"/>
         </identifier>
        <display value="Endret DHG status"/>
    </contentReference>
</payload>

requester (mandatory): Den som har generert Hendelsesvarselet. Skal inneholde organisasjonsnummer og navn. Denne informasjonen vises ikke til innygger i Hendelsemenyen.

Eks:

<requester>
        <type value="Organization"/>
        <identifier>
           <!-- Avsenders organisasjonsnummer -->
           <system value="urn:oid:2.16.578.1.12.4.1.2.101" />
            <value value="994598759" />
        </identifier>
        <display value="Norsk Helsenett SF"></display>
</requester>

Sender (mandatory): Den tjeneste som varselet er relatert til. Denne vises som avsender av Hendelsesvarselet for innbygger i Hendelsesmenyen.

Eks:

<sender>
        <type value="HealthcareService"/>
        <display value="Pasientens Prøvesvar"/>
</sender>

Eksempel på CommunicationRequest

Varsel om nytt Prøvesvar i Pasientens Prøvesvar

<?xml version="1.0" encoding="UTF-8"?>
<CommunicationRequest 
    xmlns="http://hl7.org/fhir"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://hl7.org/fhir fhir-single.xsd">
    <meta>
        <security>
            <!-- Man skal angi hvilket "område" ressursen faller inn under. Dette benyttes
                 på Helsenorge for å tilordnede riktig tilgansstyringsprofil til det aktuelle objektet.   -->
            <!-- Volven kodeverk 7618 benyttes -->
            <system value="urn:oid:2.16.578.1.12.4.1.1.7618"/>
            <code value="3"/>
            <display value="Helsehjelp"/>
        </security>
        <!-- Må benyttes dersom avsenders navn skal være med i varsler fra Helsenorge til innbygger på e-post/SMS -->
        <tag>
            <extension url="http://helsenorge.no/fhir/extension/varselorgansasjon">
                <valueString value="Pasientens Prøvesvar"/>
            </extension>
            <system value="http://helsenorge.no/fhir/varsling"/>
            <code value="9"/>
            <display value="Benytt angitt navn som avsender i varsel til innbygger"/>
        </tag>
    </meta>
    <identifier>
        <!-- GUID satt av den som har generert Hendelsesvarselet. Benyttes for å referer til dette Hendelsesvarselet unikt -->
        <system value="urn:ietf:rfc:3986"/>
        <value value="urn:uuid:aa54d29e-4009-49cb-9ec4-847a6469459d"/>
    </identifier>
    <status value="active" />
    <!-- Hendelsesvarsel skal alltid angi kategori -->
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/communication-category "/>
            <code value="notification"/>
        </coding>
    </category>
    <subject>
       <type value="Patient" />
        <identifier>
           <system value="urn:oid:2.16.578.1.12.4.1.4.1" />
           <value value="13116900216" />
       </identifier>
   </subject>
   <about>
        <!-- Her legges inn referanse til FHIR-ressurs som finnes, eller kan hentes, på Helsenorge -->
        <!-- Eksempel fra Pasientens Prøvesvar -->
        <type value="Observation" />
        <identifier>
            <system value="http://nhn.no/pps/ressursid"/>
            <value value="aa54d29e-4009-49cb-9ec4-847a6469459d"/>
        </identifier>
   </about>
   <payload>
       <contentReference>
           <identifier>
               <system value="http://helsenorge.no/fhir/hendelsestype"/>
               <value value="1001"/>
            </identifier>
           <display value="Nytt prøvesvar"/>
       </contentReference>
   </payload> 
   <requester>
        <type value="Organization"/>
        <identifier>
           <!-- Avsenders organisasjonsnummer -->
           <system value="urn:oid:2.16.578.1.12.4.1.2.101" />
            <value value="994598759" />
        </identifier>
        <display value="Norsk Helsenett SF"></display>
    </requester>
    <sender>
        <type value="HealthcareService"/>
        <display value="Pasientens Prøvesvar"/>
    </sender>
 </CommunicationRequest>

Påminnelse fra Verktøy

<?xml version="1.0" encoding="UTF-8"?>
<CommunicationRequest 
    xmlns="http://hl7.org/fhir"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://hl7.org/fhir fhir-single.xsd">
    <meta>
        <security>
            <!-- Man skal angi hvilket "område" ressursen faller inn under. Dette benyttes
                 på Helsenorge for å tilordnede riktig tilgansstyringsprofil til det aktuelle objektet.   -->
            <!-- Volven kodeverk 7618 benyttes -->
            <system value="urn:oid:2.16.578.1.12.4.1.1.7618"/>
            <code value="1"/>
            <display value="Rettigheter og selvhjelp"/>
        </security>
        <!-- Må benyttes dersom avsenders navn skal være med i varsler fra Helsenorge til innbygger på e-post/SMS -->
        <!-- Inntil videre tillates ikke at Helsenorge selv varsler innbygger via e-post/SMS for Verktøypåminnelser -->
        <tag>
            <extension url="http://helsenorge.no/fhir/extension/varselorgansasjon">
                <valueString value="SMART-mosjon"/>
            </extension>
            <system value="http://helsenorge.no/fhir/varsling"/>
            <code value="9"/>
            <display value="Benytt angitt navn som avsender i varsel til innbygger"/>
        </tag>
    </meta>
    <identifier>
        <!-- GUID satt av den som har generert Hendelsesvarselet. Benyttes for å referer til dette Hendelsesvarselet unikt -->
        <system value="urn:ietf:rfc:3986"/>
        <value value="urn:uuid:3b52ec71-3681-4d01-849f-21278bf2a21d"/>
    </identifier>
    <status value="active" />
    <!-- Hendelsesvarsel skal alltid angi kategori -->
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/communication-category "/>
            <code value="reminder"/>
        </coding>
    </category>
    <subject>
       <type value="Patient" />
        <identifier>
           <system value="urn:oid:2.16.578.1.12.4.1.4.1" />
           <value value="13116900216" />
       </identifier>
   </subject>
   <about>
       <!-- Her legges inn referanse til FHIR-ressurs som finnes, eller kan hentes, på Helsenorge -->
       <!-- Eksempel for Verktøyet SMART-mosjon -->
       <type value="Device" />
       <identifier>
           <system value="http://nhn.no/helsenorge/verktoyid" />
           <value value="9d493acb-a404-48de-83d4-5f2d0806f74b"/>
       </identifier>
   </about>
   <payload>
       <contentReference>
           <identifier>
               <system value="http://helsenorge.no/fhir/hendelsestype"/>
               <value value="1010"/>
            </identifier>
           <display value="Påmionnelse fra verktøy"/>
       </contentReference>
   </payload> 
   <requester>
        <type value="Organization"/>
        <identifier>
           <!-- Avsenders organisasjonsnummer -->
           <system value="urn:oid:2.16.578.1.12.4.1.2.101" />
            <value value="983544622" />
        </identifier>
        <display value="Helsedirektoratet"></display>
    </requester>
    <sender>
        <type value="HealthcareService"/>
        <display value="SMART-mosjon"/>
    </sender>
 </CommunicationRequest>

Add label