Versions Compared

Old Version 12

changes.mady.by.user sven.christiansen

Saved on

compared with

New Version Current

changes.mady.by.user kjetill.vassmo.lund

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
Page Properties

API-navn

FHIR timenotifikasjon

Funksjonelt område

Timeavtaler

API-versjon og dato publisert

v1

Status

Status
colourGreen
titleI Drift

API-dokumentasjon sist endret

Teknologi

Status
colourRed
titleFHIR

API'ets formål

Timenotifikasjon gir mulighet til å sende innbygger en notifikasjon om ny eller endret avtale. Eksterne aktører kan anvende Helsenorge's FHIR-endepunkt for å levere/synkronisere basisinformasjon om avtaler til innbyggere som er aktive på Helsenorge.

Helsenorge er ikke kildesystem for disse timene og i første omgang vil ikke Helsenorge tilby et endepunkt som støtter spørring/uthenting av timeinformasjonen som er lagret. Avsender/kildesystemet må dermed holde status på oversendte timer, og eventuelt overføre timenotifikasjoner på nytt hvis det er tvil om timer er synkronisert eller en innbygger blir digitalt aktiv. Helsenorge sitt endepunkt vil vite om innslaget er ny time (ikke sett før), en allerede overført time som har blitt endret siden sist overføring, eller identisk time (ingen endringer siden sist overføring), og vil kun varsle innbygger om relevante endringer.

Hvordan benytte API'et

Type API

REST

Miljøer

Struktur på URL'er: https://<miljø>/timeavtaler-fhir/api/<versjon>/Appointment

Oversikt over tilgjengelige miljøer finnes her: Testmiljøer og endepunkter

Metoder og parametre til endepunktet

En liste over hvilke metoder som kan brukes til endepunktet, samt tabeller som sier hvilke parametre med tilhørende gyldige verdier som kan brukes pr metode. Beskriv også hva den enkelte metode generelt vil gi i respons når den brukes på endepunktet og når den brukes med ulike parametre.

PUT

Innholdet (body) må være av typen FHIR Appointment.

Dette er FHIR-profilene som benyttes på Helsenorge:

Timenotifikasjon - ny nasjonal timeløsningFHIR v0.9 : Brukes ifm integrasjon mot Helseplattformen/Epic

Expand
titleFHIR-ressurser

FHIR-ressurser

Dette er de ressursene som benyttes i Timenotifikasjon:

https://www.hl7.org/fhir/appointment.html

https://www.hl7.org/fhir/location.html

https://www.hl7.org/fhir/organization.html

https://www.hl7.org/fhir/patient.html

https://www.hl7.org/fhir/practitioner.html

Headeren If-None-Exist, sammen med en søkeparameter, må legges ved PUT-kallet. Dette sikrer støtte for både opprettelse og endring av timer. Vi støtter ikke PUT uten denne headeren eller POST.

Code Block
identifier=no-citizenportal-client|klientnavn&identifier=no-citizenportal-sourcesystem|systemnavn&identifier=no-citizenportal-instanceidentifier|timeidentifikator&participant.actor:Patient=urn:oid:2.16.578.1.12.4.1.4.1|fødselsnummer


Eksempel Request

