Finnish Kanta-Medication list R4 versio 1.0.0

Hakuparametri esimerkkejä (Pyynnön HTTP body)

Operaatioiden hakuparametrit välitetään HTTP pyynnön body-osassa Parameters resurssin avulla.

Lääkityslistan perushaun hakuparametri esimerkkejä:

Hakuparametrit on kuvattu tämän oppaan osiossa Operaatio $get-medicationlist (Lääkityslistan perushaku).

Potilastietojärjestelmä

Parametrit: henkilötunnus, reseptin lajia ei ole annettu

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "050520A909R"
      }
   }
  ]
}

Apteekkijärjestelmä (avoapteekki)

Parametrit: henkilötunnus, reseptin laji

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "050520A909R"
      }
   },{ 
      "name" : "category",
      "valueCoding" :  { 
      "system": "urn:oid:1.2.246.537.6.605.2014", 
      "code": "1"  

      }
   }
  ]
}

Lääkkeen historiahaun hakuparametri esimerkki:

Hakuparametrit on kuvattu tämän oppaan osiossa Operaatio $get-history-medications (Lääkkeen historiahaku).

Potilastietojärjestelmä ja apteekkijärjestelmät

Parametrit: 2 käytössä olevan lääkkeen tunnistetta, aikarajaus 2 vuotta, uusin toimitus, lääkemääräyksien ajantasaiset versiot (valinnainen)

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "medicineId",
      "valueIdentifier": {
         "system": "urn:ietf:rfc:3986",
         "value": "1.2.246.10.11111111.93001.2023.11685363591384123.0"
      }
   },{
      "name": "medicineId",
      "valueIdentifier": {
         "system": "urn:ietf:rfc:3986",
         "value": "1.2.246.10.11111111.93001.2023.12675869535386874.0"
      }
   },{
      "name": "authoredOn",
      "valuePeriod": {
         "start": "2022-11-20",
         "end": "2024-11-20"
      }
   },{
      "name": "latestDispenseOnly",
      "valueBoolean": true
    },{
      "name": "x-extent",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40160.2008",
         "code": "1"
      }
   }
  ]
}

Lopetettujen lääkkeiden haun hakuparametri esimerkkejä:

Hakuparametrit on kuvattu tämän oppaan osiossa Operaatio $get-discontinued-medications (Lopetettujen lääkkeiden haku).

Potilastietojärjestelmä

Parametrit: henkilötunnus, päivämäärärajaus (valinnainen), reseptin lajia ei ole annettu

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "030875-999Y"
      }
   },{
      "name" : "discontinuedAfter",
      "valueDate" : "2024-11-30"  
   }
  ]
}

Apteekkijärjestelmä (avoapteekki)

Parametrit: henkilötunnus, päivämäärärajaus (valinnainen), reseptin laji

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "030875-999Y"
      }
   },{
      "name" : "discontinuedAfter",
      "valueDate" : "2024-11-30"  
   },{ 
      "name" : "category",
      "valueCoding" :  { 
      "system": "urn:oid:1.2.246.537.6.605.2014", 
      "code": "1"  
      }
   }
  ]
}

Historiahaun ilman käytössä olevan lääkkeen tunnisteita hakuparametri esimerkkejä:

Hakuparametrit on kuvattu tämän oppaan osiossa Operaatio $get-old-prescriptions (Historiahaku ilman käytössä olevan lääkkeen tunnisteita).

Potilastietojärjestelmä

Parametrit: henkilötunnus, päivämäärärajaus (valinnainen) 2 vuotta, uusin toimitus, toimituksen tilatieto (valinnainen), reseptin lajia ei ole annettu, lääkemääräyksien versio tietoa ei ole annettu

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "030875-999Y"
      }
   },{
      "name": "authoredOn",
      "valuePeriod": {
         "start": "2022-11-20",
         "end": "2024-11-20"
      }
   },{
      "name": "latestDispenseOnly",
      "valueBoolean": true
    },{
      "name": "dispenseStatus",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40121.2006",
         "code": "1"
      }
   }
  ]
}

Apteekkijärjestelmä (avoapteekki)

Parametrit: henkilötunnus, päivämäärärajaus (valinnainen) 2 vuotta, kaikki toimitukset, reseptin laji, lääkemääräyksien versio tietoa ei ole annettu, toimituksen tilatietoa ei ole annettu

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "030875-999Y"
      }
   },{
      "name": "authoredOn",
      "valuePeriod": {
         "start": "2022-11-20",
         "end": "2024-11-20"
      }
   },{
      "name": "latestDispenseOnly",
      "valueBoolean": false
    },{ 
      "name" : "category",
      "valueCoding" :  { 
      "system": "urn:oid:1.2.246.537.6.605.2014", 
      "code": "1"  
      }
   },{
      "name": "dispenseStatus",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40121.2006",
         "code": "1"
      }
   }
  ]
}

Lääkityslistan erikoishaun hakuparametri esimerkkejä:

Hakuparametrit on kuvattu tämän oppaan osiossa Operaatio $get-custom-data (Lääkityslistan erikoishaku).

Potilastietojärjestelmä PKV- ja huumausainelääkemääräyksien haku:

