Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tabellen under beskriver kortfattet komponentene som inngår i løsningen.

Komponent

Beskrivelse

Medlemssystem

Medlemssystem som har oversikt over helsetilbud og medlemmer som mottar tilbud

Helsenorge

Innbyggers nettportal for helseinformasjon, eksponerer api for mottak av helsetilbud og medlemsliste

Helsenorge STS

Utsteder av sikkerhetstoken for å kalle API mot Helsenorge

Valg av standarder

For overføring av helsetilbud og medlemsinformasjon er den internasjonale standarden FHIR valgt, med bruk av versjon 4.0. Dokumentasjon av standarden fins her: http://hl7.org/fhir/.

...

Ved publisering av helsetilbud skal det gjøres en POST operasjon mot endepunkt eksponert av helsenorge.no
Forespørsel vil være på formen https://<miljø>/ helsekontakter/api/<versjon>
Eksempel fra integrasjonstestmiljø https://eksternapi-hn-mas-02.int-hn.nhn.no/helsekontakter/api/v1
Tabellen under viser hvilken informasjon som skal overføres for helsetilbud

Ressurs

Attributt

Beskrivelse

Eksempel

Påkrevd

HealthcareService

Identifier

Lokal Id i medlemssystem. GUID

3546c8f7-3cd3-4693-929e-66501642504c

Ja


Active

Angir om ressurs er i aktiv bruk

true

Nei


ProvidedByReference

Referanse til Organisasjon


Ja


LocationReference

Referanse til lokasjon




Name

Navn på tjenesten slik det skal presenteres til innbygger

Reisevaksine

Ja


Comment

Beskrivelse av tjenesten.


Nei


Endpoint.Identifier

Her Id til kommunikasjonspart som skal benyttes for å nå tjeneste

129688

Ja

Organization

Identifier

Id til organisasjon. Organisasjonsnummer

948 554 062

Ja


Name

Navn på organisasjon

SiO Helse

Ja


Endpoint.Id

Her Id til virksomhet

1494

Ja

Location

Address.Line

Gatenavn og nummer

Holbergsgate 21

Ja


Address.City

Poststed

Oslo

Ja


Address.PostalCode

Postnummer

0314

Ja


Telecom.Value

Telefonnummer

22853300

Nei


Telecom.System

Type verdi

phone

Nei


Telecom.Value

Telefonnummer

wwww.sio.no

Nei


Telecom.System

Type verdi

url

Nei

Eksempel XML

Expand
titleEksempel XML for helsetilbud

<?xml version="1.0" encoding="utf-8"?>
<Bundle xmlns="http://hl7.org/fhir">
<id value="f23750979b6040bf94d4861184507864"/>
<type value="transaction"/>
<entry>
<resource>
<HealthcareService>
<id value="3546c8f7-3cd3-4693-929e-66501642504c"/>
<identifier>
<value value="3546c8f7-3cd3-4693-929e-66501642504c"/>
</identifier>
<active value="true"/>
<providedBy>
<!-- Virksomhet som leverer tjeneste, referanse til organisasjon -->
<reference value="Organization/Organisasjon1"/>
</providedBy>
<location>
<reference value="Location/Lokasjon1"/>
</location>
<name value="Reisevaksine"/>
<comment value="Reisevaksine til studenter og ansatte"/>
<endpoint>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.2"/>
<!-- Her ID nivå 2 -->
<value value="129688"/>
</identifier>
</endpoint>
</HealthcareService>
</resource>
<request>
<method value="PUT"/>
</request>
</entry>
<entry>
<resource>
<Location>
<id value="Lokasjon1"/>
<telecom>
<!-- Telefonnummer -->
<system value="phone"/>
<value value="22853300"/>
</telecom>
<telecom>
<!-- URL, er denne relevant? -->
<system value="url"/>
<value value="wwww.sio.no"/>
</telecom>
<address>
<!-- Besøksadresse til tjenesten -->
<line value="Holbergsgate 21"/>
<city value="Oslo"/>
<postalCode value="0314"/>
</address>
</Location>
</resource>
<request>
<method value="PUT"/>
</request>
</entry>
<entry>
<resource>
<Organization>
<id value="Organisasjon1"/>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.4.101"/>
<!-- Organisasjonsnummer -->
<value value="948554062"/>
</identifier>
<name value="SiO Helse"/>
<endpoint>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.2"/>
<!-- Her ID nivå 1 -->
<value value="1494"/>
</identifier>
</endpoint>
</Organization>
</resource>
<request>
<method value="PUT"/>
</request>
</entry>
</Bundle>

