Johdanto

Tähän soveltamisoppaaseen on koostettu Kanta FHIR- ja REST-rajapintamäärittelyt, jotka koskevat useita eri Kanta-palveluita. Yksittäisten palveluiden palvelukohtaiset FHIR- ja REST-rajapintamäärittelyt, kuvaukset ja ohjeet löytyvät kunkin palvelun omista soveltamisoppaista.

Soveltamisopas koostuu seuraavista osista:

  • Johdanto
  • Kanta FHIR hyödyntäminen
  • Kanta FHIR-rajapinnan REST tarkennukset (HTTP header, JSON Web Token, HTTP body erilaisissa REST sanomissa, virhevastaukset, rajapintojen tietoturva)
  • Kanta FHIR sähköinen allekirjoitus (JSON Web Signature, JSON muotoisen datan sähköinen allekirjoitus)
  • Yhteiset FHIR artefaktit (profiilit, laajennokset, arvojoukot, koodistot, narratiiviohjeistukset)

Tämä soveltamisopas noudattaa "Kanta yhteiset FHIR- ja REST-rajapintamäärittelyt" projektin viimeisimpiä (current build) FHIR artefakteja ja niihin voin tulla muutoksia milloin tahansa. Sama koskee myös tämän soveltamisoppan sisältöä.

Jäädytetyt soveltamisoppaiden ja FHIR artefaktien versiot:

Yhteystiedot

FHIR-rajapinnan toteutukseen ja tähän oppaaseen liittyvät kysymykset voi laittaa sähköpostilla osoitteeseen kanta@kanta.fi.

Versiohistoria

Versionumero Päivämäärä Muutokset Tekijä
0.9 28.5.2024 Ensimmäinen julkaistu draft-versio Kela, Kanta-palvelut
0.9.1 15.10.2024 Tarkennettu sivua "Kanta rajapinnan virhevastaus" Kela, Kanta-palvelut
1.0.0-rc4 9.10.2025 Lisätty sivulle uusia FHIR artefakteja. Terminologiassa yleisesti huomioitavia asioita koodistojen käytöstä. Lisätty sivulle Kanta FHIR rajapinnan REST tarkennukset oma kohtansa Kanta FHIR rajapintojen tietoturva. Lisätty oma kohtansa FHIR narratiivien käytöstä. Kela, Kanta-palvelut
1.0.0-rc5 20.11.2025 Lisätty uudet profiilit MitatointiProvenanceV2 ja KantaOrganization. Lisätty ValueSet figen-vs-relatedpersonrole. Poistettu profiileista snaphsot-elementit. Kela, Kanta-palvelut
1.0.0-rc6 19.3.2026 Tätä versiota ei koskaan julkaistu. Kela, Kanta-palvelut
1.0.0-rc7 20.3.2026 Päivitetty seuraavia profiileja: Kanta Patient version 2 (muutettu identifier- ja name-elementit pakollisiksi, name-elementin sisällä given ja family on muutettu pakollisiksi), Kanta Patient Official (samat muutokset kuin Kanta Patient version 2), MitatointiProvenance2 (agent-rakenteeseen on lisätty slicet ServiceProvider ja SeviceDeliverer, lisätty agent Custodian (rekisterinpitäjä), lisäksi agent-rakenteen who-viittauksista on poistettu turhat profiiliviittaukset), KantaPractitionerV2 (muutettu name-elementti pakolliseksi ja elementin sisällä given ja family muutettu pakollisiksi). Kela, Kanta-palvelut
current/preview Lisätty uusi profiili: Kanta Organization V2, jossa sallittu telecom elementti ja identifier.system:iin tarkennettu, että profiilia voi käyttää myös rekisterinpitäjän ilmaisemiseen.

Päivitetty seuraavia profiileja:
Kanta Patient V2: lisätty name.use tietoon official fiksaus mutta jätetty use:n optionaaliseksi eli voi antaa edelleen ilman use tietoa mutta jos antaa use:n niin vain official sallittu.
Kanta mitätöinti Provenance V2: poistettu meta.profile:sta fiksaus profiilin url:iin, jotta profiilia voi käyttää tarkempien profiilien pohjana.
Kanta Practitioner V2: poistettu meta.profile:sta fiksaus profiilin url:iin, jotta profiilia voi käyttää tarkempien profiilien pohjana. Lisätty name.use tietoon official fiksaus mutta jätetty use:n optionaaliseksi eli voi antaa edelleen ilman use tietoa mutta jos antaa use:n niin vain official sallittu.
KantaRelatedPerson: poistettu meta.profile:sta fiksaus profiilin url:iin, jotta profiilia voi käyttää tarkempien profiilien pohjana.
Kanta Patient: lisätty rajoite (constraint), joka kieltää virallisen henkilötunnuksen system-osan käytön tilapäinen henkilötunnuksen kanssa. Tämä muutos periytyy myös Kanta Patient V2 profiiliin.

Lisätty geneeriset kuvaukset REST tallennus-, versiointi-, mitätöinti- ja hakusanomista sekä näiden vastaussanomista.		 Kela, Kanta-palvelut