Expand
titleExample request
Code Block
<Appointment xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="http://ehelse.no/fhir/StructureDefinition/hn-primary-appointment" />
    </meta>
    <contained>
        <Location>
            <meta>
                <profile value="http://ehelse.no/fhir/StructureDefinition/hn-primary-appointment_containedlocation" />
            </meta>
            <id value="containedLocation" />
            <address>
                <!-- Oppmøtested -->
                <text value="Skiringssalveien 20, Sandefjord" />
            </address>
        </Location>
    </contained>
    <contained>
        <Organization>
            <meta>
                <profile value="http://ehelse.no/fhir/StructureDefinition/hn-primary-appointment_containedorganization" />
            </meta>
            <id value="containedOrganization"/>
            <identifier>
                <!-- Tjeneste-identifiaktor - HER-id nivå 2 = -->
                <system value="urn:oid:2.16.578.1.12.4.1.2" />
                <value value="1494" />
            </identifier>
            <!-- Visningsnavn tjeneste -->
            <name value="Allmen tannlege"/>
            <partOf>
                <type value="Organization" />
                <identifier>
                    <!-- Organisasjonsnummer -->
                    <system value="urn:oid:2.16.578.1.12.4.1.4.101" />
                    <value value="948554062" />
                </identifier>
                <!-- Visningsnavn organisasjon -->
                <display value="Sio Helse"/>
            </partOf>
        </Organization>
    </contained>
    <contained>
        <Practitioner>
            <meta>
                <profile value="http://ehelse.no/fhir/StructureDefinition/hn-primary-appointment_containedpractitioner" />
            </meta>
            <id value="containedPractitioner"/>
            <name>
                <family value="Careful"/>
                <given value="Adam"/>
                <prefix value="Dr"/>
            </name>
        </Practitioner>
    </contained>
    <extension url="http://ehelse.no/fhir/StructureDefinition/hn-primary-appointment_extension-communicationoptions">
        <extension url="Cancel">
            <valueBoolean value="true" />
        </extension>
        <extension url="CancelTimeUntil">
            <valueDateTime value="2019-08-01T08:00:00+02:00" />
        </extension>
    </extension>
    <identifier>
        <system value="http://ehelse.no/fhir/CodeSystem/no-citizenportal-instanceidentifier" />
        <value value="203" />
    </identifier>
    <identifier>
        <system value="http://ehelse.no/fhir/CodeSystem/no-citizenportal-sourcesystem" />
        <value value="16-3fb9c0f4-1d9b-44b6-8d64-d36820115274" />
    </identifier>
    <identifier>
        <system value="http://ehelse.no/fhir/CodeSystem/no-citizenportal-client" />
        <value value="Opus" />
    </identifier>
    <!-- booked/cancelled/entered-in-error -->
    <status value="booked" />
    <serviceCategory>
        <coding>
            <system value="http://hl7.org/fhir/ValueSet/service-category" />
            <code value="10" />
            <display value="Dental" />
        </coding>
    </serviceCategory>
    <appointmentType>
        <coding>
            <system value="urn:oid:2.16.578.1.12.4.1.1.7617" />
            <code value="Ordinær" />
            <display value="Ordinær time" />
        </coding>
    </appointmentType>
    <!-- Timens emne/subject -->
    <description value="Oppfølging av kontrolltime" />
    <supportingInformation>
        <type value="Organization" />
        <reference value="#containedOrganization" />
    </supportingInformation>
    <supportingInformation>
        <type value="Location" />
        <reference value="#containedLocation" />
    </supportingInformation>
    <start value="2019-08-03T08:00:00+02:00" />
    <end value="2019-08-03T08:30:00+02:00" />
    <!-- Timens beskrivelse -->
    <patientInstruction value="Husk å utføre forberedelsene til timen før oppmøtet." />
    <slot>
        <type value="Slot" />
        <identifier>
            <system value="urn:ietf:rfc:3986" />
            <value value="c12cc3a3-56cd-4c1d-afbe-24620f6c2a94" />
        </identifier>
    </slot>
    <participant>
        <actor>
            <type value="Patient" />
            <identifier>
                <!-- FNR/d-nummer -->
                <system value="urn:oid:2.16.578.1.12.4.1.4.1" />
                <value value="13116900216" />
            </identifier>
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
    <participant>
        <actor>
            <type value="Practitioner" />
            <reference value="#containedPractitioner" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
</Appointment>

Eksempel Response

Se Responskoder.

Swagger

Sett inn link til Swagger-dokumentasjon.

Autentisering

Token: Uthenting av token gjøres fra STS, for informasjon se: 01 - System til System - V2 . For bruk av aksesstoken i etterfølgende kall se: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+API+er+og+bruk+av+AcessToken

Offentlig sertifikat kan anvendes for avsender til å validere tokenet fra Helsenorge sin STS-tjeneste.
Eksempel for mas-02: https://eksternapi-hn-mas-02.int-hn.nhn.no/sts/oidcprov/v3/jwk

Endepunktet har krav om at aktøren som utfører spørringen har sikkerhetsbillett/token utstedt fra Helsenorge sin STS-tjeneste.  I tillegg må timens verdi for identifikator no-citizenportal-client stemme overens med client_name i sikkerhetsbilletten (client_name-verdien settes når tilgangen opprettes i STS), se kapittel "Respons fra helsenorge.no" - "Sjekk av kildesystem" under.

