eksempler.md

- OBS! Dokumentasjonen til Pasientens Prøvesvar (NILAR) har blitt flyttet til UtviklerPortalen

Utviklerportalen

Dette dokumentet eksisterer kun for historikk, og vil ikke bli oppdatert!

Eksempler på kall mot NILAR API (TEST-miljøer)

Denne siden viser eksempler på API kall mot NILAR.
Forebehold om at NILAR er under utvikling og eksemplene ikke nødvendigvis er up-to-date.

NOTE: Dette er et utvalg av eksempelspørringer for å understøtte utviklere i oppstartsfasen. Se Nilar sin FHIR profil på HL7 Github.

Sist oppdatert 06.01.2023

Basic

BaseURL

Nilar eksponerer to endepunkter for test slik at det er mulig å implementere mot løsningen uten Helse-ID token.
I produksjon er kun endepunkt 2 tilgjengelig.

Endepunkt 1 (forbigå proxy - uten Helse-ID) - https://test.nilar.nhn.no/fhir/

Endepunkt 2 - https://test.nilar.nhn.no/

Headers for Endepunkt 1

NOTE: Headers gjelder ikke for /metadata.

Nilar (forbigå proxy) headers
x-nilar-patient med pasient sitt fnr x-nilar-requester med requester sitt fnr/hpr,
x-nilar-reason med samtykkekode - default 0,
x-nilar-correlation-Id - helst guid,

Headers for Endepunkt 2

Nilar (via proxy) krever headers
person-id med pasient sitt fnr,
Authorization med helse-id token
Grunnlag med samtykkekode - default 0,

Body

x-www-form-urlencoded

Metadata

GET BaseURL/metadata

body tom

Eksempler

A. RessursType

B. Spesifikk ressurs

C. Skip og count

D. Include med relaterte ressurser

E. Dato og datointervall

F. Søk på Meta Tag

G. DiagnosticReport med tilhørende ServiceRequest

H. PractitionerRole for DiagnosticReport

A. RessursType

A.1. Format

POST {baseUrl}/{resourceType}/_search

body tom

A.1.1. Eksempel Endepunkt 1 - Alle DiagnosticReport for Gry Telokk utenfor proxy

POST https://test.nilar.nhn.no/fhir/DiagnosticReport/_search

header X-Nilar-Patient: 12057900499

body tom

A.1.2. Eksempel Endepunkt 2 - Alle Observation for Gry Telokk via proxy

POST https://test.nilar.nhn.no/Observation/_search

header Person-Id: 12057900499

header Authorization: Bearer token

body tom

B. Spesifikk ressurs

B.1. Format

POST {baseUrl}/{resourceType}/_search

body _id: {guid}

B.1.1. Eksempel Endepunkt 1 - Spesifikk Specimen for Gry Telokk utenfor proxy

POST https://test.nilar.nhn.no/fhir/Specimen_search

header X-Nilar-Patient: 12057900499

body _id: guid

B.1.2. Eksempel Endepunkt 2 - Spesifikk DiagnosticReport for Gry Telokk via proxy

POST https://test.nilar.nhn.no/DiagnosticReport/_search

header Person-Id: 12057900499

header Requester-Id: hpr-nummer eller string

header Authorization: Bearer token

body _id: guid

C. Skip og count

C.1. Format

POST {baseUrl}/{resourceType}/_search

body _count: {count} + _skip: {skip}

C.1.1. Eksempel Endepunkt 1 - Hopp over 50 DiagnosticReport og vis 10 for Gry Telokk utenfor proxy

POST https://test.nilar.nhn.no/fhir/DiagnosticReport/_search

header X-Nilar-Patient: 12057900499

body _count: 10 + _skip: 50

NOTE: "Total" vil fortsatt vise totalt antall DN for Gry Telokk. "Link>Self" vil reflektere spørringen. "Link" kan brukes til å navigere gjennom ressursene.

D. Include med relaterte ressurser

D.1. Format

POST {baseUrl}/{resourceType}/_search

body _include: {relation}

D.1.1. Eksempel Endepunkt 1 - Alle DN for Gry Telokk med tilhørende Specimen utenfor proxy

POST https://test.nilar.nhn.no/fhir/DiagnosticReport/_search

header X-Nilar-Patient: 12057900499

body _include: DiagnosticReport:specimen

E. Dato og datointervall

Støtter modifiers eq, lt og gt, se: https://www.hl7.org/fhir/search.html#modifiers

E.1. Format Dato

POST {baseUrl}/{resourceType}/_search

body date: {modifier}{dato}

E.2. Format Datointervall

POST {baseUrl}/{resourceType}/_search

body date: gt{dato} + date: lt{dato}

E.2.1 Eksempel Endepunt 1 - Alle Observations for Gry Telokk i en fem dagers periode i 2017

POST https://test.nilar.nhn.no/fhir/Observation/_search

header X-Nilar-Patient: 12057900499

body date: gt2017-09-20 + date: lt2017-09-24

F. Søk på Meta Tag

F.1. Format

POST {baseUrl}/{resourceType}/_search

body _tag: {code}

F.1.1 Eksempel Endepunkt 1 - Søk på Observasjoner for Gry Telokk som inneholde Meta Tag "Funn og undersøkelsesresultater"

POST https://test.nilar.nhn.no/fhir/Observation/_search

header X-Nilar-Patient: 12057900499

body _tag: FU

G. DiagnosticReport med tilhørende ServiceRequest

G.1. Format

POST {baseUrl}/DiagnosticReport/_search

body _id : guid

body _include : DiagnosticReport:based-on

H. PractitionerRole for DiagnosticReport

H.1. Format

POST {baseUrl}/DiagnosticReport/_search

body _id : guid

body _include : DiagnosticReport:based-on

body _include:iterate : ServiceRequest:requester