...

URL til de ulike miljøene i Helsenorge er vist i tabellen under.

Overføring av medlemsliste

...

Forespørsel vil være på formen https://<miljø>/ helsekontakter/api/<versjon>
Eksempel fra integrasjonstestmiljø https://eksternapi-hn-mas-02.int-hn.nhn.no/helsekontakter/api/v1

Attributt

Beskrivelse

Eksempel

Påkrevd

Identifier

Fødselsnummer/d-nummer til innbygger


Ja

Contact.Organization.Identifier

Organisasjonsnummer til virksomhet


Ja

Contact.period.Start

Startdato for når person mottar tjenester fra virksomhet


Ja

Contact.period.End

Sluttdato for når person mottar tjenester fra virksomhet


Ja

Eksempel XML

Et XML-eksempel er vist under.

...

Expand
titleRespons medlemsliste.

<Bundle xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir bundle.xsd">
<id value="1dd860e9-b812-4365-8305-ef889e4b55b6"/>
<type value="batch"/>
<entry>
<resource>
<Patient>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.4.1"/>
<!-- fødselsnummer -->
<value value="13116900216"/>
</identifier>
</Patient>
</resource>
<response>
<status value="201"/>
<!-- OK, Opprettet -->
</response>
</entry>
<entry>
<resource>
<Patient>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.4.1"/>
<!-- fødselsnummer -->
<value value="21016400952"/>
</identifier>
</Patient>
</resource>
<response>
<status value="404"/> <!-- Ikke OK, bruker 404 not found som respons -->
<outcome>
<OperationOutcome>
<issue>
<severity value="information"/>
<code value="not-found"/>
<details>
<text value="Ikke digitalt aktiv"/>
</details>
</issue>
</OperationOutcome>
</outcome>
</response>
</entry>
</Bundle>

Ikke funksjonelle krav

Type

Krav

Ytterligere kommentar

Ytelse

Responstid for overføring av helsetilbud skal være under 3 sekund for 99% av forespørsler

Ytelse

Responstid for overføring av medlemsliste skal være under 10 sekund for 99% av forespørsler

Ytelse

Timeout for overføring av medlemsliste er 15 sekund

Robusthet

Medlemssystem skal ha mekanismer for resending dersom Helsenorge ikke gir respons eller ikke er tilgjengelig

Feilhåndtering

Medlemssystem skal ha funksjonalitet for logging og overvåkning av feil

Feilhåndtering

Medlemssystem skal ha funksjonalitet for resending for å korrigere feil eller oppdatering av data.

Konfigurerbarhet

Medlemssystem skal ha funksjonalitet for konfigurere antall medlemmer som sendes i medlemsliste

Antall settes basert på ytelsestest og etter avtale. Anbefalt utgangspunkt er maks 50 per liste.

Robusthet

Helsenorge skal ha funksjonalitet for å validere maksstørrelse for antall medlemmer som sendes i medlemsliste

Respons fra helsenorge.no

Respons fra helsenorge.no skal være i henhold til FHIR standard og bruk av RESTful api beskrevet her: https://www.hl7.org/fhir/http.html

Responskode

Beskrivelse

200

OK. Oppdatert

201

OK. Opprettet

4xx

Feilkode i henhold til FHIR spesifikasjon

413

Payload too large