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 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="patient-hrp-document-search"/>
<text>
<status value="generated"/>
<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}.
(system = virallisen henkilötunnuksen OID-juuri, '1.2.246.21', code = henkilötunnus)</p>
</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.
Organisaation 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.
Annetaan muodossa: author:identifier=urn:oid:{code}.
(code = OID-tunniste)</p>
</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.
Huom. effective-time ja period -hakuparametreja ei saa käyttää samassa haussa.</p>
</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.
Huom. effective-time ja period -hakuparametreja ei saa käyttää samassa haussa.</p>
</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.
Ks. sivu ValueSet (https://simplifier.net/guide/Hyvinvointisovellusten-rajapinta-potilastietoihin-FHIR-R4-implem/Etusivu/Koodistot/Valueset.page.md?version=current).</p>
</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.
Palvelutapahtuma- ja hoitoasiakirjojen haussa arvo 1, Palvelutapahtuma- ja hoitoasiakirjojen haku.
Ks. sivu ValueSet (https://simplifier.net/guide/Hyvinvointisovellusten-rajapinta-potilastietoihin-FHIR-R4-implem/Etusivu/Koodistot/Valueset.page.md?version=current).</p>
</div></td></tr></table></div>
</text>
<url
value="https://clinibusdocumentation.atostek.com/OperationDefinition/Patient-hrp-document-search"/>
<version value="0.1.8"/>
<name value="HRP-DocumentSearch"/>
<title value="HRP-DocumentSearch"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2025-02-11T14:40:52+02:00"/>
<publisher value="Atostek"/>
<contact>
<name value="Atostek"/>
<telecom>
<system value="url"/>
<value value="https://atostek.com/"/>
</telecom>
</contact>
<description
value="The Werlfare API (HRP) Document Search (Asiakirjahaku) operation on the Patient resource."/>
<code value="HRP-DocumentSearch"/>
<resource value="Patient"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="patient:identifier"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Potilaan virallinen henkilötunnus. Sekä system että code on annettava: patient:identifier=urn:oid:{system|code}.
(system = virallisen henkilötunnuksen OID-juuri, '1.2.246.21', code = henkilötunnus)"/>
<type value="string"/>
</parameter>
<parameter>
<name value="author:identifier"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Asiakirjan laatineen organisaation OID-tunniste.
Organisaation 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.
Annetaan muodossa: author:identifier=urn:oid:{code}.
(code = OID-tunniste)"/>
<type value="string"/>
</parameter>
<parameter>
<name value="effective-time"/>
<use value="in"/>
<min value="0"/>
<max value="2"/>
<documentation
value="Asiakirjan luontiaika.
Huom. effective-time ja period -hakuparametreja ei saa käyttää samassa haussa."/>
<type value="string"/>
</parameter>
<parameter>
<name value="period"/>
<use value="in"/>
<min value="0"/>
<max value="2"/>
<documentation
value="Palvelutapahtuman ajankohta.
Huom. effective-time ja period -hakuparametreja ei saa käyttää samassa haussa."/>
<type value="string"/>
</parameter>
<parameter>
<name value="category"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="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.
Ks. sivu ValueSet (https://simplifier.net/guide/Hyvinvointisovellusten-rajapinta-potilastietoihin-FHIR-R4-implem/Etusivu/Koodistot/Valueset.page.md?version=current)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="type"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Haettavan sisällön tyyppi, ValueSet fihrp-vs-searchtype.
Palvelutapahtuma- ja hoitoasiakirjojen haussa arvo 1, Palvelutapahtuma- ja hoitoasiakirjojen haku.
Ks. sivu ValueSet (https://simplifier.net/guide/Hyvinvointisovellusten-rajapinta-potilastietoihin-FHIR-R4-implem/Etusivu/Koodistot/Valueset.page.md?version=current)."/>
<type value="string"/>
</parameter>
</OperationDefinition>