Code Block
Legg inn eksempel på kode for hvordan man gjør autentiseringen

Autorisering

For å kunne kalle endepunktet så behøves et token utstedt fra vår STS, med scope "avtaler".

  • Token mangler eller ikke er gyldig

    • lagres ikke på Helsenorge

    • HTTP 401 (unauthorized) og OperationOutcome 

      • issue.severity = fatal

      • issue.Code = forbidden

      • issue.details.text = beskrivelse av feilen

Code Block
<OperationOutcome>
    <issue>
        <severity value="fatal"/>
        <code value="forbidden"/>
        <details>
            <text value="Not authorized to access this end point"/>
        </details>
    </issue>
</OperationOutcome>



Terms and Conditions

Vilkår og betingelser for bruk av API'et kan finnes her: Vilkår og betingelser for bruk av APIer og kommunikasjonsprosesser

Begrensninger

Ved behov for større datamigreringer skal Helsenorge varsles i forkant og tidspunkt avtales via kundesenter@nhn.no

Quick Start på å jobbe mot endepunktet

Eksempel på hvordan raskt komme i gang med bruk av API'et, feks med Postman eller lignende. Inkluder også eksempel på en enkel request og response:

  1. Kontakt NHN og få autentisering

  2. Last ned Postman

  3. Send request som vist under

Code Block
Request

  1. Motta respons som vist under

Code Block
Response

  1. Du er tilkoblet endepunktet.

Responskoder

Beskriv her hvilke feilmeldinger brukeren kan få og hva de betyr

Kode

Beskrivelse

200

OK. Oppdatert

201

OK. Opprettet

4xx

Feilkode i henhold til FHIR spesifikasjon 

Valideringer

Sjekk av innhold

Expand
titleSjekk av innhold

Ved mottak av timenotifikasjoner verifiseres det at at Appointment-objektet inneholder den påkrevde FHIR-informasjonen, timeobjektet må ha status booked, cancelled eller entered-in-error.

  • Innhold validerer ikke

    • lagres ikke på Helsenorge

    • HTTP 400 (bad request) og OperationOutcome 

      • issue.severity = fatal

      • issue.Code = structure/required/invariant (se issue type)

      • issue.details.text = beskrivelse av feilen

Structure - A structural issue in the content such as wrong namespace, unable to parse the content completely, invalid syntax, etc.

Expand
titleUnable to parse content
Code Block
<OperationOutcome>
    <issue>
        <severity value="fatal"/>
        <code value="structure"/>
        <details>
            <text value="Unable to parse the content"/>
        </details>
    </issue>
</OperationOutcome>
Expand
titleRequired elements are missing
Code Block
<OperationOutcome>
    <issue>
        <severity value="fatal"/>
        <code value="required"/>
        <details>
            <text value="Required element(s) are missing"/>
        </details>
    </issue>
</OperationOutcome>
Expand
titleA content validation rule failed
Code Block
<OperationOutcome>
    <issue>
        <severity value="fatal"/>
        <code value="invariant"/>
        <details>
            <text value="A content validation rule failed"/>
        </details>
    </issue>
</OperationOutcome>

Sjekk av kildesystem

Expand
titleSjekk av kildesystem

Avsendersystem får kun lagre timenotifikasjoner som tilhører sitt kildesystem. Kildesystem er definert av Appointment.identifier-verdien no-citizenportal-client, som må matche med klientnavnet (client_name) som aktøren er registrert med i Helsenorge STS.

  • Kildesystem matcher ikke registrert systemnavn

    • lagres ikke på Helsenorge

    • HTTP 403 (forbidden) og OperationOutcome 

      • issue.severity = fatal

      • issue.Code = forbidden

      • issue.details.text = beskrivelse av feilen

Expand
titleNot allowed to generate appointments
Code Block
<OperationOutcome>
    <issue>
        <severity value="fatal"/>
        <code value="forbidden"/>
        <details>
            <text value="Not allowed to generate appointments for the defined no-citizenportal-client"/>
        </details>
    </issue>
</OperationOutcome>

Versjonering og endringer