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

Lähderajapinta

Ydin UNA vaatii FHIR-järjestelmiltä tässä kuvatun FHIR-lähdejärjestelmärajapinnan.

Ydin hakee lähdejärjestelmästä tiedot Bundle-rakenteena.

Ydin lähdejärjestelmärajapinta noudattaa FHIR R4 standardia eli versiota 4.0.1.

Tietohaun pyyntösanoma

Alla esimerkki pyyntösanomasta.

x-api-key: api-avain
Content-Type: application/x-www-form-urlencoded
POST /_search

SSNRoot=1.2.246.21&SSNValue=160884-927B

Ydin välittää järjestelmän API-avaimen x-api-key headerissa. Content-Type header saa arvon application/x-www-form-urlencoded

nimi tyyppi tietotyyppi kuvaus
SSNRoot pakollinen pyynnön runko Henkilötunnuksen antaneen järjestelmän yksilöivä tunniste
SSNValue pakollinen pyynnön runko Asiakkaan henkilötunnus

Pysyvän henkilötunnuksen tapauksessa SSNRoot on 1.2.246.21

Tietohaun vastaussanoma

Ydin odottaa vastauksena FHIR Bundle-resurssia. Vastaus on JSON muodossa.

Bundle - FHIR

Rajapinnasta voidaan palauttaa kaikkia FHIR-resursseja. Tällä hetkellä ydin osaa käsitellä vain tässä listattuja resursseja:

  • Appointment
  • Condition
  • Encounter
  • Organization
  • Patient
  • QuestinnaireResponse

Ytimeen toteutetaan sivutus myöhemmin FHIR Search -standardin mukaisesti.

Extensions

Ytimen FHIR malli sisältää 6 kpl FHIR Extension-määrittelyä.

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.

FHIR-Lähdejärjestelmän metadatan pyyntösanoma

Alla esimerkki järjestelmän metatietojen pyyntösanomasta.

x-api-key: api-avain
GET /metadata

Myös metadataa hakiessaan Ydin välittää järjestelmän API-avaimen x-api-key headerissa.

FHIR-Lähdejärjestelmän metadatan vastaussanoma

Lähdejärjestelmä palauttaa metadatansa json-sanomana joka koostuu FHIR CapabilityStatement-resurssista.