SOTKAnetin avoin rajapinta

Transcription

SOTKAnetinavoinrajapinta
Johdantojakäyttöehdot
Terveyden ja hyvinvoinnin laitoksen (THL) ylläpitämän Tilasto- ja indikaattoripankki SOTKAnetin metatiedot ja
tietosisältö on ladattavissa ja hyödynnettävissä avoimen rajapinnan kautta. SOTKAnetin rajapintaa saa käyttää
muiden järjestelmien tietopohjana. Rajapinnan kautta metatiedot ovat saatavissa JSON-, JSONP- ja RDFmuodoissa. Tilasto- ja indikaattoritiedot ovat saatavissa CSV-muodossa. Kaikki metatieto tarjotaan aina
kolmikielisenä: suomeksi, ruotsiksi ja englanniksi.
Alueiden ja indikaattorien kuvailutieto julkaistaan Creative Commons Attribution 4.0 –lisenssin
(http://creativecommons.org/licenses/by/4.0/) mukaisesti. Myös THL:n tuottamat indikaattorit (tilastotiedot ja
metatiedot) julkaistaan Creative Commons Attribution 4.0 –lisenssin mukaisesti.
Muiden kuin THL:n tuottamia tilastotietoja ja indikaattoreita saa käyttää vain ja ainoastaan erillisen sopimuksen
mukaisesti. Erillisessä sopimuksessa osapuolina ovat rajapinnan käyttäjä ja aineiston tuottaja. THL toivoo, että
sopimus tuodaan THL:lle tiedoksi.
Creative Commons Attribution 4.0 –lisenssin mukaisesti rajapinnan kautta saatua aineistoa käytettäessä on
mainittava lähteenä Terveyden ja hyvinvoinnin laitos ja SOTKAnet sekä tarjottava linkki osoitteeseen
http://www.sotkanet.fi. Kunkin aineiston osalta on mainittava erikseen tilaston tai indikaattorin tuottajataho.
THL ei vastaa rajapintaa käyttävien sovellusten toiminnasta. THL tuottaa rajapinnan sellaisenaan ilman takuita.
Rajapintaa käytetään omalla vastuulla.
Rajapinta on saatavilla julkisesti verkossa osoitteessa http://www.sotkanet.fi/rest. Tässä dokumentissa kuvataan
rajapinnan hyväksymät kyselyt ja niiden tuottamat vastaukset.
Käyttötarkoitus
SOTKAnet REST API on tarkoitettu tietojen noutamiseen erissä niiden jatkokäyttöä varten eri sovelluksissa.
Rajapintaa ei ole tarkoitettu suoraan, online käyttöön.
Muutokset
Rajapinnat voivat muuttua määritellystä. Muutokset voivat olla
* Virhekorjauksia - rajapintakutsut pysyvät ennallaan, vanhaa versiota ei enää voi käyttää, sillä korjaus tehdään
ilman versionumeromuutosta
* Täydennyksiä tietosisältöön - rajapintakutsut pysyvät ennallaan, vastauksiin lisätään uusia kenttiä, vanhaa
versioita ei voi enää käyttää, sillä täydennys tehdään ilman versionumeromuutosta
* Täydennyksiä palvelukutsuun - rajapintakutsut määritellään uudelleen siten, että eri versiot erotetaan
versionumerolla. Vanhaa versiota voi käyttää, sillä täydennyksen yhteydessä versionumero muutetaan
* Uusia palveluita - ei vaikuta vanhoihin palvelukutsuihin.
* Täydennyksiä oikeushallintaan - rajapintakutsut määritellään uudelleen siten, että eri versiot erotetaan
versionumerolla. Vanha versio poistetaan käytöstä
Muutosten yhteydessä rajapinnan tulokset tarkistetaan JSONLint-palvelun http://jsonlint.com ja W3C RDF
Validation Servicen http://www.w3.org/RDF/Validator avulla.
Palvelulaatu
Rajapinta on käytössä jatkuvasti. Virhetilanteissa tai rajapinnan ollessa saavuttamattomissa, THL korjaa virheen
tai käynnistää palvelun uudestaan virka-ajan puitteissa 8-15:45. THL ei järjestä varahenkilöitä rajapinnan
ylläpitoon lomatilanteissa. THL voi määrittelemänänsä hetkenä käynnistää palvelun uudelleen tai sammuttaa
sen huoltokatkoa varten.
Huoltokatkoista ja muista suunnitelluista katkoista pyritään tiedottamaan SOTKAnetin kautta. Käyttökatkoista ei
ilmoiteta suoraan rajapinnan käyttäjille.
Palvelut
Kustakin palvelusta kuvataan sen kutsuosoite, kutsutapa, parametrin, vastaus sekä vastausesimerkki.
Palveluiden URI määritellään suhteessa palvelun juureen esim. [http://www.sotkanet.fi/rest]. Rakenteiset kentät
kuvataan pistenotaatiolla siten, että piste erottaa tarkemman tason yleinen.tarkempi.tarkin esim. title.fi. Kenttien
ja parametrien arvojoukot on kuvattu säännöllisinä lausekkeina, mikäli mahdollista.
Poikkeuksia arvomäärittelyssä
* Nimike - tarkoittaa JSON-oliota { "fi": "arvo suomeksi", "sv": "arvo ruotsiksi", "en": "arvo englanniksi" }
* Taulukko - tarkoittaa JSON-taulukkoa alkio_1, alkio_2, ..., alkio_n
* Olio - tarkoittaa JSON-oliota { "avain_1" : "arvo_1", "avain_2" : "arvo_"", ..., "avain_n" : "arvo_n" }
* yyyy-MM-dd - tarkoittaa aikaleimaformaattia, jossa yyyy on vuosi neljällä merkillä, MM on kuukausi kahdella
merkillä ja dd kuukauden päivä kahdella merkillä
Palveluiden kautta saatavat käsitteet ja niiden suhteet ovat kuvattu alla olevassa kuvassa.
Palvelujen vastaukset käyttävät UTF-8 merkistökoodausta.
Palveluja käytettäessä on otettava huomioon, että mikä tahansa vapaata tekstiä sisältävä kenttä voi sisältää
HTML-merkintöjä esimerkiksi , <ul> ja HTML-entityjä esimerkiksi –  .
Aluelistaus
SOTKAnetistä saadaan listaus kulloinkin voimassa olevista alueluokituksista ml. kunnat, maakunnat,
aluehallintovirastot, läänit, sairaanhoitopiirit, Euroopan maat ym. Aluelistauksessa alueet on pyritty yhdistämään
ONKI-palvelimella sijaitsevaan kunnat-ontologiaan, jonka kautta alueesta saa lisää tietoja.
Huom\! SOTKAnetissä kuntajakoa ei päivitetä vastaamaan kuluvan vuoden kuntajakoa välittömästi vuoden
vaihteen yhteydessä. Kuntajako ja muut aluejako muutokset päivitetään järjestelmään kevään aikana.
Osoitteet
URI
Metodi
Vastaustyyppi
Huomiot
/1.1/regions
GET
JSON
Listaa kaikki SOTKAnetissa määritellyt alueet
/1.1/ jsonp/regions
GET
JSONP
Listaa kaikki SOTKAnetissä määritellyt alueet
/1.1/rdf/regions
GET
RDF/XML
Listaa kaikki SOTKAnetissä määritellyt alueet
Parametrit
Ei parametreja
Vastaus (JSON)
Vastaus on JSON-muotoinen taulukko
Kenttä
Arvo
Selite
id
^\d+$
Alueen surrogaattitunnus, jota käytetään SOTKAnetin ja sen APIn kutsuissa
code
^\d+$
Alueen koodi, jota käytetään laajemmin esim. kuntakoodi
category
^\w+$
Aluekategoriatunnus, jolla kerrotaan, minkä tyyppisestä alueesta on kyse
title
nimike
Alueen nimi kolmella kielellä
memberOf
taulukko
JSON-taulukko, jossa listataan kaikki ne aluetunnukset (id-kenttä), joihin alue kuuluu
uri
URI
Aluetta vastaava käsite Kunnat-ontologiassa
Category-kenttä voi saada arvot
* ALUEHALLINTOVIRASTO
* EURALUEET
* EUROOPPA
* KUNTA
* MAAKUNTA
* NUTS1
* SAIRAANHOITOPIIRI
* SEUTUKUNTA
* SUURALUE
Vastaus (JSON)
[
{
"id": 11,
"code": "018",
"category": "KUNTA",
"title": {
"fi": "Askola",
"en": "Askola",
"sv": "Askola"
},
"memberOf": [
488,
514,
629,
658,
727,
833,
840,
901
],
"uri": "http://www.yso.fi/onto/kunnat/k018"
}
]
Vastaus (JSONP)
JSON-rajapinnan tulos loadSotkanetRegions-takaisinkutsufunktion parametrina.
Vastaus (RDF)
Kentät ovat kuvattu RDF-käsitteillä seuraavasti
Kenttä
Käsite
id
rdf:about http://www.sotkanet.fi/rest/1.1/rdf/regions#r<id>
id
dc:identifier <id>
code
sotkanet:codedValue <code>
category
rdf:type sotkanet:<category>
title
dc:title@lang <title>
memberOf
dc:isPartOf <uri>
uri
owl:sameAs <uri>
Virheet
Ei virhesanomia, jos palvelu toimii normaalisti
Indikaattorilistaus
Indikaattorilistaus-palvelu luettelee SOTKAnetissä olevat julkiset indikaattorit, joiden tiedot ovat saatavilla
rajapinnan kautta. Indikaattorin omistajatieto on saatavilla listauksen kautta, jotta palvelua käyttävät tahot voivat
suodattaa ne indikaattorit, joihin heillä ei ole jatkokäyttöoikeutta.
Osoitteet
URI
Metodi
Vastaustyyppi
Huomiot
/1.1/indicators
GET
application/json
Listaa kaikki käytössä olevat indikaattorit
/1.1/jsonp/indicators
GET
text/javascript
/1.1/rdf/indicators
GET
application/xml
Parametrit
Ei parametreja
Vastaus
Kenttä
Arvo
Selite
id
^\d+$
Indikaattorin tunnus, jota käytetään SOTKAnetin ja sen APIn kutsuissa
title
nimike
Indikaattorin nimi kolmella kielellä
organization
oli
Indikaattorin tekijä
organization.title
nimike
Indikaattorin tekijän nimi kolmella kielellä
Vastaus JSON
[
{
"id": 4,
"title": {
"fi": "Mielenterveyden häiriöihin sairaalahoitoa saaneet 0 - 17-vuotiaat / 1000 vastaavanikäistä",
"en": "Hospital care for mental disorders, recipients aged 0-17 per 1000 persons of the same age",
"sv": "0-17-åringar som vårdats på sjukhus för psykiska störningar / 1000 i samma åldrar"
},
"organization": {
"title": {
"fi": "Terveyden ja hyvinvoinnin laitos (THL)",
"en": "Institute for Health and Welfare (THL)",
"sv": "Institutet för hälsa och välfärd (THL)"
}
}
},
{
"id": 5,
"title": {
"fi": "Toimeentulotukea saaneet 25-64-vuotiaat, % vastaavanikäisestä väestöstä",
"en": "Social assistance recipients aged 25-64, as % of total population of same age",
"sv": "25-64-åriga mottagare av utkomststöd, % av befolkningen i samma ålder"
},
"organization": {
"title": {
}
}
}
]
Vastaus JSONP
JSON-tulos loadSotkanetIndicators-takaisinkutsufunktion parametrina
Vastaus RDF
Kenttä
Käsite
id
rdf:about http://www.sotkanet.fi/rest/1.1/rdf/indicators/i<id>
id
dc:identifier <id>
title
organization
rdf:type org:FormalOrganization
organization
rdf:about http://www.sotkanet.fi/rest/1.1/rdf/sources#o<id>
organization
Virheet
Indikaattorinmetadata
Indikaattorin metadata-palvelun vastaus on valitun indikaattoriin tuotettu metatieto SOTKAnet-järjestelmässä
mm. indikaattorin omistaja, tietolähteet, aikasarja sekä asiasanoitus.
Osoitteet
URI
Metodi
Vastaustyyppi
Huomiot
/1.1/indicators/<id>
GET
application/json
Listaa indikaattorin <id> metatiedot
/1.1/jsonp/indicators/<id>
GET
text/javascript
/1.1/rdf/indicators/i<id>
GET
application/xml
Parametrit
Ei parametreja
Vastaus (JSON)
Vastaus on JSON-muotoinen olio
Kenttä
Arvo
Selite
id
^\d+$
Indikaattorin tunnus, jota käytetään SOTKAnetin ja sen APIn kutsuissa
data-updated
yyyy-MM-dd
Päivä, jolloin indikaattorin arvot on viimeksi päivitetty
range
olio
Kuvaa indikaattorin aikasarjan alku- ja loppuvuoden
range.start
^\d\{4}$
Indikaattorin aikasarjan alkuvuosi
range.end
^\d\{4}$
Indikaattorin aikasarjan loppuvuosi
title
nimike
Indikaattorin nimi kolmella kielellä
description
nimike
Indikaattorin kuvaus kolmella kielellä
interpretation
nimike
Indikaattorin tulkinta kolmella kielellä
limits
nimike
Indikaattorin rajoitukset kolmella kielellä
legislation
nimike
Indikaattorin lainsäädäntö kolmella kielellä
notices
nimike
Indikaattorin huomautukset kolmella kielellä
organization
olio
Indikaattorin tekijä
organization.id
^\d+$
Indikaattorin tekijän tunnus
organization.title
nimike
primaryValueType
olio
Indikaattorin tekijän nimike kolmella kielellä
Luokittelee indikaattorin arvon tyypin (lukumäärä, tuhat euroa,
asukasta kohden jne.)
primaryValueType
.code
primaryValueType
.title
decimals
^(\w\|\d)+$
Koodattu arvon tyyppi (ABS, PER1, PER1000, PER10000, PROS, ...)
nimike
Arvon tyypin nimike kolmella kielellä
^\d$
Kuinka monta desimaalia luvuissa on käytössä
subjects
taulukko
Listaa indikaattoriin liittyvät asiasanat
subjects[i]
nimike
subjects[i].uri
URI
classifications
taulukko
Asiasanan nimike kolmella kielellä
Asiasanaa vastaavan käsitteen tunnus YSO:ssa, TERO:ssa tai
muussa ontologiassa
Indikaattoriin liittyvät luokitukset
classifications.sex
classifications.sex
.title
classifications.sex
.values
classifications
.region
classifications
.region.title
classifications
.region.values
classifications.age
classifications.age
.title
classifications.age
.values
sources
olio
Indikaattoriin liittyvät sukupuoliluokitukset
nimike
Luokitukset vapaana tekstinä
taulukko
Käytetyt luokitukset normalisoituna, mahdollisia arvoja male, female,
total
olio
Indikaattoriin liittyvät alueluokitukset
nimike
taulukko
Käytetyt luokitukset normalisoituna, mahdollisia arvoja aluekategoriat
olio
Indikaattoriin liittyvät ikäluokitukset
nimike
taulukko
Käytetyt luokitukset normalisoituna, ei toteutettu
taulukko
Indikaattorin tietolähteet
nimike
Tietolähteen nimike kolmella kielellä
nimike
Tietolähteen kuvaus kolmella kielellä
olio
Tietolähteen omistama organisaatio, sis. nimi
sources[i].title
sources[i]
.description
sources[i]
.organization
Esimerkki
Kysely: http://www.sotkanet.fi/rest/1.1/indicators/4
{
"id": 4,
"data-updated": "2012-10-11",
"range": {
"start": 1996,
"end": 2011
},
"title": {
"fi": "Mielenterveyden häiriöihin sairaalahoitoa saaneet 0 - 17-vuotiaat / 1000 vastaavanikäistä",
"en": "Hospital care for mental disorders, recipients aged 0-17 per 1000 persons of the same age",
"sv": "0-17-åringar som vårdats på sjukhus för psykiska störningar / 1000 i samma åldrar"
},
"description": {
"fi": "Indikaattori ilmaisee vuoden aikana päädiagnoosilla mielenterveyden häiriöt (F10-F99, pois lukien F70F79 älyllinen kehitysvammaisuus) sairaalahoidossa olleiden 0 - 17-vuotiaiden osuuden tuhatta vastaavanikäistä
kohti. Väestötietona käytetään keskiväkilukua. Sairaalahoito sisältää sekä julkisen sektorin (kunnat,
kuntayhtymät ja valtio) että yksityisen sektorin järjestämän sairaalahoidon.",
"en": "The indicator gives the number of those aged 0-17 who have received hospital care with the primary
diagnosis of mental disorders ((F10-F99, excluding F70-F79 mental retardation) per thousand persons of the
same age. Population figures refer to mean population. The indicator covers hospital care in the public sector
(municipalities, joint municipal boards and the state), as well as in private sector hospitals.",
"sv": "Indikatorn visar andelen 0-17-åringar med huvuddiagnosen psykiska störningar (F10-F99, med
undantag av F70-F79 psykisk utvecklingsstörning) som under året vårdats på sjukhus per 1 000 i samma åldrar.
Medelfolkmängden används som befolkningsuppgift. Sjukhusvården omfattar sjukhusvård som anordnats både
av den offentliga sektorn (kommunerna, samkommunerna och staten) och den privata sektorn."
},
"interpretation": {
"fi": "Mielenterveyden häiriöiden vuoksi sairaalahoitoa tarvinneiden lasten ja nuorten määrä suhteutettuna
ko. ikäluokkaan kuvaa osaltaan lasten ja nuorten psyykkisten ongelmien määrää ja niiden vaikeusastetta. On
kuitenkin huomattava, että sairaalahoidon määrä riippuu myös käytettävissä olevista resursseista (esim. miten
paljon lasten ja nuorten psykiatrista sairaalahoitoa ja/tai avohoitoa alueella on tarjolla) sekä vallitsevista
hoitokäytännöistä.",
"en": "The number of children and young people who have received hospital care for mental disorders in
relation to the total population of the same age helps describe the level and severity of mental disorders among
children and young people. However, it should be noted that the level of hospital care also depends on the
resources available (e.g. the extent to which psychiatric hospital care/outpatient care for children and young
people is available in the area) and the treatment practices in use.",
"sv": "Antalet barn och unga som på grund av psykiska störningar har varit i behov av sjukhusvård i relation
till sin åldersklass visar omfattningen av barns och ungas psykiska problem samt hur svåra problemen är. Man
bör dock observera att sjukhusvårdsvolymen också påverkas av de resurser som finns att tillgå (t.ex. hur mycket
psykiatrisk sjukhusvård och/eller öppenvård för unga vuxna som tillhandahålls i regionen) samt av den rådande
vårdpraxisen."
},
"limits": {
"fi": "Hoitoilmoitusrekisterin yksilötasoiset tiedot ovat salassa pidettäviä. Tietosuojan vuoksi alle viiden
tapauksen kuntakohtaisia tietoja ei julkisteta.",
"en": "Individual level data in the Care Registers for Social Welfare and Health Care are confidential. For
the sake of privacy protection, no municipality level data with less than five cases are published.",
"sv": "Uppgifterna om enskilda personer i Vårdanmälningsregistret är konfidentiella. Om antalet fall i
kommunen är färre än fem, publiceras inte uppgifterna på grund av datasekretessen."
},
"legislation": {
"fi": "Mielenterveyslaki 14.12.1990/1116 sekä Mielenterveysasetus 21.12.1990/1247 / 2a luku. Lasten ja
nuorten mielenterveyspalvelut (28.12.2000/1282). Asetuksen 6a§:ssä määritellään mm. hoitolähetteen
arvioinnin ja hoidon järjestämisen enimmäisajat (3 viikkoa ja 3 kk).",
"en": "Mental Health Act 14.12.1990/1116 and Mental Health Decree 21.12.1990/1247 / Chapter 2a. Mental
health services for children and young people (28.12.2000/1282). Section 6a of the Decree defines, among other
things, maximum time periods for the assessment of referral to treatment and the arrangement of care (3 weeks
and 3 months).",
"sv": "Mentalvårdslag 14.12.1990/1116 samt mentalvårdsförordning 21.12.1990/1247/ 2a kap.
Mentalvårdstjänster för barn och unga (28.12.2000/1282). I 6a § i förordningen anges bl.a. tiderna för
bedömning av remisser och anordnande av vård (3 veckor och 3 månader)."
},
"notices": {
"fi": "",
"en": "",
"sv": ""
},
"primaryValueType": {
"code": "PER1000",
"title": {
"fi": "Tuhatta asukasta kohden",
"en": "Per 1 000 inhabitants",
"sv": "Per tusen invånare"
}
},
"decimals": 1,
"classifications": {
"region": {
"title": {
"fi": "Kunta, seutukunta, maakunta, aluehallintoviraston alue, suuralue, Manner-Suomi/Ahvenanmaa,
sairaanhoitopiiri, erityisvastuualue, koko maa",
"en": "Municipality, sub-region, region, area for the regional state administrative agency, major region,
Mainland Finland/Åland, hospital district, university hospital special responsibility area, whole country",
"sv": "Kommun, ekonomisk region, landskap, området för regionförvaltningsverket, storområde,
Fastlandsfinland/Åland, sjukvårdsdistrikt, specialupptagningsområde, hela landet"
},
"values": [
"Kunta",
"Maakunta",
"Erva",
"Aluehallintovirasto",
"Sairaanhoitopiiri",
"Maa",
"Suuralue",
"Seutukunta",
"Nuts1"
]
},
"sex": {
"title": {
"fi": "miehet, naiset, yhteensä",
"en": "male, female, combined",
"sv": "män, kvinnor, totalt"
},
"values": [
"male",
"female",
"total"
]
},
"age": {
"title": {
"fi": "0-17-vuotiaat",
"en": "Ages 0-17",
"sv": "0-17 år"
},
"values": []
}
},
"organization": {
"id": 2,
"title": {
}
},
"subjects": [
{
"fi": "sairaalahoito",
"sv": "sjukhusvård",
"en": "hospital care"
},
{
"fi": "mielenterveys",
"sv": "psykisk hälsa",
"en": "mental health",
"uri": "http://www.yso.fi/onto/yso/p1949"
},
{
"fi": "psykiatrian laitoshoito",
"sv": "psykiatrisk institutionsvård",
"en": "psychiatric inpatient care"
},
{
"fi": "psykiatria",
"sv": "psykiatri",
"en": "psychiatry"
}
],
"sources": [
{
"organization": {
"id": 2,
"title": {
}
},
"title": {
"fi": "Perusterveydenhuoltotilasto",
"en": "Primary health care",
"sv": "Primär vård"
},
"description": {
"fi": "Perusterveydenhuollon tilasto perustuu vuosittain terveydenhuollon toimintayksiköistä
henkilötunnuksella kerättäviin hoitoilmoituksiin. Valtakunnallinen sosiaali- ja terveydenhuollon
hoitoilmoitusjärjestelmä on laajentunut kattamaan perusterveydenhuollon avohoidon vuonna 2011.
Perusterveydenhuollon avohoidon hoitoilmoitukset sisältävät tietoja palvelutapahtuman tuottajista, asiakkaiden
yhteydenotoista, hoidon tarpeen arvioinnista, ajanvarataustiedoista sekä palvelutapahtuman sisällöstä, kuten
käyntisyistä ja toimenpiteistä sekä jatkohoidosta. Lisäksi perusterveydenhuollon tilastoon tulee tietoja
terveyskeskusten laitoshoidosta. Perusterveydenhuollon laitoshoidon hoitoilmoitukset sisältävät tiedot palvelun
tuottajasta, potilaan kotikunnasta, hoitoon tulon tiedot, hoitoon liittyvät tiedot toimenpiteineen sekä hoidon
päättymiseen liittyviä tietoja. THL keräsi terveyskeskuksilta vuoteen 2010 asti vuosittain tiedot
niiden tuottamista avohoidon palveluista Notitia tiedonkeruulla. Terveyskeskukset ilmoittivat tiedot
jäsenkunnittain. Lääkärikäynnit ja muun ammattihenkilökunnan käynnit kysyttiin toiminnoittain, minkä lisäksi
kysyttiin lääkärikäynnit ja lääkärillä käyneet potilaat ikäryhmittäin. Suun terveydenhuollon käynneistä kerättiin
ikäryhmittäiset käyntitiedot hammaslääkäri-, hammashuoltaja- ja -hoitajakäynneistä, sekä ikäryhmittäiset tiedot
suun terveydenhuollon potilaista. THL on kerännyt tiedot vuodesta 2002 lähtien. Suomen Kuntaliitto keräsi
vastaavia tietoja vuosilta 1994-2001. Tietoja terveyskeskusten avohoidosta ei kerätä Ahvenanmaan
maakunnasta.",
"en": "",
"sv": ""
}
},
{
"organization": {
"id": 2,
"title": {
}
},
"title": {
"fi": "Erikoissairaanhoitotilasto",
"en": "Specialised healthcare",
"sv": "Specialiserad sjukvård"
},
"description": {
"fi": "Erikoissairaanhoidon tilasto perustuu vuosittain terveydenhuollon toimintayksiköistä
henkilötunnuksella kerättäviin hoitoilmoituksiin. Ne sisältävät tiedot palvelun tuottajasta, potilaan kotikunnasta,
hoitoon tulon tiedot, hoitoon liittyvät tiedot toimenpiteineen sekä hoidon päättymiseen liittyviä tietoja. Psykiatrian
erikoisalojen potilaista ilmoitetaan näiden tietojen lisäksi psykiatrian erikoisalojen lisätiedot, jotka käsittelevät
lääkehoitoa, pakkotoimia ja psyykkisen tilan arviointia. Samoin vaativista sydänpotilaista kerätään lisätietoja.
Lisäksi vuoden viimeisenä päivänä sairaalassa vuodeosastoilla olevista potilaista tehdään potilaslaskenta.
 Terveyden ja hyvinvoinnin laitos kerää vuosittain terveydenhuollon palveluntuottajilta
hoitoilmoitukset (HILMO) päättyneistä hoitojaksoista ja avohoitokäynneistä. Erikoissairaanhoidon tilastoon on
kerätty tietoja kaikista kuntien, kuntayhtymien ja valtion sairaaloista sekä suurimmista yksityissairaaloista. Lisäksi
vuoden viimeisenä päivänä sairaalassa olevista potilaista tehdään potilaslaskenta. Nykyisen kaltainen
tiedonkeruu laitoshoidosta alkoi terveydenhuollossa vuonna 1994. Erikoissairaanhoidon avohoidosta tietoja on
kerätty vuodesta 1998 alkaen, mutta vertailukelpoisia tiedot ovat vuodesta 2006 lähtien. Jo ennen tätä, vuodesta
1967 lähtien, kerättiin ns. poistoilmoitusrekisteriin tietoja sairaaloiden ja terveyskeskusten vuodeosastoilta
poistuneista potilaista.",
"en": "",
"sv": ""
}
}
]
}
Vastaus (JSONP)
JSON-tulos loadSotkanetIndicator()-takaisinkutsufunktion parametrina
Vastaus (RDF)
Kenttä
Käsite
id
rdf:about http://www.sotkanet.fi/rest/1.1/rdf/indicators/i<id>
id
dc:identifier <id>
data-updated
dc:date <yyyy-mm-dd>
range
dc:coverage <yyyy>-<yyyy>
title
description
dc:description@lang <kuvaus>
interpretation
sotkanet:interpretation@lang <tulkinta>
limits
sotkanet:limits@lang <rajoitukset>
legislation
sotkanet:legislation@lang <lainsäädäntö>
notices
sotkanet:remarks@lang <huomiot>
organization
dc:publisher <organisaatio>
organization
rdf.type org:FormalOrganization
organization.id
rdf:about http://www.sotkanet.fi/rest/1.1/rdf/sources/o#<id>
organization.title
primaryValueType
rdf:type sotkanet:PrimaryValue
primaryValueType.code
rdf:about http://www.sotkanet.fi/rest/1.1/rdf/ns#<code>
primaryValueType.title
decimals
sotkanet:decimals <desimaalien määrä>
subjects
dc:subject <asiasana>
subjects[i]
rdf:about http://www.sotkanet.fi/rest/1.1/rdf/subjects#p<id>
subjects[i]
rdf:type sotkanet:Subject
subjects[i]
dc:title@lang <asiasana>
subjects[i].uri
skos:nearMatch <uri>
classifications
sotkanet:classifiedBy uri
classifications.sex
rdf:type sotkanet:ClassificationBySex
classifications.title
dc:title@lang <nimike>
classifications.sex.values
rdf:value <arvo>
classifications.region
rdf:type sotkanet:ClassificationByRegion
classifications.region.title
classifications.region.values
rdf:value <arvo>
classifications.age
rdf:type sotkanet:ClassificationByRegion
classifications.age.title
classifications.age.values
rdf:value <arvo>
sources
sotkanet:hasSource uri
sources[i]
rdf:type sotkanet:Source
sources[i].id
rdf:about h http://www.sotkanet.fi/rest/1.1/rdf/sources#s<id>
sources[i].title
sources[i].description
dc.description@lang <kuvaus>
sources[i].organization
Virheet
Virhe
Viesti
Syy
404
Indicator <id> was not found
Indikaattorin tietoja ei löytynyt
Asiasanaluettelo
Asiasanaluettelon vastauksena on listaus SOTKAnetissä käytettävistä asia\- tai avainsanoista. Asiasanat ovat
yhdistetty mahdollisuuksien mukaan yleisiin ontologioihin, pääsääntöisesti YSO\- ja TERO-ontologioihin.
Käsitteet, joihin asiasanat on yhdistetty, ovat selattavissa ONKI-palvelimella.
Osoitteet
URI
Metodi
Vastaustyyppi
Huomiot
/1.1/subjects
GET
application/json
Listaa indikaattorien luokitteluun käytetyt asiasanat
/1.1/jsonp/subjects
GET
text/javascript
/1.1/rdf/subjects
GET
application/rdf
Parametrit
Ei parametreja
Vastaus (JSON)
Kenttä
Arvo
Selite
[i]
nimike
Asiasanan nimike kolmella kielellä
[i].uri
URI
Asiasanaa vastaavan käsitteen tunnus YSO:ssa, TERO:ssa tai muussa ontologiassa
[
{
"fi": "kouluolot",
"sv": "skolarbete",
"en": "school physical environment"
},
{
"fi": "kouluterveys",
"sv": "hälsa i skolan",
"en": "school health",
"uri": "http://www.yso.fi/onto/tero/T01038"
}
]
Vastaus (JSONP)
JSON-vastaus loadSotkanetSubjects()-takaisinkutsufunktion parametrina
Vastaus (RDF)
Kenttä
Käsite
[i]
rdf:about http://www.sotkanet.fi/rest/1.1/rdf/subjects#p<id>
[i]
rdf:type sotkanet:Subject
[i]
dc:title@lang <asiasana>
[i].uri
skos:nearMatch <uri>
Virheet
Lähdeluettelo
Lähdeluettelopalvelun vastaus sisältää listauksen SOTKAnetissä lähteenä toimivista aineistoista ja
organisaatiosta. Jokaiseen lähteeseen on liitetty sen omistava organisaatio.
Osoitteet
URI
Metodi
Vastaustyyppi
Huomiot
/1.1/sources
GET
JSON
Listaa SOTKAnetin lähteenä toimivat aineistot ja organisaatiot
/1.1/jsonp/sources
GET
JSONP
/1.1/rdf/sources
GET
RDF
Parametrit
Ei parametreja
Vastaus (JSON)
Vastaus on JSON-muotoinen olio
Kenttä
Arvo
Selite
organizations
olio
Sisältää luettelon SOTKAnetissä määritellyistä organisaatioista
organization[i]
olio
Organisaatio
organization[i].id
^\d+$
Organisaation tunnus
organization[i].title
nimike
Organisaaiton nimike kolmella kielellä
sources
olio
Sisältää luettelon SOTKAnetissä määritellyistä tietolähteistä
sources[i].title
nimike
Tietolähteen nimike kolmella kielellä
nimike
^o\d+$
Tietolähteen kuvaus kolmella kielellä
Sisältää organisaation tunnukset prefiksillä o, jonka avulla organisaation
tiedot saadaan organizations-oliosta
{
"organizations": {
"o2": {
"id": 2,
"title": {
}
}
},
"sources": {
"s1": {
"organization": "o3",
"title": {
"fi": "Väestötilasto",
"en": "Population Statistics",
"sv": "Befolkningsstatistik"
},
"description": {
"fi": "Tilastokeskus tekee väestötilaston Väestörekisterikeskuksen väestötietojärjestelmien tiedoista.",
"en": "Statistics Finland compiles Population Statistics based on the Population Information System of
the Population Register Centre.",
"sv": "Statistikcentralen gör upp en befolkningsstatistik på basis av de uppgifter som finns i
Befolkningsregistercentralens dataregister."
}
}
}
}
Vastaus (JSONP)
JSON-vastaus loadSotkanetSources()-takaisinkutsufunktion parametrina.
Vastaus (RDF)
Kenttä
Käsite
organizations
Ei esitetä
organization[i]
organization[i]
rdf.type org:FormalOrganization
organization[i].id
organization[i].title
sources
Ei esitetä
sources[i]
rdf:type sotkanet:Source
sources[i].id
sources[i].title
dc.description@lang <kuvaus>
Virheet
Indikaattorindata
Tuottaa SOTKAnetin tietosisällöstä poiminnan parametrien perusteella siten, että poiminta sisältää indikaattorin
tiedot kaikilta alueita valituilla vuosilla ja sukupuolilla suodatettuna. Indikaattorin arvo luokitellaan alueen, vuoden
ja sukupuolen perusteella. Indikaattorin arvo esitetään sen ensisijaisen arvotyypin mukaisesti sekä
absoluuttisena lukuarvona, mikäli se on saatavilla. Esimerkiksi väestöön suhteutetut luvut sisältävät
väestösuhteutuksen arvon ensisijaisena arvonaan sekä lukumäärä tiedon absoluuttisena arvonaan.
Osoitteet
URI
Metodi
Vastaustyyppi
/1.1/csv
GET
text/csv
Huomiot
Listaa indikaattorin arvot. Tiedostonimi määritelty content-dispositionotsikossa, mistä seuraa, että ladataan selaimessa tiedostona eikä avata
suoraan näkyviin.
Parametrit
Parametri
Arvo
Selite
indicator
^\d+$
Indikaattorin SOTKAnet-tunnus
years
^\d\{4}$
Vuosi, jolta arvot halutaan. Voi esiintyä useita kertoja
genders
^((total)|(male)|(female))$
Sukupuoli, jolta arvot halutaan. Voi esiintyä useita kertoja
Huom\! Kaikki parametrit ovat pakollisia.
Vastaus
Vastaus on CSV-muotoinen taulukko
Kenttä
Arvo
indicator
^\d+$
region
^\d+$
year
^\d\{4}$
Selite
Indikaattorin tunnus, jota käytetään SOTKAnetin ja
sen APIn kutsuissa
Alueen tunnus, jota käytetään SOTKAnetin ja sen
APIn kutsuissa
Vuosi, jota arvo koskee
gender
^((total)|(male)\|(female))$
Sukupuoli, jota arvo koskee
primary value
^\d+(\.\d+)$
Indikaattorin arvo
absolute value
^\d+(\.\d+)$
Indikaattorin lukumääräarvo, jos määritelty erikseen
Esimerkki
Kysely: http://www.sotkanet.fi/rest/1.1/csv?indicator=127&years=2009&genders=total
indicator; region; year; gender; primary value; absolute value
127; 2; 2009; total; 10573
127; 4; 2009; total; 2776
127; 5; 2009; total; 9395
127; 9; 2009; total; 8551
127; 11; 2009; total; 4831
127; 12; 2009; total; 3840
127; 13; 2009; total; 498
127; 15; 2009; total; 924
127; 18; 2009; total; 1617
127; 19; 2009; total; 1882
Virheet
Virhekoodi
Viesti
400
404
404
404
Syy
Jos pyynnön parametrit eivät vastaa rajapintaa
Indicator <id> was not found
At least one of the provided parameters do
not match male|female|total (<parametri>)
At least one of the years provided is not
between 1990 and the current year
[<parametri>]
Jos pyydettyä indikaattoria ei löydy
Jos yksi tai useampi genders-parametri ei
vastaa sallittuja arvoja
Jos yksi tai useampi years-parametri on
pienempi kuin 1990 tai suurempi kuin kuluva
vuosi

SOTKAnetin avoin rajapinta

Transcription

Similar documents

JHS XXX Paikkatiedon yksilöivät tunnukset

Lasten postoperatiiviset ongelmat heräämössä & niiden ennakoiminen

ABB-Welcome-ovipuhelinjärjestelmä Pientaloihin Nykymaailmassa

Halosia kirkonkirjoissa

Helsingin 8.-9.-luokkalaisten ja lukiolaisten

Integroitu raportointi yritysten näkökulmia EK ProCom 200514

1 Rru:C SUfI.IAfIS UII.ICNU.lAUIUUDlTIU

Salimaki Elisa DP

Creative Futures Conference Proceedings