UNA FHIR rajapintaopas
1.0 - active

UNA FHIR rajapintaopas - Local Development build (v1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Käyttörajapinta

Johdanto

Ytimen FHIR-käyttörajapinnan kautta on mahdollista noutaa potilaan FHIR-resursseja, jotka on noudettu osana tiettyä hakukontekstia.

Tekninen yleiskuvaus

FHIR-käyttörajapinta on julkaisu REST-rajapintana, jolta voi pyytää noudettuja FHIR-resursseja Search-kutsulla.

Ennen FHIR-käyttörajapintakutsua hakukonteksti täytyy alustaa hakukontekstin alustusrajapinnalla.

Hakukonteksti voidaan vaihtoehtoisesti alustaa käyttämään kansalaisen kirjautumista.

UNA Ydin OpenAPI-käyttörajapinnat - pyyntösanoma

Käyttörajapinnan tarjoamat palvelut

Tällä hetkellä käyttörajapinta tarjoaa seuraavat REST-palvelut.


Hakukontekstilla noudettujen FHIR-resurssien haku

GET /api/v1/CustomerData/Fhir/Search/{searchContextId}?_lastUpdated={lastUpdated} (Hakee kaikki hakukontekstilla noudetut FHIR-resurssit)

GET /api/v1/CustomerData/Fhir/Search/{searchContextId}/{_type}/?_lastUpdated={lastUpdated} (Hakee kaikki hakukontekstilla noudetut ja _type - polkuparametrin määrittämät FHIR-resurssit)

GET /api/v1/CustomerData/Fhir/Citizen/Search/{searchContextId}/{_type}/?_lastUpdated={lastUpdated} (Hakee kaikki kansalaisen hakukontekstilla noudetut ja _type - polkuparametrin määrittämät FHIR-resurssit)

Parametrit

cURL-esimerkkikutsuissa käytetään seuraavia parametreja:

nimi tyyppi tietotyyppi kuvaus
searchContextId pakollinen polkuparametri Hakukontekstin tunniste
_type valinnainen polkuparametri ​FHIR-resurssityypin tunniste. (Katso tuetut FHIR-resurssit) Jos tälle ei anneta ei-tyhjää arvoa, palauttaa rajapinta kaikentyyppiset FHIR-resurssit.
sessionId pakollinen http-otsikkotieto (header) UNA-istunnon tunniste. Annetaan Bearer Authentication -muodossa.
_lastUpdated valinnainen kyselymerkkijonoparametri Aikarajaus tyyppiä date . Aikarajauksen peruste on tiedon latausaika Ytimeen
x-api-key pakollinen http-otsikkotieto (header) Ympäristön vaatima avain. Ei välity FHIR-rajapinnalle.
Tuetut FHIR-resurssityypit
nimi kuvaus
Appointment FHIR Appointment resurssi.
QuestionnaireResponse FHIR QuestionnaireResponse resurssi.
Vastaukset
http status content-type vastaus
200 application/json;charset=UTF-8 { "resourceType": "Bundle", "type": "searchset", "total": 2,"entry": [...] }
500 application/json {"code":"500","message":"Bad Request"}

Vastauksen HTTP-status 200 merkitsee onnistunutta hakua.

cURL-esimerkkejä
  • Hakee UNA-istunnon eb17442075c34ef99aa030a25ad796af hakukontekstilla 42b77e48-42fc-4637-8c75-4b5dc5c344ba ajanhetkien 2023-04-15T11:14:50 ja 2023-04-16T11:14:50 välillä noudetut FHIR tiedot:
 curl --location 'https://api.dev.ydin.unaoy.fi/customers-nrm/api/v1/CustomerData/Fhir/Search/42b77e48-42fc-4637-8c75-4b5dc5c344ba?_lastUpdated=gt2023-04-15T11%3A14%3A50&_lastUpdated=lt2023-04-16T11%3A14%3A50' --header 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --header 'Authorization: Bearer eb17442075c34ef99aa030a25ad796af'
  • Hakee UNA-istunnon eb17442075c34ef99aa030a25ad796af hakukontekstilla 42b77e48-42fc-4637-8c75-4b5dc5c344ba ennen ajanhetkeä 2023-04-16T11:14:50 noudetut FHIR tiedot:
 curl --location 'https://api.dev.ydin.unaoy.fi/customers-nrm/api/v1/CustomerData/Fhir/Search/42b77e48-42fc-4637-8c75-4b5dc5c344ba?_lastUpdated=lt2023-04-16T11%3A14%3A50' --header 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --header 'Authorization: Bearer eb17442075c34ef99aa030a25ad796af'
  • Hakee UNA-istunnon eb17442075c34ef99aa030a25ad796af hakukontekstilla 42b77e48-42fc-4637-8c75-4b5dc5c344ba ajanhetken 2023-04-15T11:14:50 jälkeen noudetut FHIR tiedot:
 curl --location 'https://api.dev.ydin.unaoy.fi/customers-nrm/api/v1/CustomerData/Fhir/Search/42b77e48-42fc-4637-8c75-4b5dc5c344ba?_lastUpdated=gt2023-04-15T11%3A14%3A50' --header 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --header 'Authorization: Bearer eb17442075c34ef99aa030a25ad796af'
  • Hakee kaikki UNA-istunnon eb17442075c34ef99aa030a25ad796af hakukontekstilla 42b77e48-42fc-4637-8c75-4b5dc5c344ba noudetut FHIR tiedot:
 curl --location 'https://api.dev.ydin.unaoy.fi/customers-nrm/api/v1/CustomerData/Fhir/Search/42b77e48-42fc-4637-8c75-4b5dc5c344ba' --header 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --header 'Authorization: Bearer eb17442075c34ef99aa030a25ad796af'
  • Hakee kaikki UNA-istunnon eb17442075c34ef99aa030a25ad796af hakukontekstilla 42b77e48-42fc-4637-8c75-4b5dc5c344ba noudetut FHIR-Appointment tiedot:
 curl --location 'https://api.dev.ydin.unaoy.fi/customers-nrm/api/v1/CustomerData/Fhir/Search/42b77e48-42fc-4637-8c75-4b5dc5c344ba/Appointment' --header 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --header 'Authorization: Bearer eb17442075c34ef99aa030a25ad796af'
  • Hakee kaikki kansalaisen UNA-istunnon eb17442075c34ef99aa030a25ad796af hakukontekstilla 42b77e48-42fc-4637-8c75-4b5dc5c344ba noudetut FHIR-Appointment tiedot:
 curl --location 'https://api.dev.ydin.unaoy.fi/customers-nrm/api/v1/CustomerData/Fhir/Citizen/Search/42b77e48-42fc-4637-8c75-4b5dc5c344ba/Appointment' --header 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --header 'Authorization: Bearer eb17442075c34ef99aa030a25ad796af'

Käyttörajapinnan vastaussanomat

FHIR-käyttörajapinta vastaa JSON-sanomalla, joka koostuu FHIR Bundle-tietueesta. Esimerkki tällaisesta rajapinnan vastaussanomasta löytyy tiedostosta FHIR_questionnaire_response_bundle.json ja tiedostosta FHIR_pregnancy_bundle.json.

Vastaussanoman sisältämät extension-tiedot

Mallivastaussanoma sisältää esitietolomakkeen vastauksen, joka löytyy erikseen tiedostosta FHIR_questionnaire_response. Vastaussanoma sisältää extension-tietoja, joita FHIR-käyttörajapinta käyttää tietojen luovutuslupiin perustuvassa suodatuksessa.

Nimi Kuvaus
UNAMetadataIsPersonalData

Ilmaisee, onko kyseessä asiakkaan oma tieto

UNAMetadataPersonalDataAreaOfOperation

ilmaisee asiakkaan oman tiedon toimialueen.

  • Healthcare (terveydenhuolto)
  • SocialServices (sosiaalihuolto)
UNAMetadataRegistryOwnerOid

Ilmaisee ammattilaisen tiedon rekisterinpitäjän

UNAMetadataRegistryType

ilmaisee ammattilaisen datan rekisterityypin. Tästä voidaan päätellä tietojen toimialue.

  • PublicHealthcare → terveydenhuolto
  • PrivateHealthcare → terveydenhuolto
  • OccupationalHealthcare → terveydenhuolto
  • OccupationalDocuments → terveydenhuolto
  • CustomerRegistry → sosiaalihuolto
  • NotificationRegistry → sosiaalihuolto
UNAMetadataServiceEventOid

ilmaisee ammattilaisen datan palvelutapahtuman.

UNAMetadataServiceProviderOid

Ilmaisee ammattilaisen datan palveluntarjoajan, josta voidaan päätellä hyvinvointialue.

UNAMetadataSourceSystem

Ilmaisee lähdejärjestelmän josta tieto on haettu.