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 |
{
"resourceType" : "OperationDefinition",
"id" : "MedicationListFi-get-medication-custom-data-by-author",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition MedicationListFi-get-medication-custom-data-by-author</b></p><a name=\"MedicationListFi-get-medication-custom-data-by-author\"> </a><a name=\"hcMedicationListFi-get-medication-custom-data-by-author\"> </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>\n</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>\n</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 value (the actual patient id).</p>\n</div></td></tr><tr><td>IN</td><td>assignAuthorId</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 author (Doctor ID, previously known as health insurance number or SV number).</p>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
},
"url" : "https://eradocumentation.atostek.com/OperationDefinition/MedicationListFi-get-medication-custom-data-prescriptions-by-author",
"version" : "1.0.0",
"name" : "MedicationListFi-Get-Medication-Custom-Data-Prescriptions-By-Author",
"title" : "MedicationListFI Get Custom Medication Data - Prescriptions Created by the Author",
"status" : "draft",
"kind" : "operation",
"date" : "2026-10-28T11:52:12+00:00",
"publisher" : "Atostek",
"contact" : [
{
"name" : "Atostek",
"telecom" : [
{
"system" : "url",
"value" : "https://atostek.com/"
}
]
}
],
"description" : "The search returns information about prescriptions that are prescribed by the author and the dispensations, renewal requests, blocks, reservations, and discontinuation notes of these prescriptions. Any restrictions set by the patient for sharing their personal health information don't affect this search.\n\nThe 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" : "MedicationListFi-get-medication-custom-data",
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "requestPurpose",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "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" : "Coding"
},
{
"name" : "serviceEventId",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Identifier of a service event, if request is done from a open service event.",
"type" : "Identifier"
},
{
"name" : "patientIdentifier",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Identifier of the patient. Provide both the system 'urn:oid:1.2.246.21' and the value (the actual patient id).",
"type" : "Identifier"
},
{
"name" : "assignAuthorId",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Identifier of the author (Doctor ID, previously known as health insurance number or SV number).",
"type" : "Identifier"
},
{
"name" : "authoredOn",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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" : "Period"
},
{
"name" : "latestDispenseOnly",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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" : "boolean"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Kanta medication list",
"type" : "Bundle"
}
]
}