Parametrit: henkilötunnus, päivämäärärajaus (valinnainen) 2 vuotta, PKV- ja huumausainelääkemääräykset (H, P, Z, PA ja ZA)

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "030875-999Y"
      }
   },{
      "name": "cnsNarcotic",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40118.2006",
         "code": "H"
      }
   },{
      "name": "cnsNarcotic",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40118.2006",
         "code": "P"
      }
   },{
      "name": "cnsNarcotic",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40118.2006",
         "code": "Z"
      }
   },{
      "name": "cnsNarcotic",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40118.2006",
         "code": "PA"
      }
   },{
      "name": "cnsNarcotic",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40118.2006",
         "code": "ZA"
      }
   },{
      "name": "authoredOn",
      "valuePeriod": {
         "start": "2022-11-20",
         "end": "2024-11-20"
      }
   }
  ]
}

Potilastietojärjestelmä Lääkkeen määrääjän itse laatimat lääkemääräykset haku:

Parametrit: henkilötunnus, lääkkeen määrääjän yksilöintitunnus, päivämäärärajaus (valinnainen)

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "030875-999Y"
    }
   },{
      "name": "assingAuthorId",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.537.25",
         "code": "123456"
      }
   },{
      "name": "authoredOn",
      "valuePeriod": {
         "start": "2022-11-20",
         "end": "2024-11-20"
      }
   }
  ]
}

Apteekkijärjestelmä Uusimispyyntöjen käsittelyn tilanne haku:

Parametrit: apteekin OID, päivämäärärajaus

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "representedOrganizationId",
      "valueIdentifier": {
         "system": "urn:ief:rfc:3986",
         "value": "urn:oid:1.2.246.10.8182355.10.1"
    }
   },{
      "name": "authoredOn",
      "valuePeriod": {
         "start": "2022-11-20",
         "end": "2024-11-20"
      }
   }
  ]
}

Apteekkijärjestelmä Apteekin uudet ja muuttuneet annosjakelulääkemääräykset haku:

Parametrit: apteekin OID, päivämäärärajaus, reseptisanoman tyypit (1, 2, 3 ja 23), 3 potilasta

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "representedOrganizationId",
      "valueIdentifier": {
         "system": "urn:ief:rfc:3986",
         "value": "urn:oid:1.2.246.10.8182355.10.1"
    }
   },{
      "name": "authoredOn",
      "valuePeriod": {
         "start": "2022-11-20",
         "end": "2024-11-20"
      }
   },{
      "name": "documentType",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40105.2006",
         "code": "1"
      }
   },{
      "name": "documentType",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40105.2006",
         "code": "2"
      }
   },{
      "name": "documentType",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40105.2006",
         "code": "3"
      }
   },{
      "name": "documentType",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.5.40105.2006",
         "code": "23"
      }
   },{
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "111144-999Y"
      }
    },{
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "121240-999Y"
      }
    },{
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "010133-999Y"
      }
    }
  ]
}

Potilastietojärjestelmä ja apteekkijärjestelmät Tietyllä ATC-koodilla olevat lääkemääräykset haku:

Parametrit: henkilötunnus, ATC-koodi, päivämäärärajaus

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "030875-999Y"
      }  
   },{
      "name": "atcCode",
      "valueCoding": {
         "system": "urn:oid:1.2.246.537.6.32.2007",
         "code": "M01AE01"
      }
   },{
      "name": "authoredOn",
      "valuePeriod": {
         "start": "2022-11-20",
         "end": "2024-11-20"
      }
   }
  ]
}

Lääkityslistan tulostehaun hakuparametri esimerkkejä:

Hakuparametrit on kuvattu tämän oppaan osiossa Operaatio $get-printout (Tulostehaku).

Potilastietojärjestelmä ja apteekkijärjestelmät Lääkityslistan yhteenveto (kooste) tulostehaku:

Parametrit: henkilötunnus, discontinuedIncluded: haussa palautuu kaikki käytössä olevat lääkkeet ja myös lopetetut lääkkeet, tuloste suomeksi kun language parametria ei ole annettu

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "patientIdentifier",
      "valueIdentifier": {
         "system": "urn:oid:1.2.246.21",
         "value": "050520A909R"
      }
   },{
      "name": "discontinuedIncluded",
      "valueBoolean": true
    }
  ]
}

Potilastietojärjestelmä ja apteekkijärjestelmät Lääkityslistan yhteenveto (kooste) tulostehaku:

Parametrit: käytössä olevan lääkkeen tunnisteet: haussa palautuu valitut käytössä olevat lääkkeet,tuloste suomeksi kun language parametria ei ole annettu

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "medicineId",
      "valueIdentifier": {
         "system": "urn:ietf:rfc:3986",
         "value": "1.2.246.10.11111111.93001.2023.11685363591384123.0"
      }
   },{
      "name": "medicineId",
      "valueIdentifier": {
         "system": "urn:ietf:rfc:3986",
         "value": "1.2.246.10.11122111.93001.2023.12695568571286157.0"
    }
  ]
}

Potilastietojärjestelmä Potilasohje tulostehaku:

Parametrit: setId ja kieli (valinnainen)

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name": "setId",
      "valueIdentifier": {
         "system": "http://resepti.kanta.fi/fhir/id/setId",
         "value": "urn:oid:1.2.246.10.11111111.93001.2024.117286489685961232160310007"
      }
   },{
      "name": "language",
      "valueString": "fi"
    }
  ]
}