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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| ERA Capability Statement |
This is the Capability Statement for ERA FHIR interface. This Capability Statement defines a set of resources, operations, and search parameters that the ERA FHIR server supports. |
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| AppointmentFi Search From Kanta |
The operation can be used to search for appointments from the Kanta Patient Data Repository. The operation requires an active ERA session and the client registry ID. Please provide these in the request header. |
| Archive To Kanta |
The operation can be used to archive resources to the Kanta Patient Data Repository. A system signature is created for the resources before archiving. The only operation parameter is a Provenance resource that provides meta information about the target resource that is to be archived. For appointments, the Provenance resource needs to conform to the EraAppointmentProvenance profile. |
| Begin Personal Signature |
The operation generates signable documents of listed resources and saves them as DocumentReference resources that reference the original resources. The operation returns a Task resource with information about the resources and command data with necessary parameters for signing. MedicationRequests: All MedicationRequests that are prepared for signing need to have a status 'draft' and be prescribed for the same patient by the author who makes the request. |
| DIPKO Digital Health Service - Dispense |
Kirjaa digisovellusmääräyksen (DigitalHealthServiceRequest) lunastuksen: siirtää määräyksen tilasta active tilaan completed ja luo palvelinpuolella Provenance-resurssin. Palauttaa päivitetyn määräyksen ja viittauksen luotuun Provenance-resurssiin. Vain lähtötila active sallitaan. |
| DIPKO Digital Health Service - List Requests |
Listaa digisovellusmääräykset (DigitalHealthServiceRequest), jotka kohdistuvat annettuun katalogisovellukseen. Mahdollistaa rajauksen määräyksen tilan ja potilaan perusteella. Tarkoitettu sovellustarjoajien järjestelmille. |
| Get KVP relay request |
The operation can be used to fetch relay requests of a given document. |
| MedicationListFI Generate Dosage Instructions |
The operation generates dosage instructions in text format from structured prescription information. Only elements related to dosage instructions are validated and used from the provided resource. The operation doesn't save the results in ERA's database. The desired language of the dosage instructions needs to be provided in the language element of the provided resource. The resource should be a MedicationRequest resource that conforms to the MedicationListMedicationRequest profile of Kanta Services. |
| MedicationListFI Get Custom Medication Data - Narcotic Drugs and CNS Agents |
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. |
| MedicationListFI Get Custom Medication Data - Prescriptions Created by the Author |
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. 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. |
| MedicationListFI Get Custom Medication Data - Prescriptions With a Certain ATC Code |
The search returns information about prescriptions and their dispensations. The search results can be limited if the patient has restricted the sharing of their personal health information. 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. |
| MedicationListFI Get Discontinued Medications |
The operation makes a request to the Kanta Prescription Centre and retrieves a list of discontinued medications and completed discontinuation notes. In addition, the latest dispense records and prescriptions that have been cancelled for a therapeutic reason are returned. 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. The search results can be limited if the patient has restricted the sharing of their personal health information. |
| MedicationListFI Get History Medications |
The operation makes a request to the Kanta Prescription Centre and retrieves the complete history of the selected medications. This includes information about prescriptions, discontinuation notes, and dispenses. The search is patient-specific. 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. |
| MedicationListFI Get Medication List |
The operation performs a request to the Kanta Prescription Centre and retrieves a list of the current medication of the patient. This list includes most recent versions of prescriptions that are currently in use, their most recent renewal requests, and information about blocks, reservations, and the most recent dispenses. Also, medications that have been discontinued during the past year and prescriptions cancelled no more than a year ago are returned. If the medication has an active discontinuation note, it will be returned as well. 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. The search results can be limited if the patient has restricted the sharing of their personal health information. The operation returns a Parameters resource that contains a Bundle with information about the patient's current medication. During a transition period, the Parameters resource may also contain a second Bundle with a list of medications that have been prescribed to the patient without identifiers of current use. If the search is performed successfully but returns no results, an empty Bundle is returned. |
| MedicationListFI Get Old Prescriptions |
The operation makes a request to the Kanta Prescription Centre and retrieves a list of all prescriptions without identifiers of the medication being currently in use (= prescriptions created before the Kanta medication list specification). Information about renewal requests, blocks, reservations, and dispenses is also returned. 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. The search results can be limited if the patient has restricted the sharing of their personal health information. |
| MedicationListFI Get Printout - Medication List Summary |
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. |
| MedicationListFI Get Printout - Patient Instructions |
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. |
| MedicationListFI Get Printout - Transcript for Purchase Abroad |
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. |
| MedicationListFI Get Printout - Transcript for Travel Abroad |
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. |
| MedicationListFi Current Local Medication List |
The operation returns the current version of the patient's medication list that is stored in ERA. The medication list includes results of searches made in the Kanta Prescription Centre and local changes. |
| MedicationListFi Generate Medication For MedicationRequest |
The operation converts a medication in the medication database to Medication and MedicationKnowledge resources that conform to the profiles by Kanta Services (MedicationListMedication, MedicationListMedicationKnowledge). These resources can be used as references in a MedicationRequest that is to be sent to the Kanta Prescription Centre. The operation targets a MedicationKnowledge type instance in the medication database. |
| MedicationListFi Validate Local Medication List |
The operation can be used to validate performed medication changes against the local version of the medication list stored in ERA. |
| MedicationListFi Validate Medication List Modification |
The operation can be used to validate whether a certain medication change would be allowed. The validation is performed against the local version of the medication list stored in ERA. |
| Send KVP Relay Request |
Send a relay request to Kysely- ja välityspalvelu (KVP). |
| Update Personal Signature |
The operation attaches a signature to the documents that are the target of the referenced Task resource, and generates a Provenance for each signed resource. The operation returns the finalized Task resource and Provenance resources for the signed documents. |
These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.
| ERA ATC Code SearchParameter |
Search parameter for medication ATC code value in ERA FHIR server |
| ERA AtcNameFi SearchParameter |
Search parameter for medication ATC code Finnish display name value in ERA FHIR server |
| ERA AtcNameSv SearchParameter |
Search parameter for medication ATC code Swedish display name value in ERA FHIR server |
| ERA Database Version SearchParameter |
Search parameter for medication drug database version in ERA FHIR server |
| ERA Drug Group SearchParameter |
Search parameter for medication drug group value in ERA FHIR server |
| ERA EffectiveTime SearchParameter |
Search parameter for document's effectiveTime value in ERA FHIR server |
| ERA Medicine Identifier SearchParameter |
Search parameter for medicine identifier in ERA FHIR server |
| ERA Product Strength SearchParameter |
Search parameter for medication product strength in ERA FHIR server |
| ERA ProductName SearchParameter |
Search parameter for medication productName value in ERA FHIR server |
| ERA ServiceEvent SearchParameter |
Search parameter for service event (encounter) identifier in ERA FHIR server |
| ERA Substitution Group Code SearchParameter |
Search parameter for medication substitution group code value in ERA FHIR server |
| ERA Validity SearchParameter |
Search parameter for list validity period in ERA FHIR server |
| ERA Version SearchParameter |
Search parameter for list release version in ERA FHIR server |
| Task Input Reference |
Allows searching Task resources by a Reference value carried in Task.input.value[x] — e.g. finding the Task(s) associated with a given signable resource such as a MedicationRequest. |
| digitalhealthservice-category |
Hakuparametri: DigitalHealthService-sovelluksen kategoria. |
| digitalhealthservice-name |
Hakuparametri: DigitalHealthService-sovelluksen nimi. |
| digitalhealthservice-registerType |
Hakuparametri: DigitalHealthService-sovelluksen rekisterin tyyppi. |
| digitalhealthservicerequest-dhs-identifier |
Search DeviceRequest by Digital Health Service identifier |
These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles but do not declare conformance to the abstract profiles themselves.
| KantaPractitioner |
Practitioner profile used in Kanta Services. The profile provides the information of a practitioner. Source |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| AppointmentAppointment |
Appointment profile used in appointment booking. |
| AppointmentBookerOnBehalfOf |
The profile is used when the appointment booking has been made by a person acting on behalf of the customer. |
| AppointmentBookerPatient |
The profile is used to indicate the person making the appointment booking when the appointment booking has been made by the customer. |
| AppointmentHealthcareService |
HealthcareService profile used in appointment booking. The profile conveys the details of the subject of the appointment. |
| AppointmentLocation |
Location profile used in appointment booking. The profile is used to convey the location details of the service point. |
| AppointmentMitatointiProvenance |
Provenance profile used in appointment invalidation. |
| AppointmentOrganization |
Organization profile used in appointment booking. The profile conveys the details of the unit providing the service booked in the reservation and of the service provider. |
| AppointmentPatient |
Patient profile used in appointment booking. |
| AppointmentPractitioner |
Practitioner profile used in appointment booking. The profile is used when the appointment booking has been made by a professional. |
| AppointmentProvenance |
Provenance profile used in appointment booking. |
| DIPKO Device Definition |
DIPKO-omisteinen DeviceDefinition-pohjainen profiili, joka noudattaa Kanta-tyylisiä konventioita (FI-jurisdiction ja UDI-identifier-slicing EUDAMED-OID:llä). Pohjaprofiili katalogiresursseille, jotka tarvitsevat Kanta-yhteensopivuuden. |
| DIPKO Digital Health Service |
Digisovellus, joka voidaan määrätä potilaalle. Profiili pohjautuu DeviceDefinition-resurssiin ja kuvaa katalogissa olevan sovelluksen tunnistetiedot, vastuutahon ja kategorian. |
| DIPKO Digital Health Service Provenance |
Lunastuksen jäljitettävyyskirjauksen Provenance-profiili. Lisää Kanta-yhteensopivan rekisteritunnuksen (RegisterType, pakollinen) ja ehdollisen tarkenteen (RegisterSpecifier) mallintamalla ERAn AppointmentProvenance-ratkaisua. RegisterSpecifier vaaditaan täsmälleen silloin kun RegisterType on työterveys (koodi 4). |
| DIPKO Digital Health Service Request |
Digisovellusmääräys: ammattilaisen potilaalle tekemä määräys, joka kohdistuu katalogissa olevaan DigitalHealthService-sovellukseen. Pohjautuu DeviceRequest-resurssiin; auktoritatiivinen katalogiviittaus tehdään DigitalHealthServiceReference-laajennuksella, koska FHIR R4:n DeviceRequest.code[x] Reference-target sallii vain Reference(Device). |
| EraAppointmentAppointment |
Appointment profile used in the ERA interface for creating and updating appointments. Based on the Kanta Services profile AppointmentAppointment. |
| EraAppointmentHealthcareService |
HealthcareService profile used in the ERA interface for appointment booking. Based on the Kanta Services profile AppointmentHealthcareService. The profile conveys the details of the subject of the appointment. |
| EraAppointmentMitatointiProvenance |
Provenance profile used in the ERA interface for appointment invalidation. Based on the Kanta Services profile AppointmentMitatointiProvenance. |
| EraAppointmentProvenance |
Provenance profile used in the ERA interface for appointment booking. Based on the Kanta Services profile AppointmentProvenance. |
| EraDrugDatabaseFiList |
A profile for the Finnish drug database in ERA interface. |
| EraDrugDatabaseFiMedicationKnowledge |
A profile on MedicationKnowledge for an item in the Finnish drug database. |
| EraMedicationListDiscontinuationMedicationRequest |
EraMedicationListDiscontinuationMedicationRequest profile that is used with Kanta medication list in ERA interface. It contains the details of prescription discontinuation. Based on the Kanta profile MedicationListDiscontinuationMedicationRequest. Source |
| EraMedicationListMedication |
EraMedicationListMedication profile that is used with Kanta medication list in ERA interface. Based on the Kanta profile MedicationListMedication. Source |
| EraMedicationListMedicationDispense |
EraMedicationListMedicationDispense profile that is used with Kanta medication list in ERA interface. Based on the Kanta profile MedicationListMedicationDispense. Source |
| EraMedicationListMedicationRequest |
EraMedicationListMedicationRequest profile that is used for Finnish prescriptions in ERA interface. Based on the Kanta profile MedicationListMedicationRequest. Source |
| EraMedicationListOrganization |
EraMedicationListOrganization profile that is used with Kanta medication list in ERA interface. Based on the Kanta profile MedicationListOrganization. Source |
| EraMedicationListPractitioner |
EraMedicationListPractitioner profile that is used with Kanta medication list in ERA interface. Based on the Kanta profile MedicationListPractitioner. Source |
| EraMedicationListPractitionerRole |
EraMedicationListPractitionerRole profile that is used with Kanta medication list in ERA interface. Based on the Kanta profile MedicationListPractitionerRole. Source |
| EraMedicationListProvenance |
EraMedicationListPractitioner profile that is used with Kanta medication list in ERA interface. Based on the Kanta profile MedicationListProvenance Source |
| EraMedicationListRenewalBasic |
EraMedicationListRenewalBasic profile that is used with Kanta medication list in ERA interface. Contains information of a renewal request or of a response to a renewal request. Based on the Kanta profile MedicationListRenewalBasic. Source |
| EraMedicationListStatusBasic |
EraMedicationListStatusBasic profile that is used with Kanta medication list in ERA interface. Contains information about various prescription reservations/locks. Based on the Kanta profile MedicationListStatusBasic. Source |
| EraRequestContextBasic |
Captures the context of an action or operation: the practitioner involved, how they were identified for this request, and the organization relationship/connection model in effect (via OrganizationAffiliation). Generated and owned internally by server operations; not directly writable by clients. |
| EraSignatureProvenance |
Provenance record generated by the signing workflow, linking a signable resource and its generated DocumentReference to the signing event, practitioner/device agent, and shared RequestContext. Generated and owned internally by server operations; not directly writable by clients. |
| EraSignatureTask |
Task representing a signing workflow instance over one or more signable resources, created by operation Begin Personal Signature and finalized by Update Personal Signature. Generated and owned internally by server operations; not directly writable by clients. |
| KVPPatient |
Kysely- ja välityspalvelussa käytettävä Patient-profiili. Henkilö, jota välitettävä asiakirja koskee. |
| KVPPractitioner |
KVP:ssa käytettävä Practitioner-profiili. Välityspyynnön tehnyt henkilö. |
| KantaDevice |
Kanta-palveluissa käytettävä Device-profiili. Profiilia käytetään, kun ilmoitetaan resurssin tallentaneen ohjemiston, tietojärjestelmän tai lääkinnällisen laitteen tiedot. |
| KantaPatient |
Kanta-palveluissa käytettävän Patient resurssin pohjaprofiili. Kukin palvelu tarkentaa tähän pohjautuen palvelukohtaiset tarkennukset. Source |
| MedicationListDiscontinuationMedicationRequest |
MedicationListDiscontinuationMedicationRequest profile is used with Kanta medication list and it contains the details of prescription discontinuation. Source |
| MedicationListDocumentReference |
MedicationListDocumentReference profile, used with Kanta medication list printouts. Source |
| MedicationListList |
The MedicationListList profile is used with Kanta medication list. Source |
| MedicationListMedication |
MedicationListMedication profile is used with Kanta medication list. Source |
| MedicationListMedicationDispense |
MedicationListMedicationDispense profile that is used with Kanta medication list. Source |
| MedicationListMedicationKnowledge |
MedicationListMedicationKnowledge profile used with the Kanta medication list. Source |
| MedicationListMedicationRequest |
Lääkityslistan palautuksessa käytettävä MedicationListMedicationRequest-profiili. Source |
| MedicationListOrganization |
Lääkityslistan palautuksessa käytettävä MedicationListOrganization-profiili. Source |
| MedicationListPatient |
Lääkityslistan palautuksessa käytettävä MedicationListPatient-profiili. Source |
| MedicationListPractitioner |
Lääkityslistan palautuksessa käytettävä MedicationListPractitioner-profiili. Source |
| MedicationListPractitionerRole |
Lääkityslistan palautuksessa käytettävä MedicationListPractitionerRole-profiili. Source |
| MedicationListProvenance |
Lääkityslistan palautuksessa käytettävä MedicationListProvenance-profiili. Source |
| MedicationListRenewalBasic |
Lääkityslistan palautuksessa käytettävä MedicationListRenewalBasic-profiili, jossa tuodaan uusimispyynnön tai uusimispyynnön vastauksen tiedot. Source |
| MedicationListStatusBasic |
Lääkityslistan palautuksessa käytettävä MedicationListStatusBasic-profiili, jossa tuodaan eri varausten/lukituksen tiedot. Source |
| MitatointiProvenance |
Provenance profile used in Kanta Services for invalidating a resource. |
| Valityspyynto |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Additional Information URL |
Additional information address |
| AppointmentMutabilityNotAfter |
Deadline for cancellation or rescheduling |
| AppointmentReason |
The extension indicates the reason for the appointment: information provided by the customer, the main reason for booking, and the professional's assessment of the customer's service need. |
| AppointmentType |
The extension indicates the mode of transaction. |
| Booking Deadline |
Date and time by which the appointment is instructed to be made at the latest |
| Careplan Identifier |
Identifier of the plan related to the appointment |
| Child Appointment |
Sub-appointment identifier |
| Customer Journey |
Customer's service pathway |
| DIPKO Digital Health Service Fulfilled DateTime |
Digisovellusmääräyksen lunastushetki (sama aikaleima kuin lunastuksen yhteydessä luodun Provenance-resurssin recorded-kenttä). Tallennetaan suoraan DigitalHealthServiceRequest-resurssiin, jotta lunastusaika on saatavilla ilman erillistä Provenance-hakua. Asetetaan DigitalHealthService-dispense-operaatiossa tilasiirtymän active → completed yhteydessä. |
| DIPKO Digital Health Service Reference |
Auktoritatiivinen viittaus katalogin DigitalHealthService-sovellukseen DeviceRequest-pohjaisessa määräyksessä. Tarvitaan koska FHIR R4:n DeviceRequest.code[x] ei salli Reference(DeviceDefinition)-targetia. |
| DIPKO Digital Health Service Shipping Contact |
Fyysisen toimituksen (esim. mittarin postitus) osoite- ja yhteystiedot digisovellusmääräyksessä. Mallinnetaan määräyksen omana laajennuksena, ei Patient-resurssin address/telecom-tietoina, jotta toimitustieto pysyy määräyskohtaisena ja voi poiketa potilaan kotiosoitteesta. Koko laajennus ja sen alaelementit (address, phone, email) ovat valinnaisia. |
| Document Format |
The document format produced for all outputs of this Task (e.g. CDA R2). Constant across all DocumentReferences generated within a single Task. |
| Extension pharmaceuticalProductStrength |
Valmisteen vahvuus ja yksikkö tekstinä Source |
| Extension renewalBasicReference |
Viittaus MedicationRequestista Basiciin (MedicationListRenewalBasic). Source |
| Extension additionalInformation |
Further clarification of the drug dispensation to Kela Source |
| Extension additionalPackage |
Data of different package sizes Source |
| Extension administrativeInformation |
Administrative data of the prescription: Doctor's fee Doctor's fee as a specialist Origin of prescription saved in a pharmacy Reasoning code of prescription saved in a pharmacy Further explanation of the prescription saved in a pharmacy Care type Dose dispensing Identification of the patient Source |
| Extension adverseEffect |
The adverse effect of the drug Source |
| Extension amountFormula |
The dispensed amount of the drug as a calculation formula Source |
| Extension amountOfPackages |
Number of dispensed drug packages. Source |
| Extension amountText |
The dispensed amount of the drug as text. Source |
| Extension availabilityDisruption |
Indicates that there is a disruption in the availability of the medicine. |
| Extension boundsDurationStartDate |
Start date of the dosing period when the duration is a constant value Source |
| Extension boundsRangeStartDate |
The start date of the dosing period when the duration is a value range Source |
| Extension changeInfo |
Indicates that the product information has changed from the previous version of the Drug Database. |
| Extension comment |
An explanation of the entry Source |
| Extension contagiousDiseaseMedicine |
A drug under the Communicable Diseases Act Source |
| Extension continuum |
Identifiers of medicine continuum: The identifier of the medicine in use and part identifier of medicine continuum. Status information 'Latest'. Source |
| Extension cost |
The price of dispensation Source |
| Extension databaseVersion |
Drug database version. |
| Extension dispensationRequiresPrescription |
Dispensing the product requires a prescription. |
| Extension dispenserInstruction |
Message to the pharmacy. Source |
| Extension dividingLine |
Dividing line information for a medication product. |
| Extension dosageChanges |
Additional information on the change and correction of medication: Justification of the correction of prescription Additional notes for the correction of prescription The reason for the change in medication Further information on the change in medication Source |
| Extension dosageIfNeeded |
Dosage if needed Source |
| Extension dosageInfo |
The weight of a patient under 12 years of age Sic! notation The reason for the Sic! notation Additional information on the Sic! notation Dosage instructions only as text Source |
| Extension dosageUnit |
Extension for expressing dosage unit using code system 1.2.246.537.6.138.202001 "Sähköinen lääkemääräys - Annosyksikkö". |
| Extension dosePackaging |
Dose dispensing information Source |
| Extension drugDatabaseFiReleaseVersion |
The release version of a Finnish Drug Database instance. |
| Extension effectiveTime |
The creation time of a document Source |
| Extension exitingMarket |
The medicinal product is exiting the market. |
| Extension expensiveMedicine |
Indicates that the medicine is expensive. |
| Extension extraDispenseCompleted |
Tieto onko lääkemääräykseen tehty poikkeustoimitus. Arvo on true, jos poikkeustoimitus on tehty. |
| Extension fullyDispensed |
A fully dispensed -entry Source |
| Extension humanMedicine |
A medicine intended for humans. |
| Extension infoText |
The additional information written by a doctor Source |
| Extension initiationOfMedication |
This is the initiation of a medication Source |
| Extension invalidation |
Additional information about prescription invalidation: Type of prescription invalidation, Additional information about the invalidation, Invalidator of the prescription, Consent for the invalidation Source |
| Extension itemName |
Name of a medicinal product outside the drug database Source |
| Extension limitedPrescriptionRight |
Complex extension for expressing limited prescription right information. |
| Extension marketer |
Marketer of the medicinal product. |
| Extension marketingAuthorizationHolder |
Marketing authorization holder Source |
| Extension marketingAuthorizationNumber |
Marketing authorization number. |
| Extension medicationKnowledgeReference |
Reference from Medication to MedicationKnowledge. Source |
| Extension medicinePauseInterval |
Lääke tauolla Source |
| Extension narcotic |
Narcotic Source |
| Extension note |
Kirjaajan antama viesti Source |
| Extension originalStartdate |
Lääkkeen alkuperäinen aloituspäivä. Source |
| Extension packageAmountText |
Information about the amount of medicine contained in one medicine package as text. Source |
| Extension packageFactor |
Package size factor. Source |
| Extension parallelImportProduct |
This extension indicates whether the product is a parallel-imported medicinal product. |
| Extension partialPackage |
Osapakkaus. Source |
| Extension patientInformed |
Tieto potilaan informoinnista Source |
| Extension patientTelecom |
Potilaan puhelinnumero Source |
| Extension prescribedAmount |
Määrätyn määrän esittämistapa, Pakkausten lukumäärä, Lääkkeen kokonaismäärä ja määrän yksikkö, Lääkkeen määrä ajanjaksolla ilmaistuna Source |
| Extension prescriptionCondition |
Prescription condition for a medication. |
| Extension prescriptionSetId |
Lääkemääräyksen alkuperäisen asiakirjan tunniste (setId), johon lääketoimitus liittyy. Source |
| Extension previousDispenseChange |
Laajennos sisältää toimitetun valmisteen tietoja kauppanimen muutospäivän perusteella. Toimituksen kauppanimen muutospäivä, kauppanimen muutospäivänä toimitetun valmisteen VNR-numero ja kauppanimi, kauppanimen muutospäivänä toimitetun valmisteen vahvuus, kauppanimen muutospäivänä toimitetun valmisteen lääkemuoto. Source |
| Extension priceChange |
Indicates that the price information has changed from the previous version of the Drug Database. |
| Extension productAtc |
ATC classification code for a medication product. |
| Extension productInformation |
Additional information about the medicinal product and package. Source |
| Extension productName |
Uncoded trade name of the medicinal product Source |
| Extension productStrength |
Pharmaceutical product strength and unit. |
| Extension quantityText |
Ainesosan määrä tekstinä. Source |
| Extension realDispenseStatus |
Todellinen toimitustila Source |
| Extension reasonCodeBiologicalMedicine |
Luokiteltu syy muun kuin edullisimman biologisen lääkkeen käytölle. Source |
| Extension reasonTextBiologicalMedicine |
Perustelu muun kuin edullisimman biologisen lääkkeen käytölle. Source |
| Extension reimbursementCondition |
Extension for expressing reimbursement condition for a reimbursement class medicine classification. |
| Extension remainingAmount |
Lääkemääräyksellä jäljellä oleva määrä Source |
| Extension renewalNotAllowed |
Reseptin uusimiskielto ja Reseptin uusimikiellon perustelu. Source |
| Extension renewalRecorder |
Uusimispyynnön tallentaja Source |
| Extension separateReport |
Erillisselvitys ja erillisselvitykseen liittyvä päivämäärä. Source |
| Extension sourceSchemaUri |
The schema for a Finnish Drug Database instance. |
| Extension specialReport |
Extension for expressing special report information for a reimbursement class medicine classification. |
| Extension statusBasicReference |
Viittaus MedicationRequestista Basiciin (MedicationListStatusBasic). Source |
| Extension statusInformation |
Lääkemääräyksen tilatiedot: Lääkemääräyksen lukitustila, Lääkemääräyksen varaustila, Uusimispyynnön tila ja Lääkemääräyksen toimitustila. Jos Historiahaussa ja Historiahaussa ilman käytössä olevan lääkkeen tunnisteita palautuu lääkemääräyksen vanhoja versioita, näille vanhoille versioille ei palauteta tätä laajennosta. Source |
| Extension stopDate |
Lääkkeen lopetuspäivä Source |
| Extension stopReasonCode |
Lääkkeen lopetuksen syy Source |
| Extension stopReasonText |
Lääkkeen lopetuksen lisätiedot Source |
| Extension structuredIndication |
Lääkkeen indikaatio rakenteisena Source |
| Extension substitutionInfo |
Complex extension containing substitution information for a medication. |
| Extension totalDispensedAmount |
Lääkemääräyksellä yhteensä toimitettu määrä Source |
| Extension usage |
Lääkkeen käyttötarkoitus tekstinä Source |
| Extension useRegularity |
Lääkkeen käytön säännöllisyys. Source |
| Extension vatCode |
Value added tax code. |
| Extension versionNumber |
Asiakirjan versio Source |
| Extension wholesalerProductNumber |
Wholesaler product number for a medicinal product. |
| Kanta Practitioner Authentication Method extension |
Laajennoksella ilmoitetaan tunnistautumistapa, jolla ammattihenkilö on kirjautunut tietojärjestelmään. |
| Kanta Practitioner Title extension |
PractitionerTitle-laajennoksella ilmoitetaan ammattihenkilön virka- tai tehtävänimike organisaatiossa. |
| Kanta Service Event extension |
Service event identifier Source |
| Kanta Services Record status extension |
A common extension for Kanta Services that reports the status of a resource stored in Kanta Services. |
| Kanta Services Register Type extension |
Register identifier |
| Notification Medium |
Reminder method |
| OfficialCommunicationLanguage |
Official communication language |
| Organization Affiliation |
A reference to the OrganizationAffiliation describing the subscribing/requesting organization relationship and connection model in effect at the time of this request context. |
| Patient Instruction URL |
Link to patient instructions |
| Practitioner Gender |
Gender of the service provider |
| Practitioner Identification Method |
The method by which the practitioner's identity was established for this specific request context (event-specific, not a persistent attribute of Practitioner itself). |
| Queue Number |
Queue number (string) |
| RegisterSpecifier |
The extension indicates the register specifier. In the occupational healthcare register, the specifier is used to indicate to which employer's occupational healthcare the information relates. The register specifier is the employer's OID identifier formed from the Business ID. If no Business ID exists, an official personal identity code or an employer number specific to the occupational healthcare service provider may be used. |
| ReleaseDateForPatientViewing |
The extension indicates the end date of the delay, i.e. the first day on which the delayed document may be shown in MyKanta. |
| RemoteServiceURL |
Link for joining the remote service. This field contains a link through which the customer can start the booked remote service, such as a remote consultation. |
| Request Context Practitioner |
The practitioner associated with this request context (e.g. the signer). |
| Request Context Reference |
A reference to the RequestContext (Basic) resource describing the request-level information related to the request. |
| RequestedService |
The extension indicates the requested service of the appointment. |
| Resource Retention Time |
The instant in time until which this resource must be retained by the receiving system. |
| ResourceCalendar |
The extension indicates the calendar identifier, resource name, and profession of the resource booked in the appointment. |
| RestrictionParent |
The extension indicates, using the THL Classification for Disclosure of a Minor Patient's Information to Guardians (THL - Alaikäisen potilastietojen luovuttaminen huoltajille), whether guardians have the right to view their minor child's appointment information in MyKanta and whether disclosure of the appointment information to them is permitted in healthcare services. |
| Self Service Information |
Extension used in appointment booking to indicate:
|
| ServiceAdditionalInformation |
The extension indicates additional information on further care or the service process as free text. |
| ServiceNeed |
The extension indicates the service need. |
| Signature Command Data |
A coded command type together with its associated string value, used to convey signature-device-dependent command or validation data on a Task. |
| TableOfContents |
The extension indicates, using the AR/YDIN Views (AR/YDIN - Näkymät) classification, information used in healthcare patient information systems to link recorded data to a specific content area or care entity, such as a medical specialty, professional field, or service-related treatments. |
| TicketNumber |
This field contains an identifier used to perform follow-up actions on the appointment. The ticket is a simple character string or word used, for example, to cancel or reschedule the appointment in an electronic service or by phone. |
| Validation Area |
The validation area/jurisdiction (e.g. 'fi', 'sv') applied to all signable resources processed by this Task. Constant across the whole Task. |
These define sets of codes used by systems conforming to this implementation guide.
| DIPKO Digital Health Service Category |
ValueSet, joka sisältää kaikki DIPKO-pilotin sovelluskategoriat. |
| DIPKO Digital Health Service Request Status |
DIPKO-määräyksen sallitut statusarvot. Rajaa FHIR-perusarvojoukosta pois 'unknown'-arvon, joka ei sovi digisovellusmääräyksen elinkaareen. |
| Finnish Drug Database Status |
Restricted set of allowed List statuses for Finnish drug database. 'current' means the list is considered active within its effective validity period. 'retired' means the list has been replaced with a new version and should no longer be considered accurate. |
| Value Set Kanta Provenance Role Category |
The value set used to indicate the role category of a provenance actor in Kanta services. The value set includes all values from the Kanta Provenance Role Category code system. |
| fipta-vs-appointmentstatus |
The value set that contains the appointment statuses that can be archived in the Patient Data Repository. The appointment status is expressed using a value from the code system http://hl7.org/fhir/appointmentstatus that corresponds to the values of the code system Appointment – Appointment status (Ajanvaraus – Ajanvarauksen tila) (1.2.246.537.6.881.201501). The mappings between the code systems are described in the implementation guide (https://simplifier.net/guide/Kanta-Potilastietovaranto-Ajanvaraus-R4/Etusivu/FHIR-Artefaktit/AppointmentAppointment). |
| fipta-vs-appointmenttype |
The value set used to indicate the method of contact. The value set includes all values from the THL - Contact Method (THL - Yhteystapa) code system (1.2.246.537.6.1308.202501). |
| fipta-vs-appointmenttypecategory |
The value set used in the Appointment profile to indicate the participant’s role. The value set includes all values from the fipta-cs-appointmenttypecategory code system. |
| fipta-vs-cancelationreason |
The value set used to indicate the reason for canceling an appointment. The value set includes all values from the THL - Reason for cancellation or rescheduling of a service event (THL - Palvelutapahtuman peruuntumisen tai siirtymisen syy) code system (1.2.246.537.6.126.2008). |
| fipta-vs-contactreason |
The value set used to indicate the reason for contact. The value set includes all values from the THL/SNOMED CT - Health problems and reasons for contact (THL/SNOMED CT - Terveysongelmat ja kontaktien syyt) code system (1.2.246.537.6.355.202001). |
| fipta-vs-contactrelationship |
The value set used to indicate the type of contact person in an appointment. The value set includes all values from the Appointment - Contact Person (Ajanvaraus - Yhteyshenkilö) code system (1.2.246.537.6.882.201501). |
| fipta-vs-deletereason |
The value set used to indicate the reason for invalidating an appointment. The value set includes all values from the eArchive - Document Deletion Reason (eArkisto - Asiakirjan korvauksen syy) code system (1.2.246.537.5.40178.2008). |
| fipta-vs-detailedcontent |
The value set used to indicate the content specification of a booking. The value set includes all values from the code systems Kuntaliitto - Laboratory Test Nomenclature (Kuntaliitto - Laboratoriotutkimusnimikkeistö) (1.2.246.537.6.3.2006) and THL - Procedure Classification (THL – Toimenpideluokitus) (1.2.246.537.6.2.2007). |
| fipta-vs-gender |
The value set used to indicate the service provider’s gender. The value set includes all values from the code system AR/YDIN – Gender (AR/YDIN – Sukupuoli) (1.2.246.537.5.1.1997). |
| fipta-vs-notificationmedium |
The value set used to indicate the medium of notification. The value set includes all values from the code system THL – Communication Channel (THL – Viestintäkanava) (1.2.246.537.6.883.201501). |
| fipta-vs-organization |
The value set used to indicate the organization. The value set includes all values from the THL - SOTE Organization Register (THL - SOTE-organisaatiorekisteri) (1.2.246.537.6.202.2008) and Valvira - Independent Health Care Professionals (Valvira - Terveydenhuollon itsenäiset ammatinharjoittajat) (1.2.246.537.6.203.2014) code systems. |
| fipta-vs-recordstatus |
The value set used to indicate the status of a resource, with the exception of appointment invalidation (value set fipta-vs-recordstatusremoved). |
| fipta-vs-recordstatusremoved |
The value set used to indicate the status of a resource when an appointment is removed. |
| fipta-vs-registertype |
The value set used to indicate the patient register identifier of an appointment. The value set includes all values from the KanTa Services - Patient Record Register (KanTa-palvelut - Potilasasiakirjan rekisteritunnus) code system (1.2.246.537.5.40150.2009). |
| fipta-vs-relatedpersonrole |
The value set used to indicate the role of a related person. The value set includes all values from the Appointment - Contact Person (Ajanvaraus - Yhteyshenkilö) code system (1.2.246.537.6.882.201501). |
| fipta-vs-resourceprofession |
The value set used to indicate the professional classification of the reservable resource. The value set includes all values from the TK - Profession Classification (TK - Ammattiluokitus) (1.2.246.537.6.74.2001) and Valvira - Professional Rights (Valvira - Ammattioikeudet) (1.2.246.537.6.140.2008) code systems. |
| fipta-vs-restrictionparent |
The value set used to indicate whether the information of a minor can be disclosed to their custodians. The value set includes values 1-4 from the THL - Disclosure of Minor's Patient Information to Custodians (THL - Alaikäisen potilastietojen luovuttaminen huoltajille) code system. |
| fipta-vs-servicecategory |
The value set used to indicate the category of the service to be booked. The value set includes all values from the THL - Social and Health Services Classification (THL - Sosiaali- ja terveyspalvelujen luokitus) code system (1.2.246.537.6.50.202401). |
| fipta-vs-specialty |
The value set used to indicate the specialty of the appointment. The value set includes all values from the Hilmo - Healthcare Specialties (Hilmo - Terveydenhuollon erikoisalat) code system (1.2.246.537.6.24.2003). |
| fipta-vs-tableofcontentsprotected |
The value set used to indicate protected views. The value set includes all values from the AR/YDIN - Views (AR/YDIN - Näkymät) code system (1.2.246.537.6.12.2002) that are subject to special protection. |
| fipta-vs-updatereason |
The value set used to indicate the reason for an appointment substitution. The value set includes all values from the eArchive - Document Update Reason (eArkisto - Asiakirjan korvauksen syy) code system (1.2.246.537.5.40178.2008). |
| fipta-vs-visible |
The value set used to indicate whether the appointment information can be displayed in different situations. The value set contains the following code systems: a) Custodian's right to handle appointment information (fipta-vs-visibletocustodian). The custodian's right to handle appointment information is granted at the time the appointment is made. b) Disclosure of service event information to the custodian (fipta-vs-restrictionparent). The information regarding the disclosure of the service event to the custodian is provided at the time the service event is created. The value is returned within the appointment resource. c) Whether the disclosure of information to the citizen is delayed (fipta-vs-releaseforpatientviewing). In addition, the value set contains the code system fipta-cs-returnrestricted, the information of which electronic health record (EHR) systems do not require when processing appointments. |
These define new code systems used by systems conforming to this implementation guide.
| Basic Resource Type (Local) |
Local codes distinguishing the specific meaning of Basic resources used in this implementation, since Basic.code is otherwise unqualified. |
| Code System Kanta Provenance Role Category |
Kanta services provenance role codes. |
| DIPKO Digital Health Service Category |
DIPKO-pilotin kategoriat digisovelluksille. |
| Document Format Type (Local) |
Codes marking different types of document formats. |
| Finnish Drug Database Item Change Info |
An indication showing that the product information has changed since the previous Drug Database update, or that the product is new or discontinued. |
| Finnish Drug Database Item Dividing Line Type |
The medicinal product has dividing line information according to the Summary of Product Characteristics. |
| Finnish Drug Database Item Dose Form |
A dose form identifier defined by Fimea or another dose form identifier. |
| Finnish Drug Database Item Limited Right Prescription Type |
Limited right prescription type related to a medication. |
| Finnish Drug Database Item Medicine Classification Type |
Medicine classification type codes for Finnish drug database items. |
| Finnish Drug Database Item Price Change |
An indication showing that the package price has changed since the previous Drug Database update. |
| Finnish Drug Database Item Price Type |
Classification of price information. Each medicinal product has multiple price entries. The classification indicates which price each value represents. |
| Finnish Drug Database Item Reimbursement Class |
Reimbursement class code assigned by Kela for the package. |
| Finnish Drug Database Item Reimbursement Condition |
Reimbursement condition code for a specific disease. Details |
| Finnish Drug Database Item Substance Code |
Number of the active substance (medicinal substance). The technical identification number assigned by Fimea to each medicinal substance. |
| Finnish Drug Database Item Substitution Group |
Grouping for generic substitution, i.e. medicine substitution, as defined by Fimea |
| Organization Sector |
Classifies an organization as belonging to the public or private sector. Used as an entry in Organization.type, independent of any organizational-function classification. |
| Resource Status (Local) |
Local meta.tag codes marking characteristics of server-generated resources not covered by a standard status element. |
| Signature Command Data Type (Local) |
Codes marking different types of signature command data. |
| fipta-cs-appointmenttypecategory |
The values of the fipta-cs-appointmenttypecategory code system. |
| fipta-cs-releaseforpatientviewing |
The display of the appointment to the citizen is delayed. |
| fipta-cs-returnrestricted |
The return of corrected/invalidated appointments to patient information systems. The patient information system does not need to be able to process the code system data, as restricted data is not returned to patient information systems. |
| fipta-cs-visibletocustodian |
The right of a custodian to handle appointment information. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Appointment with a public health nurse | |
| Appointment-Location-Example |
Take the elevator to the third floor |
| Appointment-SearchParameters-example | |
| Appointment-update-example | |
| AppointmentPatient-example | |
| AppointmentPractitioner-example | |
| Device-example | |
| EraAppointmentAppointment-example | |
| EraAppointmentMitatointiProvenance-parameter-example | |
| EraAppointmentProvenance-parameter-example | |
| Example Organization |
Example of the organization resource. |
| Example Patient |
Example of the patient resource. |
These are resources that are used within this implementation guide that do not fit into one of the other categories.