Yksilöintitietojen kyselyparametrit
Alla olevassa taulukossa on kuvattu Yksilöintitietojen REST hakuoperaatiossa käytettävät kyselyparametrit. Kyselyparametrit on määritelty käyttäen Parameters resurssia.
Kyselyparametrien pakollisuudet ja hakujen rajaukset ovat kuvattu Medical records- dokumentin kappaleessa 8 ja Yksilöintitietojen REST hakuoperaatio noudattaa näitä samoja Medical Records määrittelyjä.
| Kyselyparametri | parameter.value[x] | FHIR esimerkki | MR-kenttä, selite |
|---|---|---|---|
| patientIdentifier | valueIdentifier 0..n | { "resourceType": "Parameters", "parameter": [ { "name": "patientIdentifier", "valueIdentifier": { "system": "urn:oid:1.2.246.21", "value": "030875-999Y" } }, { "name": "patientIdentifier", "valueIdentifier": { "system": "urn:oid:1.2.246.21", "value": "120385-123P" }} ] } | patient.id - henkilötunnus - haetaan tietyn potilaan asiakirjoja. Max 20 hetua.Jos on useampi henkilötunnus - toistetaan patientIdentifier parametria. |
| assignedAuthorId | valueIdentifier 0..1 | { "resourceType": "Parameters", "parameter": [ { "name": "assignedAuthorId", "valueIdentifier": { "system": "urn:oid:1.2.246.537.25", "value": "032763" } } ] } | assignedAuthor.id - asiakirjan laatijan id - haetaan tietyn henkilön laatimia dokumentteja |
| representedOrganizationId | valueIdentifier 0..1 | { "resourceType": "Parameters", "parameter": [ { "name": "representedOrganiza-tionId", "valueIdentifier": { "system": "urn:ietf:rfc:3986", "value": "urn:oid:1.2.246.10.8182355.10.1" } } ] } | representedOrganization.id - organisaaation id -haetaan tietyn organisaation (palveluyksikön) laatimia dokumentteja, HUOM. tämä parametri käytössä vain apteekkien tekemässä haussa |
| identifier | valueIdentifier 0..n | { "resourceType": "Parameters", "parameter": [ { "name": "identifier", "valueIdentifier": { "system": "http://resepti.kanta.fi/fhir/id/id", "value": "urn:oid:1.2.246.10.11111111.93.2020.1158" } } ] } | clinicalDocument.id - asiakirjan id - yksi tai useampi id. Jos on useampi id, toistetaan identifier parametria. Identifier kyselyparametria käytetään sekä clinicalDocumentId että setId hauissa. Kyselyt voidaan erottaa toisistaan eri "system" arvoilla |
| identifier | valueIdentifier 0..n | { "resourceType": "Parameters", "parameter": [ { "name": "identifier", "valueIdentifier": { "system": "http://resepti.kanta.fi/fhir/id/setId", "value": "urn:oid:1.2.246.10.11111111.93.2020.1158" } } ] } | setId - asiakirjan eri versiot yhdistävä Id |
| clinicalDocumentEffectiveTime | valuePeriod 0..1 | { "resourceType": "Parameters", "parameter": [ { "name": "clinicalDocumentEf-fectiveTime", "valuePeriod": { "start": "2021-02-20", "end": "2021-02-22" }} ] } | clinicalDocument.effectiveTime - asiakirjan luontiaikaa. DateTime sekunnin tarkkuudella |
| authoredOn | valuePeriod 0..1 | { "resourceType": "Parameters", "parameter": [ { "name": "authoredOn", "valuePeriod": { "start": "2021-02-20", "end": "2021-02-22" }} ] } | encompassingEncounter.effectiveTime - low/high - aikaväli. Lääkemääräyksessä määräyspäivä, toimituksessa toimituspäivä. Muissa asiakirjoissa kuin lääkemääräyksissä ja toimituksissa sekä näiden korjauksissa ja mitätöinneissä toimenpiteen tekohetki (esimerkiksi lukituksen tekoaika) |
| statusReason | coding 1..n | { "resourceType": "Parameters", "parameter": [ { "name": "statusReason", "valueCoding": { "system": "urn:oid:1.2.246.537.5.40105.2006", "code": "1" }} ] } | clinicalDocument.code. Koodisto: Sähköinen lääkemääräys - Reseptisanoman tyyppi - 1.2.246.537.5.40105.2006 |
| dispenseStatus | coding 0..1 | { "resourceType": "Parameters", "parameter": [ { "name": "dispenseStatus", "valueCoding": { "system": "urn:oid:1.2.246.537.5.40121.2006", "code": "1" }} ] } | dispenseStatus - voidaan pyytää tietyssä toimitustilassa olevat lääkemääräykset. Koodisto: Sähköinen lääkemääräys - Lääkemääräyksen toimituksen tila - 1.2.246.537.5.40121.2006 |
| category | coding 0..n | { "resourceType": "Parameters", "parameter": [ { "name": "category", "valueCoding": { "system": "urn:oid:1.2.246.537.6.605.2014", "code": "1" }} ] } | prescriptionType. Koodisto: THL - Reseptin laji - 1.2.246.537.6.605.2014 |
| recentMedicationinformation | boolean 0..1 | "resourceType": "Parameters", "parameter": [ { "name": "recentMedicationinformation", "valueBoolean": true} ] } | recentMedicationinformation - "true/false arvo. Asetetaan arvoon ”true” osoittamaan, että kysely rajataan koskemaan voimassa olevaa lääkitystä. |
| recentDispenseinformation | boolean 0..1 | { "resourceType": "Parameters", "parameter": [ { "name": "recentDispenseinformation", "valueBoolean": true} ] } | recentDispenseinformation - "true/false arvo. Asetetaan arvoon ”true” osoittamaan, että kysely rajataan koskemaan tietyllä ajalla toimitettuja lääkemääräyksiä. |
| specialQueryCode | part 0..1 | { "resourceType": "Parameters", "parameter": [ { "name": "specialQueryCode", "part": [ { "name": "code", "valueCoding": { "system": "urn:oid:1.2.246.537.5.40187.2011", "code": "2" } }, { "name": "value", "valueCoding": { "system": "urn:oid:1.2.246.537.5.40118.2006", "code": "H" } }, { "name": "value", "valueCoding": { "system": "urn:oid:1.2.246.537.5.40118.2006", "code": "P" } },{ "name": "value", "valueCoding": { "system": "urn:oid:1.2.246.537.5.40118.2006", "code": "Z" } },{ "name": "value", "valueCoding": { "system": "urn:oid:1.2.246.537.5.40118.2006", "code": "PA" } },{ "name": "value", "valueCoding": { "system": "urn:oid:1.2.246.537.5.40118.2006", "code": "ZA" } } ] } ] } | specialQueryCode - voidaan antaa arvoja eri koodistoista KanTa-palvelut - Sisäisen hakukysely -koodiston mukaan 1.2.246.537.5.40187.2011 |