Clinibus FHIR specification
0.1.8 - ci-build
Clinibus FHIR specification - Local Development build (v0.1.8) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2025-02-11 |
{
"resourceType" : "OperationDefinition",
"id" : "patient-hrp-document-search",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition patient-hrp-document-search</b></p><a name=\"patient-hrp-document-search\"> </a><a name=\"hcpatient-hrp-document-search\"> </a><a name=\"patient-hrp-document-search-en-US\"> </a><p>URL: [base]/Patient/$HRP-DocumentSearch</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient:identifier</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Potilaan virallinen henkilötunnus. Sekä system että code on annettava: patient:identifier=urn:oid:{system|code}.\n(system = virallisen henkilötunnuksen OID-juuri, '1.2.246.21', code = henkilötunnus)</p>\n</div></td></tr><tr><td>IN</td><td>author:identifier</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Asiakirjan laatineen organisaation OID-tunniste.\nOrganisaation tunnisteena käytetään Kansallisen koodistopalvelun (https://koodistopalvelu.kanta.fi/) organisaatiokoodistojen THL - SOTE-organisaatiorekisteri (1.2.246.537.6.202.2008) ja Valvira - Terveydenhuollon itsenäiset ammatinharjoittajat (1.2.246.537.6.203.2014) mukaisia arvoja.\nAnnetaan muodossa: author:identifier=urn:oid:{code}.\n(code = OID-tunniste)</p>\n</div></td></tr><tr><td>IN</td><td>effective-time</td><td/><td>0..2</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Asiakirjan luontiaika.\nHuom. effective-time ja period -hakuparametreja ei saa käyttää samassa haussa.</p>\n</div></td></tr><tr><td>IN</td><td>period</td><td/><td>0..2</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Palvelutapahtuman ajankohta.\nHuom. effective-time ja period -hakuparametreja ei saa käyttää samassa haussa.</p>\n</div></td></tr><tr><td>IN</td><td>category</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Asiakirjan näkymäkoodi, ValueSet fihrp-vs-documentreferencecategory. Käytössä Kansallisen koodistopalvelun (https://koodistopalvelu.kanta.fi/) koodiston AR/YDIN - Näkymät (1.2.246.537.6.12.2002) mukaiset arvot pois lukien koostenäkymien koodit.\nKs. sivu ValueSet (https://simplifier.net/guide/Hyvinvointisovellusten-rajapinta-potilastietoihin-FHIR-R4-implem/Etusivu/Koodistot/Valueset.page.md?version=current).</p>\n</div></td></tr><tr><td>IN</td><td>type</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Haettavan sisällön tyyppi, ValueSet fihrp-vs-searchtype.\nPalvelutapahtuma- ja hoitoasiakirjojen haussa arvo 1, Palvelutapahtuma- ja hoitoasiakirjojen haku.\nKs. sivu ValueSet (https://simplifier.net/guide/Hyvinvointisovellusten-rajapinta-potilastietoihin-FHIR-R4-implem/Etusivu/Koodistot/Valueset.page.md?version=current).</p>\n</div></td></tr></table></div>"
},
"url" : "https://clinibusdocumentation.atostek.com/OperationDefinition/Patient-hrp-document-search",
"version" : "0.1.8",
"name" : "HRP-DocumentSearch",
"title" : "HRP-DocumentSearch",
"status" : "draft",
"kind" : "operation",
"date" : "2025-02-11T14:40:52+02:00",
"publisher" : "Atostek",
"contact" : [
{
"name" : "Atostek",
"telecom" : [
{
"system" : "url",
"value" : "https://atostek.com/"
}
]
}
],
"description" : "The Werlfare API (HRP) Document Search (Asiakirjahaku) operation on the Patient resource.",
"code" : "HRP-DocumentSearch",
"resource" : [
"Patient"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "patient:identifier",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Potilaan virallinen henkilötunnus. Sekä system että code on annettava: patient:identifier=urn:oid:{system|code}.\r\n(system = virallisen henkilötunnuksen OID-juuri, '1.2.246.21', code = henkilötunnus)",
"type" : "string"
},
{
"name" : "author:identifier",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Asiakirjan laatineen organisaation OID-tunniste.\r\nOrganisaation tunnisteena käytetään Kansallisen koodistopalvelun (https://koodistopalvelu.kanta.fi/) organisaatiokoodistojen THL - SOTE-organisaatiorekisteri (1.2.246.537.6.202.2008) ja Valvira - Terveydenhuollon itsenäiset ammatinharjoittajat (1.2.246.537.6.203.2014) mukaisia arvoja.\r\nAnnetaan muodossa: author:identifier=urn:oid:{code}.\r\n(code = OID-tunniste)",
"type" : "string"
},
{
"name" : "effective-time",
"use" : "in",
"min" : 0,
"max" : "2",
"documentation" : "Asiakirjan luontiaika.\r\nHuom. effective-time ja period -hakuparametreja ei saa käyttää samassa haussa.",
"type" : "string"
},
{
"name" : "period",
"use" : "in",
"min" : 0,
"max" : "2",
"documentation" : "Palvelutapahtuman ajankohta.\r\nHuom. effective-time ja period -hakuparametreja ei saa käyttää samassa haussa.",
"type" : "string"
},
{
"name" : "category",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Asiakirjan näkymäkoodi, ValueSet fihrp-vs-documentreferencecategory. Käytössä Kansallisen koodistopalvelun (https://koodistopalvelu.kanta.fi/) koodiston AR/YDIN - Näkymät (1.2.246.537.6.12.2002) mukaiset arvot pois lukien koostenäkymien koodit.\r\nKs. sivu ValueSet (https://simplifier.net/guide/Hyvinvointisovellusten-rajapinta-potilastietoihin-FHIR-R4-implem/Etusivu/Koodistot/Valueset.page.md?version=current).",
"type" : "string"
},
{
"name" : "type",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Haettavan sisällön tyyppi, ValueSet fihrp-vs-searchtype.\r\nPalvelutapahtuma- ja hoitoasiakirjojen haussa arvo 1, Palvelutapahtuma- ja hoitoasiakirjojen haku.\r\nKs. sivu ValueSet (https://simplifier.net/guide/Hyvinvointisovellusten-rajapinta-potilastietoihin-FHIR-R4-implem/Etusivu/Koodistot/Valueset.page.md?version=current).",
"type" : "string"
}
]
}