ERA FHIR specification
1.0.0 - draft
ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-10-28 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="MedicationListFi-get-medication-custom-data-cns-narcotic"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition MedicationListFi-get-medication-custom-data-cns-narcotic</b></p><a name="MedicationListFi-get-medication-custom-data-cns-narcotic"> </a><a name="hcMedicationListFi-get-medication-custom-data-cns-narcotic"> </a><p>URL: [base]/$MedicationListFi-get-medication-custom-data</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>requestPurpose</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Coding">Coding</a></td><td/><td><div><p>Purpose of requesting medication information. Expressed using a code from the Kanta code system 'urn:oid:1.2.246.537.5.40110.2006' (Sähköinen lääkemääräys - Reseptikyselyn syy). Provide both the system and the code.</p>
</div></td></tr><tr><td>IN</td><td>serviceEventId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td><div><p>Identifier of a service event, if request is done from a open service event.</p>
</div></td></tr><tr><td>IN</td><td>patientIdentifier</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td><div><p>Identifier of the patient. Provide both the system 'urn:oid:1.2.246.21' and the identifier.</p>
</div></td></tr><tr><td>IN</td><td>cnsNarcotic</td><td/><td>1..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Coding">Coding</a></td><td/><td><div><p>The codes for narcotic and CNS drugs. All codes from the Kanta code system 'urn:oid:1.2.246.537.5.40118.2006' (Sähköinen lääkemääräys - Huumausaine / PKV lääkemääräys) need to be provided in every search. Provide both the system and the codes.</p>
</div></td></tr><tr><td>IN</td><td>authoredOn</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Period">Period</a></td><td/><td><div><p>Time period for which medication history is requested. The length of the time period can be at most 36 months, but the period can be at any point in the patient's medication history. If the parameter is not provided, the default search period is 36 months before the current time point. The accepted date format is YYYY-MM-DD.</p>
</div></td></tr><tr><td>IN</td><td>latestDispenseOnly</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Return only the latest dispense of a prescription (true) or all dispenses (false). In both cases, only the most recent version of the dispense is returned. By default, only the latest dispenses are returned.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>Kanta medication list</p>
</div></td></tr></table></div>
</text>
<url
value="https://eradocumentation.atostek.com/OperationDefinition/MedicationListFi-get-medication-custom-data-cns-narcotic"/>
<version value="1.0.0"/>
<name value="MedicationListFi-Get-Medication-Custom-Data-CNS-Narcotic"/>
<title
value="MedicationListFI Get Custom Medication Data - Narcotic Drugs and CNS Agents"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2026-10-28T11:52:12+00:00"/>
<publisher value="Atostek"/>
<contact>
<name value="Atostek"/>
<telecom>
<system value="url"/>
<value value="https://atostek.com/"/>
</telecom>
</contact>
<description
value="The search returns information about prescriptions of narcotic drugs and central nervous system agents and their dispensations, renewal requests, blocks, reservations, and discontinuation notes. Any restrictions set by the patient for sharing their personal health information don't affect this search.
The operation requires an active ERA session and the client registry ID. Please provide these in the request header.
The search result is stored in the client's registry in ERA's database and returned to the client. If the search is performed successfully but returns no results, an empty Bundle is returned."/>
<code value="MedicationListFi-get-medication-custom-data"/>
<system value="true"/>
<type value="false"/>
<instance value="false"/>
<parameter>
<name value="requestPurpose"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Purpose of requesting medication information. Expressed using a code from the Kanta code system 'urn:oid:1.2.246.537.5.40110.2006' (Sähköinen lääkemääräys - Reseptikyselyn syy). Provide both the system and the code."/>
<type value="Coding"/>
</parameter>
<parameter>
<name value="serviceEventId"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Identifier of a service event, if request is done from a open service event."/>
<type value="Identifier"/>
</parameter>
<parameter>
<name value="patientIdentifier"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Identifier of the patient. Provide both the system 'urn:oid:1.2.246.21' and the identifier."/>
<type value="Identifier"/>
</parameter>
<parameter>
<name value="cnsNarcotic"/>
<use value="in"/>
<min value="1"/>
<max value="*"/>
<documentation
value="The codes for narcotic and CNS drugs. All codes from the Kanta code system 'urn:oid:1.2.246.537.5.40118.2006' (Sähköinen lääkemääräys - Huumausaine / PKV lääkemääräys) need to be provided in every search. Provide both the system and the codes."/>
<type value="Coding"/>
</parameter>
<parameter>
<name value="authoredOn"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Time period for which medication history is requested. The length of the time period can be at most 36 months, but the period can be at any point in the patient's medication history. If the parameter is not provided, the default search period is 36 months before the current time point. The accepted date format is YYYY-MM-DD."/>
<type value="Period"/>
</parameter>
<parameter>
<name value="latestDispenseOnly"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Return only the latest dispense of a prescription (true) or all dispenses (false). In both cases, only the most recent version of the dispense is returned. By default, only the latest dispenses are returned."/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="Kanta medication list"/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>