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-printout-summary"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition MedicationListFi-get-printout-summary</b></p><a name="MedicationListFi-get-printout-summary"> </a><a name="hcMedicationListFi-get-printout-summary"> </a><p>URL: [base]/$MedicationListFi-get-printout</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>consentType</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Coding">Coding</a></td><td/><td><div><p>Type of consent received from the patient or his/her trustee. Expressed using a code from the Kanta code system 'urn:oid:1.2.246.537.5.40119.2006' (Sähköinen lääkemääräys - Suostumustyypit). 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>usageSituation</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Coding">Coding</a></td><td/><td><div><p>Mandatory parameter if the request is done on behalf of a minor. Expressed using a code from the Kanta code system 'urn:oid:1.2.246.537.6.882.201501' (Ajanvaraus - Yhteyshenkilön tyyppi). Provide both the system and the code.</p>
</div></td></tr><tr><td>IN</td><td>patientIdentifier</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 the patient. Provide both the system 'urn:oid:1.2.246.21' and the value (the patient id).</p>
</div></td></tr><tr><td>IN</td><td>medicineId</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td><div><p>Identifier of the medication currently in use.</p>
</div></td></tr><tr><td>IN</td><td>setId</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td><div><p>Identifier of a prescription document.</p>
</div></td></tr><tr><td>IN</td><td>discontinuedIncluded</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 information about medications that have been discontinued during the past year (true) or return no information about discontinued medications (false). The default option is false.</p>
</div></td></tr><tr><td>IN</td><td>language</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Language of the summary. The options are Finnish ('fi') and Swedish ('sv'). The default language is Finnish.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/documentreference.html">DocumentReference</a></td><td/><td><div><p>PDF</p>
</div></td></tr></table></div>
</text>
<url
value="https://eradocumentation.atostek.com/OperationDefinition/MedicationListFi-get-printout-summary"/>
<version value="1.0.0"/>
<name value="MedicationListFi-Get-Printout-Summary"/>
<title value="MedicationListFI Get Printout - Medication List Summary"/>
<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="Returns a summary of the patient's medication list. Either a patient identifier, medicine id or set id needs to be provided.
The operation requires an active ERA session and the client registry ID. Please provide these in the request header.
The operation returns a DocumentReference resource that contains the base64 encoded PDF printout in its Attachment element. The contents of the printout can be limited if the patient has restricted the sharing of their personal health information."/>
<code value="MedicationListFi-get-printout"/>
<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="consentType"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Type of consent received from the patient or his/her trustee. Expressed using a code from the Kanta code system 'urn:oid:1.2.246.537.5.40119.2006' (Sähköinen lääkemääräys - Suostumustyypit). 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="usageSituation"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Mandatory parameter if the request is done on behalf of a minor. Expressed using a code from the Kanta code system 'urn:oid:1.2.246.537.6.882.201501' (Ajanvaraus - Yhteyshenkilön tyyppi). Provide both the system and the code."/>
<type value="Coding"/>
</parameter>
<parameter>
<name value="patientIdentifier"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Identifier of the patient. Provide both the system 'urn:oid:1.2.246.21' and the value (the patient id)."/>
<type value="Identifier"/>
</parameter>
<parameter>
<name value="medicineId"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation value="Identifier of the medication currently in use."/>
<type value="Identifier"/>
</parameter>
<parameter>
<name value="setId"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation value="Identifier of a prescription document."/>
<type value="Identifier"/>
</parameter>
<parameter>
<name value="discontinuedIncluded"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Return information about medications that have been discontinued during the past year (true) or return no information about discontinued medications (false). The default option is false."/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="language"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Language of the summary. The options are Finnish ('fi') and Swedish ('sv'). The default language is Finnish."/>
<type value="string"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="PDF"/>
<type value="DocumentReference"/>
</parameter>
</OperationDefinition>