UPTIS FHIR PoC Test Implementation Guide
1.0.0 - draft
UPTIS FHIR PoC Test Implementation Guide
1.0.0 - draft
UPTIS FHIR PoC Test Implementation Guide, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/FHIR-PoC/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.ee/StructureDefinition/IntegrationTJT | Version: 1.0.0 | |||
| Draft as of 2024-10-28 | Computable Name: IntegrationTJT | |||
Integration PoC
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  IntegrationTJT |
0..* | Base | Integration TJT - logical model Instances of this logical model are not marked to be the target of a Reference | |
  metadata |
1..1 | Class | Metadata about the medication schema | |
  description |
0..* | ST | Description of the model | |
| version |
0..1 | ST | Version of the model | |
| status |
1..1 | CD | Status | |
| date |
0..* | DT | Datetime of the model | |
| lastUpdated |
0..1 | DT | Last updated | |
 treatmentLineRecordingMetaData |
0..1 | Class | Metadata about reporting/authoring of the treatment line | |
  recorder |
1..1 | Reference(Practitioner TJT - logical model) | Person authoring/cancelling the treatment line, either by requesting a treatment or documenting a patient's statement | |
| recordedTime |
1..1 | DT | Time of creation of the treatment line | |
| patientReported |
0..1 | BL | The treatment line has been documented according to patient's. | |
| authorResponsible |
0..1 | Reference(Practitioner TJT - logical model) | HCP who takes the clinical decision for the medication treatment line. | |
| authoringTime |
0..1 | DT | The time the decision was made. | |
 initialAuthor |
0..* | Reference(Practitioner TJT - logical model) | Initial author of the medication schema line. | |
| medicationTreatmentLine |
0..* | Class | Treatment line representing some sort of medication. | |
| identifier |
0..* | II | Unique business identifier(s) for the medication treatment line. | |
| status |
1..1 | CD | A code representing the status of recording the medication statement, recorded or draft. | |
| verification |
0..* | Class | Represents whether the treatment line is verified | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the treatment line | |
| verificationTime |
1..1 | DT | The date and time when this medication treatment line was verified | |
| derivedFrom |
0..* | II | Prescriptions that are connected to this Medication Treatment Line | |
| indication |
0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
| indicationText |
0..1 | ST | Additional instructions | |
| comment |
0..* | Class | Comment on the individual line | |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medicationOverview |
0..1 | Class | Overview of the medication in the medication schema | |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| medicationTreatmentLine |
0..* | Reference(Medication TreatmentLine TJT - logical model) | List item in the list of all current medication based treatments | |
| verification |
0..1 | Class | Represents whether the medication schema is verified | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the schema | |
| verificationTime |
1..1 | DT | The date and time when this medication schema was verified | |
| comment |
0..* | Class | Comment on the medication overview | |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medication |
1..* | Class | Medicinal product | |
| identifierMedication |
0..* | Class | Business identifier for this medication. | |
| packagedProductIdentifier |
0..* | II | Identifier at the package level, can be PCID or national | |
| classification |
0..1 | Class | Code for the product that is actually being specified, in established terminologies | |
| classificationATC |
0..1 | CD | ATC code | |
| classificationOther |
0..* | CD | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) | |
| productName |
0..* | Class | Name of the product (full name, invented name, other). | |
| name |
0..1 | ST | Name that is relevant for the users. | |
| patientPersonalMedication |
0..1 | BL | Whether the administered medication was patient's own or given by a healthcare professional. | |
| routeOfAdministration |
0..* | CD | The path by which the product is taken into or makes contact with the body. | |
| routeOfAdministrationSpecified |
0..1 | ST | Route of administration specified with a free text field. | |
| doseForm |
0..* | CD | Dose form | |
| doseFormSpecified |
0..1 | ST | Specified dose form | |
| medicationInfoType |
0..1 | CD | Information source or type of medication (prescription, verbal, given by the healthcare worker) | |
| device |
0..* | Class | Administration device included in the product. Device that is integral to the medicinal product, in effect being considered as an ingredient of the medicinal product. | |
| deviceQuantity |
1..1 | PQ | Number of such devices | |
| device |
1..1 | CD | Device coded | |
| manufacturedItem |
0..* | Class | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined | |
| manufacturedDoseForm |
0..1 | CD | Dose form | |
| unitOfPresentation |
0..1 | CD | Unit of presentation for the manufactured item (tablet, vial, tube). | |
| containedQuantity |
0..1 | PQ | Manufactured item quantity for liquids (3ml/vial). | |
| amount |
0..1 | Class | Number of such manufactured items in this product (5 vials). | |
| ingredient |
1..* | Class | Ingredients | |
| role |
1..1 | BL | Role (active ingredient, excipient). | |
| substance |
1..1 | CD | Substance | |
| strengthInfo |
1..* | Class | Concentration or presentation strength | |
| strength |
1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
| strengthType |
0..1 | CD | Type of strength that is expressed | |
| strengthSubstance |
0..1 | CD | Substance that the strength refers to, if different from the main substance | |
| packedProduct |
0..1 | Class | A medically related item or items of any type, in a container or package. | |
| packSize |
0..* | PQ | Overall amount of product in one package. | |
| productCode |
0..* | ST | Product code on the package of packaged product. | |
| serialNumber |
0..* | ST | Serial number on the medication package. | |
| batchNumber |
0..* | ST | Batch number on the medication package. The assigned lot number of a batch of the specified product. | |
| expirationDate |
0..* | DT | When this specific batch of product will expire. | |
| marketingAuthorization |
0..1 | Class | Market Authorization relating to a Medicinal Product. | |
| identifier |
0..1 | ST | Marketing authorisation number. | |
| type |
0..1 | CD | Shows that this product is approved, type of regulatory entitlement. | |
| region |
0..1 | CD | Region where document is valid. | |
| status |
0..1 | CD | Wether or not the authorisation is valid. | |
| holder |
0..1 | Class | Marketing authorisation holder. | |
| holderIdentifier |
0..1 | CD | Marketing authorisation holder. | |
| holderName |
0..1 | ST | Marketing authorisation holder name. | |
| prescription |
0..* | Class | Prescription | |
| identifierPrescription |
1..* | II | An identifier for this prescription | |
| status |
1..1 | CD | A code representing the status of prescription active, on-hold, ended, stopped, completed, cancelled, entered-in-error, draft, unknown. | |
| lockStatus |
0..* | BL | When pharmacy locks the prescription for ordering unauthorized medication for patient. True - prescription is locked for certain pharmacy. False - prescription is not locked. | |
| reason |
1..1 | CD | Reason or indication for ordering the medication. | |
| intent |
0..* | CD | Intent of prescription | |
| note |
0..1 | ST | Extra information about the prescription that could not be conveyed by the other attributes. | |
| verification |
0..* | Class | Represents whether the prescription is verified | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the prescription | |
| verificationTime |
1..1 | DT | The date and time when this medication prescription was verified | |
| courseOfTherapyType |
0..* | CD | Type of therapy | |
| prescriptionCategory |
0..* | CD | Category of prescription. | |
| repeatCategory |
0..* | CD | Prescriptions to repeat | |
| prescribedAmount |
0..1 | Class | How much medication prescribed on prescription. | |
| prescribedAmountPackage |
0..1 | INT | The number of medication packages. | |
| prescibedAmountTotal |
0..1 | INT | How much medication prescribed in total on prescription. | |
| prescriptionValidityTime |
0..* | DT | For expressing the validity of the prescription(s). | |
| prescriptionAuthorization |
0..* | CD | Defines the authorization of the prescription. | |
| cancelledPrescription |
0..1 | Class | Cancellation of prescription. | |
| cancelledStatusReason |
0..* | CD | Reason for cancellation. | |
| cancelledTime |
0..* | DT | Time of cancellation. | |
| substitution |
0..1 | Class | Whether and which type of substitution is allowed for this medication. | |
| substitutionAllowed |
0..1 | BL | Whether substitution is allowed for this medication. | |
| substitutionType |
1..1 | CD | The type of substitution that is allowed. | |
| substitutionTypeReason |
0..1 | CD | Coded reason for the substitution requirement | |
| substitutionTypeReasonText |
0..1 | ST | Textual reason for the substitution requirement | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Practitioner who is creating prescription. | |
| organisation |
1..1 | Reference() | Organisation connected to practitioner and prescription. | |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| reimbursement |
1..1 | Class | For representation of the reimbursement rate and reason of prescription medicine. | |
| reimbursementRate |
1..1 | CD | Reimbursement of medication. | |
| reimbursementReason |
1..1 | ST | Reason of the reimbursement rate. | |
| reimbursementParameters |
1..1 | Class | Insurance response. | |
| reimbursementEu |
0..1 | BL | EU insurance. | |
| reimbursementOldAgeRetirement |
0..1 | BL | Old age pension. | |
| reimbursementIncapacityForWork |
0..1 | BL | Pension for incapacity for work. | |
| reimbursementEstonian |
0..1 | BL | Estonian insurance. | |
| unauthorizedMedicationRequest |
0..1 | Class | Requesting usage permit for unauthorized medication. | |
| identifier |
1..1 | II | Unauthorized medication request number. | |
| requestReason |
1..1 | CD | Unauthorized medication reason. | |
| status |
0..1 | CD | Status of unauthorized medication request can be positive or negative. | |
| requestDate |
1..1 | DT | Date when the request was made. | |
| requestDecision |
0..1 | CD | If requestStatus is negative there has to be a reason explaining the negative decision. | |
| requestDecisionText |
0..1 | ST | If requestStatus is negative there has to be a reason explaining the negative decision in text | |
| dosage |
0..* | Class | Dosage | |
| sequence |
0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes. | |
| text |
0..1 | ST | Free text usage/dosage instructions. | |
| patientInstruction |
0..1 | ST | Patient oriented instructions as free text. | |
| additionalInstruction |
0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
| doseAndRate |
0..* | Class | Amount of medication administered per one dose (one timing). | |
| type |
0..1 | CD | The kind of dose or rate specified e.g calculated, ordered, etc. | |
| dose |
0..1 | PQ | Amount of medication per one dose e.g 1 tablet, 1-2 tablets, 100 ml. | |
| rate |
0..1 | RTO | Amount of medication per unit of time. Time period during which one defined dose is administered e.g per 1 hour, per 5-10 minutes. | |
| timing |
0..1 | Class | When medication should be administered e.g period, time of day, frequency, etc. | |
| event |
0..* | DT | Exact date and/or time of the administration. | |
| code |
0..1 | CD | Timing abbreviation, e.g AM - morning. | |
| repeat |
0..1 | Class | Repetition of the administration. | |
| bounds |
0..1 | Class | Time bounds for the treatment (current dosaging scheme). | |
| duration |
0..1 | PQ | Number of time units, e.g 10 days. | |
| range |
0..1 | Class | A range of numbers of time units, e.g 5-10 days. | |
| rangeMinimum |
0..1 | PQ | Minimum number of time units. | |
| rangeMaximum |
0..1 | PQ | Maximum number of time units. | |
| period |
0..1 | Class | Start and end date, 12.04.2024 - 12.06.2024. | |
| startDate |
0..1 | DT | Start date of administering medication. | |
| endDate |
0..1 | DT | End time of administering medication. | |
| count |
0..1 | Class | Number of times to repeat, exact or range. | |
| count |
1..1 | INT | Number of times e.g twice, 10 times. | |
| countMax |
0..1 | INT | Maximum number of times e.g maximum 15 times. | |
| duration |
0..1 | Class | Duration of one administration, exact or range. | |
| duration |
1..1 | PQ | Duration of administration e.g 15 minutes, 2 hour. | |
| durationMax |
0..1 | PQ | Maximum duration of administration e.g maximum 20 minutes. | |
| frequency |
0..1 | Class | Frequency of intake/administration e.g 4 times a day. | |
| numberOfTimes |
1..1 | INT | Number of times per period e.g 8 times. | |
| maxNumberOfTimes |
0..1 | INT | Maximum number of times per period e.g. maximum 8 times. | |
| period |
1..1 | PQ | Duration to which the frequency applies e.g '... / 1 day. | |
| periodMax |
0..1 | PQ | Upper limit of the period e.g 4-6 hours. | |
| dayOfWeek |
0..* | CD | The day of the week of administration, e.g Mon, Tue, etc. | |
| timeOfDay |
0..* | DT | Time of day of administration e.g 15:00. | |
| eventTime |
0..* | Class | An event the administration is bound to, e.g before meal, 30 min before meal. | |
| when |
0..* | CD | Time period or event e.g before meal, morning. | |
| offset |
0..1 | INT | Minutes from event, before or after. | |
| asNeeded |
0..1 | BL | Take as needed. | |
| asNeededFor |
0..* | CD | Take as needed for the coded reason. | |
| bodySite |
0..1 | CD | Body site of administration. | |
| routeOfAdministration |
0..1 | CD | Route of administration. | |
| methodOfAdministration |
0..1 | CD | Method or technique for administering medication. | |
| maxDose |
0..* | Class | Maximum dose for the patient | |
| maxDosePerPeriod |
0..* | RTO | Upper limit on medication per unit of time | |
| maxDosePerAdministration |
0..1 | PQ | Upper limit on medication per one administration | |
| maxDosePerLifetime |
1..1 | PQ | Upper limit on medication per lifetime of the patient | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IntegrationTJT |
0..* | Base | Integration TJT - logical model Instances of this logical model are not marked to be the target of a Reference | |
| metadata |
1..1 | Class | Metadata about the medication schema | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description |
0..* | ST | Description of the model | |
| version |
0..1 | ST | Version of the model | |
| status |
1..1 | CD | Status | |
| date |
0..* | DT | Datetime of the model | |
| lastUpdated |
0..1 | DT | Last updated | |
| treatmentLineRecordingMetaData |
0..1 | Class | Metadata about reporting/authoring of the treatment line | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| recorder |
1..1 | Reference(Practitioner TJT - logical model) | Person authoring/cancelling the treatment line, either by requesting a treatment or documenting a patient's statement | |
| recordedTime |
1..1 | DT | Time of creation of the treatment line | |
| patientReported |
0..1 | BL | The treatment line has been documented according to patient's. | |
| authorResponsible |
0..1 | Reference(Practitioner TJT - logical model) | HCP who takes the clinical decision for the medication treatment line. | |
| authoringTime |
0..1 | DT | The time the decision was made. | |
| initialAuthor |
0..* | Reference(Practitioner TJT - logical model) | Initial author of the medication schema line. | |
| medicationTreatmentLine |
0..* | Class | Treatment line representing some sort of medication. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
0..* | II | Unique business identifier(s) for the medication treatment line. | |
| status |
1..1 | CD | A code representing the status of recording the medication statement, recorded or draft. | |
| verification |
0..* | Class | Represents whether the treatment line is verified | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the treatment line | |
| verificationTime |
1..1 | DT | The date and time when this medication treatment line was verified | |
| derivedFrom |
0..* | II | Prescriptions that are connected to this Medication Treatment Line | |
| indication |
0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
| indicationText |
0..1 | ST | Additional instructions | |
| comment |
0..* | Class | Comment on the individual line | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medicationOverview |
0..1 | Class | Overview of the medication in the medication schema | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| medicationTreatmentLine |
0..* | Reference(Medication TreatmentLine TJT - logical model) | List item in the list of all current medication based treatments | |
| verification |
0..1 | Class | Represents whether the medication schema is verified | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the schema | |
| verificationTime |
1..1 | DT | The date and time when this medication schema was verified | |
| comment |
0..* | Class | Comment on the medication overview | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medication |
1..* | Class | Medicinal product | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifierMedication |
0..* | Class | Business identifier for this medication. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| packagedProductIdentifier |
0..* | II | Identifier at the package level, can be PCID or national | |
| classification |
0..1 | Class | Code for the product that is actually being specified, in established terminologies | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| classificationATC |
0..1 | CD | ATC code | |
| classificationOther |
0..* | CD | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) | |
| productName |
0..* | Class | Name of the product (full name, invented name, other). | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
0..1 | ST | Name that is relevant for the users. | |
| patientPersonalMedication |
0..1 | BL | Whether the administered medication was patient's own or given by a healthcare professional. | |
| routeOfAdministration |
0..* | CD | The path by which the product is taken into or makes contact with the body. | |
| routeOfAdministrationSpecified |
0..1 | ST | Route of administration specified with a free text field. | |
| doseForm |
0..* | CD | Dose form | |
| doseFormSpecified |
0..1 | ST | Specified dose form | |
| medicationInfoType |
0..1 | CD | Information source or type of medication (prescription, verbal, given by the healthcare worker) | |
| device |
0..* | Class | Administration device included in the product. Device that is integral to the medicinal product, in effect being considered as an ingredient of the medicinal product. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| deviceQuantity |
1..1 | PQ | Number of such devices | |
| device |
1..1 | CD | Device coded | |
| manufacturedItem |
0..* | Class | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| manufacturedDoseForm |
0..1 | CD | Dose form | |
| unitOfPresentation |
0..1 | CD | Unit of presentation for the manufactured item (tablet, vial, tube). | |
| containedQuantity |
0..1 | PQ | Manufactured item quantity for liquids (3ml/vial). | |
| amount |
0..1 | Class | Number of such manufactured items in this product (5 vials). | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ingredient |
1..* | Class | Ingredients | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
1..1 | BL | Role (active ingredient, excipient). | |
| substance |
1..1 | CD | Substance | |
| strengthInfo |
1..* | Class | Concentration or presentation strength | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| strength |
1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
| strengthType |
0..1 | CD | Type of strength that is expressed | |
| strengthSubstance |
0..1 | CD | Substance that the strength refers to, if different from the main substance | |
| packedProduct |
0..1 | Class | A medically related item or items of any type, in a container or package. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| packSize |
0..* | PQ | Overall amount of product in one package. | |
| productCode |
0..* | ST | Product code on the package of packaged product. | |
| serialNumber |
0..* | ST | Serial number on the medication package. | |
| batchNumber |
0..* | ST | Batch number on the medication package. The assigned lot number of a batch of the specified product. | |
| expirationDate |
0..* | DT | When this specific batch of product will expire. | |
| marketingAuthorization |
0..1 | Class | Market Authorization relating to a Medicinal Product. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
0..1 | ST | Marketing authorisation number. | |
| type |
0..1 | CD | Shows that this product is approved, type of regulatory entitlement. | |
| region |
0..1 | CD | Region where document is valid. | |
| status |
0..1 | CD | Wether or not the authorisation is valid. | |
| holder |
0..1 | Class | Marketing authorisation holder. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| holderIdentifier |
0..1 | CD | Marketing authorisation holder. | |
| holderName |
0..1 | ST | Marketing authorisation holder name. | |
| prescription |
0..* | Class | Prescription | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifierPrescription |
1..* | II | An identifier for this prescription | |
| status |
1..1 | CD | A code representing the status of prescription active, on-hold, ended, stopped, completed, cancelled, entered-in-error, draft, unknown. | |
| lockStatus |
0..* | BL | When pharmacy locks the prescription for ordering unauthorized medication for patient. True - prescription is locked for certain pharmacy. False - prescription is not locked. | |
| reason |
1..1 | CD | Reason or indication for ordering the medication. | |
| intent |
0..* | CD | Intent of prescription | |
| note |
0..1 | ST | Extra information about the prescription that could not be conveyed by the other attributes. | |
| verification |
0..* | Class | Represents whether the prescription is verified | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the prescription | |
| verificationTime |
1..1 | DT | The date and time when this medication prescription was verified | |
| courseOfTherapyType |
0..* | CD | Type of therapy | |
| prescriptionCategory |
0..* | CD | Category of prescription. | |
| repeatCategory |
0..* | CD | Prescriptions to repeat | |
| prescribedAmount |
0..1 | Class | How much medication prescribed on prescription. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| prescribedAmountPackage |
0..1 | INT | The number of medication packages. | |
| prescibedAmountTotal |
0..1 | INT | How much medication prescribed in total on prescription. | |
| prescriptionValidityTime |
0..* | DT | For expressing the validity of the prescription(s). | |
| prescriptionAuthorization |
0..* | CD | Defines the authorization of the prescription. | |
| cancelledPrescription |
0..1 | Class | Cancellation of prescription. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| cancelledStatusReason |
0..* | CD | Reason for cancellation. | |
| cancelledTime |
0..* | DT | Time of cancellation. | |
| substitution |
0..1 | Class | Whether and which type of substitution is allowed for this medication. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substitutionAllowed |
0..1 | BL | Whether substitution is allowed for this medication. | |
| substitutionType |
1..1 | CD | The type of substitution that is allowed. | |
| substitutionTypeReason |
0..1 | CD | Coded reason for the substitution requirement | |
| substitutionTypeReasonText |
0..1 | ST | Textual reason for the substitution requirement | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Practitioner who is creating prescription. | |
| organisation |
1..1 | Reference() | Organisation connected to practitioner and prescription. | |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| reimbursement |
1..1 | Class | For representation of the reimbursement rate and reason of prescription medicine. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reimbursementRate |
1..1 | CD | Reimbursement of medication. | |
| reimbursementReason |
1..1 | ST | Reason of the reimbursement rate. | |
| reimbursementParameters |
1..1 | Class | Insurance response. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reimbursementEu |
0..1 | BL | EU insurance. | |
| reimbursementOldAgeRetirement |
0..1 | BL | Old age pension. | |
| reimbursementIncapacityForWork |
0..1 | BL | Pension for incapacity for work. | |
| reimbursementEstonian |
0..1 | BL | Estonian insurance. | |
| unauthorizedMedicationRequest |
0..1 | Class | Requesting usage permit for unauthorized medication. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
1..1 | II | Unauthorized medication request number. | |
| requestReason |
1..1 | CD | Unauthorized medication reason. | |
| status |
0..1 | CD | Status of unauthorized medication request can be positive or negative. | |
| requestDate |
1..1 | DT | Date when the request was made. | |
| requestDecision |
0..1 | CD | If requestStatus is negative there has to be a reason explaining the negative decision. | |
| requestDecisionText |
0..1 | ST | If requestStatus is negative there has to be a reason explaining the negative decision in text | |
| dosage |
0..* | Class | Dosage | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequence |
0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes. | |
| text |
0..1 | ST | Free text usage/dosage instructions. | |
| patientInstruction |
0..1 | ST | Patient oriented instructions as free text. | |
| additionalInstruction |
0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
| doseAndRate |
0..* | Class | Amount of medication administered per one dose (one timing). | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
0..1 | CD | The kind of dose or rate specified e.g calculated, ordered, etc. | |
| dose |
0..1 | PQ | Amount of medication per one dose e.g 1 tablet, 1-2 tablets, 100 ml. | |
| rate |
0..1 | RTO | Amount of medication per unit of time. Time period during which one defined dose is administered e.g per 1 hour, per 5-10 minutes. | |
| timing |
0..1 | Class | When medication should be administered e.g period, time of day, frequency, etc. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event |
0..* | DT | Exact date and/or time of the administration. | |
| code |
0..1 | CD | Timing abbreviation, e.g AM - morning. | |
| repeat |
0..1 | Class | Repetition of the administration. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| bounds |
0..1 | Class | Time bounds for the treatment (current dosaging scheme). | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| duration |
0..1 | PQ | Number of time units, e.g 10 days. | |
| range |
0..1 | Class | A range of numbers of time units, e.g 5-10 days. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| rangeMinimum |
0..1 | PQ | Minimum number of time units. | |
| rangeMaximum |
0..1 | PQ | Maximum number of time units. | |
| period |
0..1 | Class | Start and end date, 12.04.2024 - 12.06.2024. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| startDate |
0..1 | DT | Start date of administering medication. | |
| endDate |
0..1 | DT | End time of administering medication. | |
| count |
0..1 | Class | Number of times to repeat, exact or range. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| count |
1..1 | INT | Number of times e.g twice, 10 times. | |
| countMax |
0..1 | INT | Maximum number of times e.g maximum 15 times. | |
| duration |
0..1 | Class | Duration of one administration, exact or range. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| duration |
1..1 | PQ | Duration of administration e.g 15 minutes, 2 hour. | |
| durationMax |
0..1 | PQ | Maximum duration of administration e.g maximum 20 minutes. | |
| frequency |
0..1 | Class | Frequency of intake/administration e.g 4 times a day. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| numberOfTimes |
1..1 | INT | Number of times per period e.g 8 times. | |
| maxNumberOfTimes |
0..1 | INT | Maximum number of times per period e.g. maximum 8 times. | |
| period |
1..1 | PQ | Duration to which the frequency applies e.g '... / 1 day. | |
| periodMax |
0..1 | PQ | Upper limit of the period e.g 4-6 hours. | |
| dayOfWeek |
0..* | CD | The day of the week of administration, e.g Mon, Tue, etc. | |
| timeOfDay |
0..* | DT | Time of day of administration e.g 15:00. | |
| eventTime |
0..* | Class | An event the administration is bound to, e.g before meal, 30 min before meal. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| when |
0..* | CD | Time period or event e.g before meal, morning. | |
| offset |
0..1 | INT | Minutes from event, before or after. | |
| asNeeded |
0..1 | BL | Take as needed. | |
| asNeededFor |
0..* | CD | Take as needed for the coded reason. | |
| bodySite |
0..1 | CD | Body site of administration. | |
| routeOfAdministration |
0..1 | CD | Route of administration. | |
| methodOfAdministration |
0..1 | CD | Method or technique for administering medication. | |
| maxDose |
0..* | Class | Maximum dose for the patient | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| maxDosePerPeriod |
0..* | RTO | Upper limit on medication per unit of time | |
| maxDosePerAdministration |
0..1 | PQ | Upper limit on medication per one administration | |
| maxDosePerLifetime |
1..1 | PQ | Upper limit on medication per lifetime of the patient | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IntegrationTJT |
0..* | Base | Integration TJT - logical model Instances of this logical model are not marked to be the target of a Reference | |
| metadata |
1..1 | Class | Metadata about the medication schema | |
 @id |
0..1 | id | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description |
0..* | ST | Description of the model | |
| version |
0..1 | ST | Version of the model | |
| status |
1..1 | CD | Status | |
| date |
0..* | DT | Datetime of the model | |
| lastUpdated |
0..1 | DT | Last updated | |
| treatmentLineRecordingMetaData |
0..1 | Class | Metadata about reporting/authoring of the treatment line | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| recorder |
1..1 | Reference(Practitioner TJT - logical model) | Person authoring/cancelling the treatment line, either by requesting a treatment or documenting a patient's statement | |
| recordedTime |
1..1 | DT | Time of creation of the treatment line | |
| patientReported |
0..1 | BL | The treatment line has been documented according to patient's. | |
| authorResponsible |
0..1 | Reference(Practitioner TJT - logical model) | HCP who takes the clinical decision for the medication treatment line. | |
| authoringTime |
0..1 | DT | The time the decision was made. | |
| initialAuthor |
0..* | Reference(Practitioner TJT - logical model) | Initial author of the medication schema line. | |
| medicationTreatmentLine |
0..* | Class | Treatment line representing some sort of medication. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
0..* | II | Unique business identifier(s) for the medication treatment line. | |
| status |
1..1 | CD | A code representing the status of recording the medication statement, recorded or draft. | |
| verification |
0..* | Class | Represents whether the treatment line is verified | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the treatment line | |
| verificationTime |
1..1 | DT | The date and time when this medication treatment line was verified | |
| derivedFrom |
0..* | II | Prescriptions that are connected to this Medication Treatment Line | |
| indication |
0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
| indicationText |
0..1 | ST | Additional instructions | |
| comment |
0..* | Class | Comment on the individual line | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medicationOverview |
0..1 | Class | Overview of the medication in the medication schema | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| medicationTreatmentLine |
0..* | Reference(Medication TreatmentLine TJT - logical model) | List item in the list of all current medication based treatments | |
| verification |
0..1 | Class | Represents whether the medication schema is verified | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the schema | |
| verificationTime |
1..1 | DT | The date and time when this medication schema was verified | |
| comment |
0..* | Class | Comment on the medication overview | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medication |
1..* | Class | Medicinal product | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifierMedication |
0..* | Class | Business identifier for this medication. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| packagedProductIdentifier |
0..* | II | Identifier at the package level, can be PCID or national | |
| classification |
0..1 | Class | Code for the product that is actually being specified, in established terminologies | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| classificationATC |
0..1 | CD | ATC code | |
| classificationOther |
0..* | CD | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) | |
| productName |
0..* | Class | Name of the product (full name, invented name, other). | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
0..1 | ST | Name that is relevant for the users. | |
| patientPersonalMedication |
0..1 | BL | Whether the administered medication was patient's own or given by a healthcare professional. | |
| routeOfAdministration |
0..* | CD | The path by which the product is taken into or makes contact with the body. | |
| routeOfAdministrationSpecified |
0..1 | ST | Route of administration specified with a free text field. | |
| doseForm |
0..* | CD | Dose form | |
| doseFormSpecified |
0..1 | ST | Specified dose form | |
| medicationInfoType |
0..1 | CD | Information source or type of medication (prescription, verbal, given by the healthcare worker) | |
| device |
0..* | Class | Administration device included in the product. Device that is integral to the medicinal product, in effect being considered as an ingredient of the medicinal product. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| deviceQuantity |
1..1 | PQ | Number of such devices | |
| device |
1..1 | CD | Device coded | |
| manufacturedItem |
0..* | Class | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| manufacturedDoseForm |
0..1 | CD | Dose form | |
| unitOfPresentation |
0..1 | CD | Unit of presentation for the manufactured item (tablet, vial, tube). | |
| containedQuantity |
0..1 | PQ | Manufactured item quantity for liquids (3ml/vial). | |
| amount |
0..1 | Class | Number of such manufactured items in this product (5 vials). | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ingredient |
1..* | Class | Ingredients | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
1..1 | BL | Role (active ingredient, excipient). | |
| substance |
1..1 | CD | Substance | |
| strengthInfo |
1..* | Class | Concentration or presentation strength | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| strength |
1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
| strengthType |
0..1 | CD | Type of strength that is expressed | |
| strengthSubstance |
0..1 | CD | Substance that the strength refers to, if different from the main substance | |
| packedProduct |
0..1 | Class | A medically related item or items of any type, in a container or package. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| packSize |
0..* | PQ | Overall amount of product in one package. | |
| productCode |
0..* | ST | Product code on the package of packaged product. | |
| serialNumber |
0..* | ST | Serial number on the medication package. | |
| batchNumber |
0..* | ST | Batch number on the medication package. The assigned lot number of a batch of the specified product. | |
| expirationDate |
0..* | DT | When this specific batch of product will expire. | |
| marketingAuthorization |
0..1 | Class | Market Authorization relating to a Medicinal Product. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
0..1 | ST | Marketing authorisation number. | |
| type |
0..1 | CD | Shows that this product is approved, type of regulatory entitlement. | |
| region |
0..1 | CD | Region where document is valid. | |
| status |
0..1 | CD | Wether or not the authorisation is valid. | |
| holder |
0..1 | Class | Marketing authorisation holder. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| holderIdentifier |
0..1 | CD | Marketing authorisation holder. | |
| holderName |
0..1 | ST | Marketing authorisation holder name. | |
| prescription |
0..* | Class | Prescription | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifierPrescription |
1..* | II | An identifier for this prescription | |
| status |
1..1 | CD | A code representing the status of prescription active, on-hold, ended, stopped, completed, cancelled, entered-in-error, draft, unknown. | |
| lockStatus |
0..* | BL | When pharmacy locks the prescription for ordering unauthorized medication for patient. True - prescription is locked for certain pharmacy. False - prescription is not locked. | |
| reason |
1..1 | CD | Reason or indication for ordering the medication. | |
| intent |
0..* | CD | Intent of prescription | |
| note |
0..1 | ST | Extra information about the prescription that could not be conveyed by the other attributes. | |
| verification |
0..* | Class | Represents whether the prescription is verified | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the prescription | |
| verificationTime |
1..1 | DT | The date and time when this medication prescription was verified | |
| courseOfTherapyType |
0..* | CD | Type of therapy | |
| prescriptionCategory |
0..* | CD | Category of prescription. | |
| repeatCategory |
0..* | CD | Prescriptions to repeat | |
| prescribedAmount |
0..1 | Class | How much medication prescribed on prescription. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| prescribedAmountPackage |
0..1 | INT | The number of medication packages. | |
| prescibedAmountTotal |
0..1 | INT | How much medication prescribed in total on prescription. | |
| prescriptionValidityTime |
0..* | DT | For expressing the validity of the prescription(s). | |
| prescriptionAuthorization |
0..* | CD | Defines the authorization of the prescription. | |
| cancelledPrescription |
0..1 | Class | Cancellation of prescription. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| cancelledStatusReason |
0..* | CD | Reason for cancellation. | |
| cancelledTime |
0..* | DT | Time of cancellation. | |
| substitution |
0..1 | Class | Whether and which type of substitution is allowed for this medication. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substitutionAllowed |
0..1 | BL | Whether substitution is allowed for this medication. | |
| substitutionType |
1..1 | CD | The type of substitution that is allowed. | |
| substitutionTypeReason |
0..1 | CD | Coded reason for the substitution requirement | |
| substitutionTypeReasonText |
0..1 | ST | Textual reason for the substitution requirement | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Practitioner who is creating prescription. | |
| organisation |
1..1 | Reference() | Organisation connected to practitioner and prescription. | |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| reimbursement |
1..1 | Class | For representation of the reimbursement rate and reason of prescription medicine. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reimbursementRate |
1..1 | CD | Reimbursement of medication. | |
| reimbursementReason |
1..1 | ST | Reason of the reimbursement rate. | |
| reimbursementParameters |
1..1 | Class | Insurance response. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reimbursementEu |
0..1 | BL | EU insurance. | |
| reimbursementOldAgeRetirement |
0..1 | BL | Old age pension. | |
| reimbursementIncapacityForWork |
0..1 | BL | Pension for incapacity for work. | |
| reimbursementEstonian |
0..1 | BL | Estonian insurance. | |
| unauthorizedMedicationRequest |
0..1 | Class | Requesting usage permit for unauthorized medication. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
1..1 | II | Unauthorized medication request number. | |
| requestReason |
1..1 | CD | Unauthorized medication reason. | |
| status |
0..1 | CD | Status of unauthorized medication request can be positive or negative. | |
| requestDate |
1..1 | DT | Date when the request was made. | |
| requestDecision |
0..1 | CD | If requestStatus is negative there has to be a reason explaining the negative decision. | |
| requestDecisionText |
0..1 | ST | If requestStatus is negative there has to be a reason explaining the negative decision in text | |
| dosage |
0..* | Class | Dosage | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequence |
0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes. | |
| text |
0..1 | ST | Free text usage/dosage instructions. | |
| patientInstruction |
0..1 | ST | Patient oriented instructions as free text. | |
| additionalInstruction |
0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
| doseAndRate |
0..* | Class | Amount of medication administered per one dose (one timing). | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
0..1 | CD | The kind of dose or rate specified e.g calculated, ordered, etc. | |
| dose |
0..1 | PQ | Amount of medication per one dose e.g 1 tablet, 1-2 tablets, 100 ml. | |
| rate |
0..1 | RTO | Amount of medication per unit of time. Time period during which one defined dose is administered e.g per 1 hour, per 5-10 minutes. | |
| timing |
0..1 | Class | When medication should be administered e.g period, time of day, frequency, etc. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event |
0..* | DT | Exact date and/or time of the administration. | |
| code |
0..1 | CD | Timing abbreviation, e.g AM - morning. | |
| repeat |
0..1 | Class | Repetition of the administration. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| bounds |
0..1 | Class | Time bounds for the treatment (current dosaging scheme). | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| duration |
0..1 | PQ | Number of time units, e.g 10 days. | |
| range |
0..1 | Class | A range of numbers of time units, e.g 5-10 days. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| rangeMinimum |
0..1 | PQ | Minimum number of time units. | |
| rangeMaximum |
0..1 | PQ | Maximum number of time units. | |
| period |
0..1 | Class | Start and end date, 12.04.2024 - 12.06.2024. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| startDate |
0..1 | DT | Start date of administering medication. | |
| endDate |
0..1 | DT | End time of administering medication. | |
| count |
0..1 | Class | Number of times to repeat, exact or range. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| count |
1..1 | INT | Number of times e.g twice, 10 times. | |
| countMax |
0..1 | INT | Maximum number of times e.g maximum 15 times. | |
| duration |
0..1 | Class | Duration of one administration, exact or range. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| duration |
1..1 | PQ | Duration of administration e.g 15 minutes, 2 hour. | |
| durationMax |
0..1 | PQ | Maximum duration of administration e.g maximum 20 minutes. | |
| frequency |
0..1 | Class | Frequency of intake/administration e.g 4 times a day. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| numberOfTimes |
1..1 | INT | Number of times per period e.g 8 times. | |
| maxNumberOfTimes |
0..1 | INT | Maximum number of times per period e.g. maximum 8 times. | |
| period |
1..1 | PQ | Duration to which the frequency applies e.g '... / 1 day. | |
| periodMax |
0..1 | PQ | Upper limit of the period e.g 4-6 hours. | |
| dayOfWeek |
0..* | CD | The day of the week of administration, e.g Mon, Tue, etc. | |
| timeOfDay |
0..* | DT | Time of day of administration e.g 15:00. | |
| eventTime |
0..* | Class | An event the administration is bound to, e.g before meal, 30 min before meal. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| when |
0..* | CD | Time period or event e.g before meal, morning. | |
| offset |
0..1 | INT | Minutes from event, before or after. | |
| asNeeded |
0..1 | BL | Take as needed. | |
| asNeededFor |
0..* | CD | Take as needed for the coded reason. | |
| bodySite |
0..1 | CD | Body site of administration. | |
| routeOfAdministration |
0..1 | CD | Route of administration. | |
| methodOfAdministration |
0..1 | CD | Method or technique for administering medication. | |
| maxDose |
0..* | Class | Maximum dose for the patient | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| maxDosePerPeriod |
0..* | RTO | Upper limit on medication per unit of time | |
| maxDosePerAdministration |
0..1 | PQ | Upper limit on medication per one administration | |
| maxDosePerLifetime |
1..1 | PQ | Upper limit on medication per lifetime of the patient | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Summary
Mandatory: 0 element(45 nested mandatory elements)
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IntegrationTJT |
0..* | Base | Integration TJT - logical model Instances of this logical model are not marked to be the target of a Reference | |
| metadata |
1..1 | Class | Metadata about the medication schema | |
| description |
0..* | ST | Description of the model | |
| version |
0..1 | ST | Version of the model | |
| status |
1..1 | CD | Status | |
| date |
0..* | DT | Datetime of the model | |
| lastUpdated |
0..1 | DT | Last updated | |
| treatmentLineRecordingMetaData |
0..1 | Class | Metadata about reporting/authoring of the treatment line | |
| recorder |
1..1 | Reference(Practitioner TJT - logical model) | Person authoring/cancelling the treatment line, either by requesting a treatment or documenting a patient's statement | |
| recordedTime |
1..1 | DT | Time of creation of the treatment line | |
| patientReported |
0..1 | BL | The treatment line has been documented according to patient's. | |
| authorResponsible |
0..1 | Reference(Practitioner TJT - logical model) | HCP who takes the clinical decision for the medication treatment line. | |
| authoringTime |
0..1 | DT | The time the decision was made. | |
| initialAuthor |
0..* | Reference(Practitioner TJT - logical model) | Initial author of the medication schema line. | |
| medicationTreatmentLine |
0..* | Class | Treatment line representing some sort of medication. | |
| identifier |
0..* | II | Unique business identifier(s) for the medication treatment line. | |
| status |
1..1 | CD | A code representing the status of recording the medication statement, recorded or draft. | |
| verification |
0..* | Class | Represents whether the treatment line is verified | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the treatment line | |
| verificationTime |
1..1 | DT | The date and time when this medication treatment line was verified | |
| derivedFrom |
0..* | II | Prescriptions that are connected to this Medication Treatment Line | |
| indication |
0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
| indicationText |
0..1 | ST | Additional instructions | |
| comment |
0..* | Class | Comment on the individual line | |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medicationOverview |
0..1 | Class | Overview of the medication in the medication schema | |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| medicationTreatmentLine |
0..* | Reference(Medication TreatmentLine TJT - logical model) | List item in the list of all current medication based treatments | |
| verification |
0..1 | Class | Represents whether the medication schema is verified | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the schema | |
| verificationTime |
1..1 | DT | The date and time when this medication schema was verified | |
| comment |
0..* | Class | Comment on the medication overview | |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medication |
1..* | Class | Medicinal product | |
| identifierMedication |
0..* | Class | Business identifier for this medication. | |
| packagedProductIdentifier |
0..* | II | Identifier at the package level, can be PCID or national | |
| classification |
0..1 | Class | Code for the product that is actually being specified, in established terminologies | |
| classificationATC |
0..1 | CD | ATC code | |
| classificationOther |
0..* | CD | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) | |
| productName |
0..* | Class | Name of the product (full name, invented name, other). | |
| name |
0..1 | ST | Name that is relevant for the users. | |
| patientPersonalMedication |
0..1 | BL | Whether the administered medication was patient's own or given by a healthcare professional. | |
| routeOfAdministration |
0..* | CD | The path by which the product is taken into or makes contact with the body. | |
| routeOfAdministrationSpecified |
0..1 | ST | Route of administration specified with a free text field. | |
| doseForm |
0..* | CD | Dose form | |
| doseFormSpecified |
0..1 | ST | Specified dose form | |
| medicationInfoType |
0..1 | CD | Information source or type of medication (prescription, verbal, given by the healthcare worker) | |
| device |
0..* | Class | Administration device included in the product. Device that is integral to the medicinal product, in effect being considered as an ingredient of the medicinal product. | |
| deviceQuantity |
1..1 | PQ | Number of such devices | |
| device |
1..1 | CD | Device coded | |
| manufacturedItem |
0..* | Class | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined | |
| manufacturedDoseForm |
0..1 | CD | Dose form | |
| unitOfPresentation |
0..1 | CD | Unit of presentation for the manufactured item (tablet, vial, tube). | |
| containedQuantity |
0..1 | PQ | Manufactured item quantity for liquids (3ml/vial). | |
| amount |
0..1 | Class | Number of such manufactured items in this product (5 vials). | |
| ingredient |
1..* | Class | Ingredients | |
| role |
1..1 | BL | Role (active ingredient, excipient). | |
| substance |
1..1 | CD | Substance | |
| strengthInfo |
1..* | Class | Concentration or presentation strength | |
| strength |
1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
| strengthType |
0..1 | CD | Type of strength that is expressed | |
| strengthSubstance |
0..1 | CD | Substance that the strength refers to, if different from the main substance | |
| packedProduct |
0..1 | Class | A medically related item or items of any type, in a container or package. | |
| packSize |
0..* | PQ | Overall amount of product in one package. | |
| productCode |
0..* | ST | Product code on the package of packaged product. | |
| serialNumber |
0..* | ST | Serial number on the medication package. | |
| batchNumber |
0..* | ST | Batch number on the medication package. The assigned lot number of a batch of the specified product. | |
| expirationDate |
0..* | DT | When this specific batch of product will expire. | |
| marketingAuthorization |
0..1 | Class | Market Authorization relating to a Medicinal Product. | |
| identifier |
0..1 | ST | Marketing authorisation number. | |
| type |
0..1 | CD | Shows that this product is approved, type of regulatory entitlement. | |
| region |
0..1 | CD | Region where document is valid. | |
| status |
0..1 | CD | Wether or not the authorisation is valid. | |
| holder |
0..1 | Class | Marketing authorisation holder. | |
| holderIdentifier |
0..1 | CD | Marketing authorisation holder. | |
| holderName |
0..1 | ST | Marketing authorisation holder name. | |
| prescription |
0..* | Class | Prescription | |
| identifierPrescription |
1..* | II | An identifier for this prescription | |
| status |
1..1 | CD | A code representing the status of prescription active, on-hold, ended, stopped, completed, cancelled, entered-in-error, draft, unknown. | |
| lockStatus |
0..* | BL | When pharmacy locks the prescription for ordering unauthorized medication for patient. True - prescription is locked for certain pharmacy. False - prescription is not locked. | |
| reason |
1..1 | CD | Reason or indication for ordering the medication. | |
| intent |
0..* | CD | Intent of prescription | |
| note |
0..1 | ST | Extra information about the prescription that could not be conveyed by the other attributes. | |
| verification |
0..* | Class | Represents whether the prescription is verified | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the prescription | |
| verificationTime |
1..1 | DT | The date and time when this medication prescription was verified | |
| courseOfTherapyType |
0..* | CD | Type of therapy | |
| prescriptionCategory |
0..* | CD | Category of prescription. | |
| repeatCategory |
0..* | CD | Prescriptions to repeat | |
| prescribedAmount |
0..1 | Class | How much medication prescribed on prescription. | |
| prescribedAmountPackage |
0..1 | INT | The number of medication packages. | |
| prescibedAmountTotal |
0..1 | INT | How much medication prescribed in total on prescription. | |
| prescriptionValidityTime |
0..* | DT | For expressing the validity of the prescription(s). | |
| prescriptionAuthorization |
0..* | CD | Defines the authorization of the prescription. | |
| cancelledPrescription |
0..1 | Class | Cancellation of prescription. | |
| cancelledStatusReason |
0..* | CD | Reason for cancellation. | |
| cancelledTime |
0..* | DT | Time of cancellation. | |
| substitution |
0..1 | Class | Whether and which type of substitution is allowed for this medication. | |
| substitutionAllowed |
0..1 | BL | Whether substitution is allowed for this medication. | |
| substitutionType |
1..1 | CD | The type of substitution that is allowed. | |
| substitutionTypeReason |
0..1 | CD | Coded reason for the substitution requirement | |
| substitutionTypeReasonText |
0..1 | ST | Textual reason for the substitution requirement | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Practitioner who is creating prescription. | |
| organisation |
1..1 | Reference() | Organisation connected to practitioner and prescription. | |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| reimbursement |
1..1 | Class | For representation of the reimbursement rate and reason of prescription medicine. | |
| reimbursementRate |
1..1 | CD | Reimbursement of medication. | |
| reimbursementReason |
1..1 | ST | Reason of the reimbursement rate. | |
| reimbursementParameters |
1..1 | Class | Insurance response. | |
| reimbursementEu |
0..1 | BL | EU insurance. | |
| reimbursementOldAgeRetirement |
0..1 | BL | Old age pension. | |
| reimbursementIncapacityForWork |
0..1 | BL | Pension for incapacity for work. | |
| reimbursementEstonian |
0..1 | BL | Estonian insurance. | |
| unauthorizedMedicationRequest |
0..1 | Class | Requesting usage permit for unauthorized medication. | |
| identifier |
1..1 | II | Unauthorized medication request number. | |
| requestReason |
1..1 | CD | Unauthorized medication reason. | |
| status |
0..1 | CD | Status of unauthorized medication request can be positive or negative. | |
| requestDate |
1..1 | DT | Date when the request was made. | |
| requestDecision |
0..1 | CD | If requestStatus is negative there has to be a reason explaining the negative decision. | |
| requestDecisionText |
0..1 | ST | If requestStatus is negative there has to be a reason explaining the negative decision in text | |
| dosage |
0..* | Class | Dosage | |
| sequence |
0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes. | |
| text |
0..1 | ST | Free text usage/dosage instructions. | |
| patientInstruction |
0..1 | ST | Patient oriented instructions as free text. | |
| additionalInstruction |
0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
| doseAndRate |
0..* | Class | Amount of medication administered per one dose (one timing). | |
| type |
0..1 | CD | The kind of dose or rate specified e.g calculated, ordered, etc. | |
| dose |
0..1 | PQ | Amount of medication per one dose e.g 1 tablet, 1-2 tablets, 100 ml. | |
| rate |
0..1 | RTO | Amount of medication per unit of time. Time period during which one defined dose is administered e.g per 1 hour, per 5-10 minutes. | |
| timing |
0..1 | Class | When medication should be administered e.g period, time of day, frequency, etc. | |
| event |
0..* | DT | Exact date and/or time of the administration. | |
| code |
0..1 | CD | Timing abbreviation, e.g AM - morning. | |
| repeat |
0..1 | Class | Repetition of the administration. | |
| bounds |
0..1 | Class | Time bounds for the treatment (current dosaging scheme). | |
| duration |
0..1 | PQ | Number of time units, e.g 10 days. | |
| range |
0..1 | Class | A range of numbers of time units, e.g 5-10 days. | |
| rangeMinimum |
0..1 | PQ | Minimum number of time units. | |
| rangeMaximum |
0..1 | PQ | Maximum number of time units. | |
| period |
0..1 | Class | Start and end date, 12.04.2024 - 12.06.2024. | |
| startDate |
0..1 | DT | Start date of administering medication. | |
| endDate |
0..1 | DT | End time of administering medication. | |
| count |
0..1 | Class | Number of times to repeat, exact or range. | |
| count |
1..1 | INT | Number of times e.g twice, 10 times. | |
| countMax |
0..1 | INT | Maximum number of times e.g maximum 15 times. | |
| duration |
0..1 | Class | Duration of one administration, exact or range. | |
| duration |
1..1 | PQ | Duration of administration e.g 15 minutes, 2 hour. | |
| durationMax |
0..1 | PQ | Maximum duration of administration e.g maximum 20 minutes. | |
| frequency |
0..1 | Class | Frequency of intake/administration e.g 4 times a day. | |
| numberOfTimes |
1..1 | INT | Number of times per period e.g 8 times. | |
| maxNumberOfTimes |
0..1 | INT | Maximum number of times per period e.g. maximum 8 times. | |
| period |
1..1 | PQ | Duration to which the frequency applies e.g '... / 1 day. | |
| periodMax |
0..1 | PQ | Upper limit of the period e.g 4-6 hours. | |
| dayOfWeek |
0..* | CD | The day of the week of administration, e.g Mon, Tue, etc. | |
| timeOfDay |
0..* | DT | Time of day of administration e.g 15:00. | |
| eventTime |
0..* | Class | An event the administration is bound to, e.g before meal, 30 min before meal. | |
| when |
0..* | CD | Time period or event e.g before meal, morning. | |
| offset |
0..1 | INT | Minutes from event, before or after. | |
| asNeeded |
0..1 | BL | Take as needed. | |
| asNeededFor |
0..* | CD | Take as needed for the coded reason. | |
| bodySite |
0..1 | CD | Body site of administration. | |
| routeOfAdministration |
0..1 | CD | Route of administration. | |
| methodOfAdministration |
0..1 | CD | Method or technique for administering medication. | |
| maxDose |
0..* | Class | Maximum dose for the patient | |
| maxDosePerPeriod |
0..* | RTO | Upper limit on medication per unit of time | |
| maxDosePerAdministration |
0..1 | PQ | Upper limit on medication per one administration | |
| maxDosePerLifetime |
1..1 | PQ | Upper limit on medication per lifetime of the patient | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IntegrationTJT |
0..* | Base | Integration TJT - logical model Instances of this logical model are not marked to be the target of a Reference | |
| metadata |
1..1 | Class | Metadata about the medication schema | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description |
0..* | ST | Description of the model | |
| version |
0..1 | ST | Version of the model | |
| status |
1..1 | CD | Status | |
| date |
0..* | DT | Datetime of the model | |
| lastUpdated |
0..1 | DT | Last updated | |
| treatmentLineRecordingMetaData |
0..1 | Class | Metadata about reporting/authoring of the treatment line | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| recorder |
1..1 | Reference(Practitioner TJT - logical model) | Person authoring/cancelling the treatment line, either by requesting a treatment or documenting a patient's statement | |
| recordedTime |
1..1 | DT | Time of creation of the treatment line | |
| patientReported |
0..1 | BL | The treatment line has been documented according to patient's. | |
| authorResponsible |
0..1 | Reference(Practitioner TJT - logical model) | HCP who takes the clinical decision for the medication treatment line. | |
| authoringTime |
0..1 | DT | The time the decision was made. | |
| initialAuthor |
0..* | Reference(Practitioner TJT - logical model) | Initial author of the medication schema line. | |
| medicationTreatmentLine |
0..* | Class | Treatment line representing some sort of medication. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
0..* | II | Unique business identifier(s) for the medication treatment line. | |
| status |
1..1 | CD | A code representing the status of recording the medication statement, recorded or draft. | |
| verification |
0..* | Class | Represents whether the treatment line is verified | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the treatment line | |
| verificationTime |
1..1 | DT | The date and time when this medication treatment line was verified | |
| derivedFrom |
0..* | II | Prescriptions that are connected to this Medication Treatment Line | |
| indication |
0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
| indicationText |
0..1 | ST | Additional instructions | |
| comment |
0..* | Class | Comment on the individual line | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medicationOverview |
0..1 | Class | Overview of the medication in the medication schema | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| medicationTreatmentLine |
0..* | Reference(Medication TreatmentLine TJT - logical model) | List item in the list of all current medication based treatments | |
| verification |
0..1 | Class | Represents whether the medication schema is verified | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the schema | |
| verificationTime |
1..1 | DT | The date and time when this medication schema was verified | |
| comment |
0..* | Class | Comment on the medication overview | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medication |
1..* | Class | Medicinal product | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifierMedication |
0..* | Class | Business identifier for this medication. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| packagedProductIdentifier |
0..* | II | Identifier at the package level, can be PCID or national | |
| classification |
0..1 | Class | Code for the product that is actually being specified, in established terminologies | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| classificationATC |
0..1 | CD | ATC code | |
| classificationOther |
0..* | CD | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) | |
| productName |
0..* | Class | Name of the product (full name, invented name, other). | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
0..1 | ST | Name that is relevant for the users. | |
| patientPersonalMedication |
0..1 | BL | Whether the administered medication was patient's own or given by a healthcare professional. | |
| routeOfAdministration |
0..* | CD | The path by which the product is taken into or makes contact with the body. | |
| routeOfAdministrationSpecified |
0..1 | ST | Route of administration specified with a free text field. | |
| doseForm |
0..* | CD | Dose form | |
| doseFormSpecified |
0..1 | ST | Specified dose form | |
| medicationInfoType |
0..1 | CD | Information source or type of medication (prescription, verbal, given by the healthcare worker) | |
| device |
0..* | Class | Administration device included in the product. Device that is integral to the medicinal product, in effect being considered as an ingredient of the medicinal product. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| deviceQuantity |
1..1 | PQ | Number of such devices | |
| device |
1..1 | CD | Device coded | |
| manufacturedItem |
0..* | Class | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| manufacturedDoseForm |
0..1 | CD | Dose form | |
| unitOfPresentation |
0..1 | CD | Unit of presentation for the manufactured item (tablet, vial, tube). | |
| containedQuantity |
0..1 | PQ | Manufactured item quantity for liquids (3ml/vial). | |
| amount |
0..1 | Class | Number of such manufactured items in this product (5 vials). | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ingredient |
1..* | Class | Ingredients | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
1..1 | BL | Role (active ingredient, excipient). | |
| substance |
1..1 | CD | Substance | |
| strengthInfo |
1..* | Class | Concentration or presentation strength | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| strength |
1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
| strengthType |
0..1 | CD | Type of strength that is expressed | |
| strengthSubstance |
0..1 | CD | Substance that the strength refers to, if different from the main substance | |
| packedProduct |
0..1 | Class | A medically related item or items of any type, in a container or package. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| packSize |
0..* | PQ | Overall amount of product in one package. | |
| productCode |
0..* | ST | Product code on the package of packaged product. | |
| serialNumber |
0..* | ST | Serial number on the medication package. | |
| batchNumber |
0..* | ST | Batch number on the medication package. The assigned lot number of a batch of the specified product. | |
| expirationDate |
0..* | DT | When this specific batch of product will expire. | |
| marketingAuthorization |
0..1 | Class | Market Authorization relating to a Medicinal Product. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
0..1 | ST | Marketing authorisation number. | |
| type |
0..1 | CD | Shows that this product is approved, type of regulatory entitlement. | |
| region |
0..1 | CD | Region where document is valid. | |
| status |
0..1 | CD | Wether or not the authorisation is valid. | |
| holder |
0..1 | Class | Marketing authorisation holder. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| holderIdentifier |
0..1 | CD | Marketing authorisation holder. | |
| holderName |
0..1 | ST | Marketing authorisation holder name. | |
| prescription |
0..* | Class | Prescription | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifierPrescription |
1..* | II | An identifier for this prescription | |
| status |
1..1 | CD | A code representing the status of prescription active, on-hold, ended, stopped, completed, cancelled, entered-in-error, draft, unknown. | |
| lockStatus |
0..* | BL | When pharmacy locks the prescription for ordering unauthorized medication for patient. True - prescription is locked for certain pharmacy. False - prescription is not locked. | |
| reason |
1..1 | CD | Reason or indication for ordering the medication. | |
| intent |
0..* | CD | Intent of prescription | |
| note |
0..1 | ST | Extra information about the prescription that could not be conveyed by the other attributes. | |
| verification |
0..* | Class | Represents whether the prescription is verified | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the prescription | |
| verificationTime |
1..1 | DT | The date and time when this medication prescription was verified | |
| courseOfTherapyType |
0..* | CD | Type of therapy | |
| prescriptionCategory |
0..* | CD | Category of prescription. | |
| repeatCategory |
0..* | CD | Prescriptions to repeat | |
| prescribedAmount |
0..1 | Class | How much medication prescribed on prescription. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| prescribedAmountPackage |
0..1 | INT | The number of medication packages. | |
| prescibedAmountTotal |
0..1 | INT | How much medication prescribed in total on prescription. | |
| prescriptionValidityTime |
0..* | DT | For expressing the validity of the prescription(s). | |
| prescriptionAuthorization |
0..* | CD | Defines the authorization of the prescription. | |
| cancelledPrescription |
0..1 | Class | Cancellation of prescription. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| cancelledStatusReason |
0..* | CD | Reason for cancellation. | |
| cancelledTime |
0..* | DT | Time of cancellation. | |
| substitution |
0..1 | Class | Whether and which type of substitution is allowed for this medication. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substitutionAllowed |
0..1 | BL | Whether substitution is allowed for this medication. | |
| substitutionType |
1..1 | CD | The type of substitution that is allowed. | |
| substitutionTypeReason |
0..1 | CD | Coded reason for the substitution requirement | |
| substitutionTypeReasonText |
0..1 | ST | Textual reason for the substitution requirement | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Practitioner who is creating prescription. | |
| organisation |
1..1 | Reference() | Organisation connected to practitioner and prescription. | |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| reimbursement |
1..1 | Class | For representation of the reimbursement rate and reason of prescription medicine. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reimbursementRate |
1..1 | CD | Reimbursement of medication. | |
| reimbursementReason |
1..1 | ST | Reason of the reimbursement rate. | |
| reimbursementParameters |
1..1 | Class | Insurance response. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reimbursementEu |
0..1 | BL | EU insurance. | |
| reimbursementOldAgeRetirement |
0..1 | BL | Old age pension. | |
| reimbursementIncapacityForWork |
0..1 | BL | Pension for incapacity for work. | |
| reimbursementEstonian |
0..1 | BL | Estonian insurance. | |
| unauthorizedMedicationRequest |
0..1 | Class | Requesting usage permit for unauthorized medication. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
1..1 | II | Unauthorized medication request number. | |
| requestReason |
1..1 | CD | Unauthorized medication reason. | |
| status |
0..1 | CD | Status of unauthorized medication request can be positive or negative. | |
| requestDate |
1..1 | DT | Date when the request was made. | |
| requestDecision |
0..1 | CD | If requestStatus is negative there has to be a reason explaining the negative decision. | |
| requestDecisionText |
0..1 | ST | If requestStatus is negative there has to be a reason explaining the negative decision in text | |
| dosage |
0..* | Class | Dosage | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequence |
0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes. | |
| text |
0..1 | ST | Free text usage/dosage instructions. | |
| patientInstruction |
0..1 | ST | Patient oriented instructions as free text. | |
| additionalInstruction |
0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
| doseAndRate |
0..* | Class | Amount of medication administered per one dose (one timing). | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
0..1 | CD | The kind of dose or rate specified e.g calculated, ordered, etc. | |
| dose |
0..1 | PQ | Amount of medication per one dose e.g 1 tablet, 1-2 tablets, 100 ml. | |
| rate |
0..1 | RTO | Amount of medication per unit of time. Time period during which one defined dose is administered e.g per 1 hour, per 5-10 minutes. | |
| timing |
0..1 | Class | When medication should be administered e.g period, time of day, frequency, etc. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event |
0..* | DT | Exact date and/or time of the administration. | |
| code |
0..1 | CD | Timing abbreviation, e.g AM - morning. | |
| repeat |
0..1 | Class | Repetition of the administration. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| bounds |
0..1 | Class | Time bounds for the treatment (current dosaging scheme). | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| duration |
0..1 | PQ | Number of time units, e.g 10 days. | |
| range |
0..1 | Class | A range of numbers of time units, e.g 5-10 days. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| rangeMinimum |
0..1 | PQ | Minimum number of time units. | |
| rangeMaximum |
0..1 | PQ | Maximum number of time units. | |
| period |
0..1 | Class | Start and end date, 12.04.2024 - 12.06.2024. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| startDate |
0..1 | DT | Start date of administering medication. | |
| endDate |
0..1 | DT | End time of administering medication. | |
| count |
0..1 | Class | Number of times to repeat, exact or range. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| count |
1..1 | INT | Number of times e.g twice, 10 times. | |
| countMax |
0..1 | INT | Maximum number of times e.g maximum 15 times. | |
| duration |
0..1 | Class | Duration of one administration, exact or range. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| duration |
1..1 | PQ | Duration of administration e.g 15 minutes, 2 hour. | |
| durationMax |
0..1 | PQ | Maximum duration of administration e.g maximum 20 minutes. | |
| frequency |
0..1 | Class | Frequency of intake/administration e.g 4 times a day. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| numberOfTimes |
1..1 | INT | Number of times per period e.g 8 times. | |
| maxNumberOfTimes |
0..1 | INT | Maximum number of times per period e.g. maximum 8 times. | |
| period |
1..1 | PQ | Duration to which the frequency applies e.g '... / 1 day. | |
| periodMax |
0..1 | PQ | Upper limit of the period e.g 4-6 hours. | |
| dayOfWeek |
0..* | CD | The day of the week of administration, e.g Mon, Tue, etc. | |
| timeOfDay |
0..* | DT | Time of day of administration e.g 15:00. | |
| eventTime |
0..* | Class | An event the administration is bound to, e.g before meal, 30 min before meal. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| when |
0..* | CD | Time period or event e.g before meal, morning. | |
| offset |
0..1 | INT | Minutes from event, before or after. | |
| asNeeded |
0..1 | BL | Take as needed. | |
| asNeededFor |
0..* | CD | Take as needed for the coded reason. | |
| bodySite |
0..1 | CD | Body site of administration. | |
| routeOfAdministration |
0..1 | CD | Route of administration. | |
| methodOfAdministration |
0..1 | CD | Method or technique for administering medication. | |
| maxDose |
0..* | Class | Maximum dose for the patient | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| maxDosePerPeriod |
0..* | RTO | Upper limit on medication per unit of time | |
| maxDosePerAdministration |
0..1 | PQ | Upper limit on medication per one administration | |
| maxDosePerLifetime |
1..1 | PQ | Upper limit on medication per lifetime of the patient | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IntegrationTJT |
0..* | Base | Integration TJT - logical model Instances of this logical model are not marked to be the target of a Reference | |
| metadata |
1..1 | Class | Metadata about the medication schema | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description |
0..* | ST | Description of the model | |
| version |
0..1 | ST | Version of the model | |
| status |
1..1 | CD | Status | |
| date |
0..* | DT | Datetime of the model | |
| lastUpdated |
0..1 | DT | Last updated | |
| treatmentLineRecordingMetaData |
0..1 | Class | Metadata about reporting/authoring of the treatment line | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| recorder |
1..1 | Reference(Practitioner TJT - logical model) | Person authoring/cancelling the treatment line, either by requesting a treatment or documenting a patient's statement | |
| recordedTime |
1..1 | DT | Time of creation of the treatment line | |
| patientReported |
0..1 | BL | The treatment line has been documented according to patient's. | |
| authorResponsible |
0..1 | Reference(Practitioner TJT - logical model) | HCP who takes the clinical decision for the medication treatment line. | |
| authoringTime |
0..1 | DT | The time the decision was made. | |
| initialAuthor |
0..* | Reference(Practitioner TJT - logical model) | Initial author of the medication schema line. | |
| medicationTreatmentLine |
0..* | Class | Treatment line representing some sort of medication. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
0..* | II | Unique business identifier(s) for the medication treatment line. | |
| status |
1..1 | CD | A code representing the status of recording the medication statement, recorded or draft. | |
| verification |
0..* | Class | Represents whether the treatment line is verified | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the treatment line | |
| verificationTime |
1..1 | DT | The date and time when this medication treatment line was verified | |
| derivedFrom |
0..* | II | Prescriptions that are connected to this Medication Treatment Line | |
| indication |
0..* | CD | Reason why the product has been prescribed to the patient, or why the patient claims to be taking it | |
| indicationText |
0..1 | ST | Additional instructions | |
| comment |
0..* | Class | Comment on the individual line | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medicationOverview |
0..1 | Class | Overview of the medication in the medication schema | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| medicationTreatmentLine |
0..* | Reference(Medication TreatmentLine TJT - logical model) | List item in the list of all current medication based treatments | |
| verification |
0..1 | Class | Represents whether the medication schema is verified | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the schema | |
| verificationTime |
1..1 | DT | The date and time when this medication schema was verified | |
| comment |
0..* | Class | Comment on the medication overview | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| author |
1..1 | Reference(Practitioner TJT - logical model) | Author of the comment (Pharmacist, doctor, caretaker). | |
| date |
1..1 | DT | Time of comment | |
| commentText |
1..1 | ST | Content of the comment | |
| medication |
1..* | Class | Medicinal product | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifierMedication |
0..* | Class | Business identifier for this medication. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| packagedProductIdentifier |
0..* | II | Identifier at the package level, can be PCID or national | |
| classification |
0..1 | Class | Code for the product that is actually being specified, in established terminologies | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| classificationATC |
0..1 | CD | ATC code | |
| classificationOther |
0..* | CD | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) | |
| productName |
0..* | Class | Name of the product (full name, invented name, other). | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
0..1 | ST | Name that is relevant for the users. | |
| patientPersonalMedication |
0..1 | BL | Whether the administered medication was patient's own or given by a healthcare professional. | |
| routeOfAdministration |
0..* | CD | The path by which the product is taken into or makes contact with the body. | |
| routeOfAdministrationSpecified |
0..1 | ST | Route of administration specified with a free text field. | |
| doseForm |
0..* | CD | Dose form | |
| doseFormSpecified |
0..1 | ST | Specified dose form | |
| medicationInfoType |
0..1 | CD | Information source or type of medication (prescription, verbal, given by the healthcare worker) | |
| device |
0..* | Class | Administration device included in the product. Device that is integral to the medicinal product, in effect being considered as an ingredient of the medicinal product. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| deviceQuantity |
1..1 | PQ | Number of such devices | |
| device |
1..1 | CD | Device coded | |
| manufacturedItem |
0..* | Class | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| manufacturedDoseForm |
0..1 | CD | Dose form | |
| unitOfPresentation |
0..1 | CD | Unit of presentation for the manufactured item (tablet, vial, tube). | |
| containedQuantity |
0..1 | PQ | Manufactured item quantity for liquids (3ml/vial). | |
| amount |
0..1 | Class | Number of such manufactured items in this product (5 vials). | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ingredient |
1..* | Class | Ingredients | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
1..1 | BL | Role (active ingredient, excipient). | |
| substance |
1..1 | CD | Substance | |
| strengthInfo |
1..* | Class | Concentration or presentation strength | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| strength |
1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
| strengthType |
0..1 | CD | Type of strength that is expressed | |
| strengthSubstance |
0..1 | CD | Substance that the strength refers to, if different from the main substance | |
| packedProduct |
0..1 | Class | A medically related item or items of any type, in a container or package. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| packSize |
0..* | PQ | Overall amount of product in one package. | |
| productCode |
0..* | ST | Product code on the package of packaged product. | |
| serialNumber |
0..* | ST | Serial number on the medication package. | |
| batchNumber |
0..* | ST | Batch number on the medication package. The assigned lot number of a batch of the specified product. | |
| expirationDate |
0..* | DT | When this specific batch of product will expire. | |
| marketingAuthorization |
0..1 | Class | Market Authorization relating to a Medicinal Product. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
0..1 | ST | Marketing authorisation number. | |
| type |
0..1 | CD | Shows that this product is approved, type of regulatory entitlement. | |
| region |
0..1 | CD | Region where document is valid. | |
| status |
0..1 | CD | Wether or not the authorisation is valid. | |
| holder |
0..1 | Class | Marketing authorisation holder. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| holderIdentifier |
0..1 | CD | Marketing authorisation holder. | |
| holderName |
0..1 | ST | Marketing authorisation holder name. | |
| prescription |
0..* | Class | Prescription | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifierPrescription |
1..* | II | An identifier for this prescription | |
| status |
1..1 | CD | A code representing the status of prescription active, on-hold, ended, stopped, completed, cancelled, entered-in-error, draft, unknown. | |
| lockStatus |
0..* | BL | When pharmacy locks the prescription for ordering unauthorized medication for patient. True - prescription is locked for certain pharmacy. False - prescription is not locked. | |
| reason |
1..1 | CD | Reason or indication for ordering the medication. | |
| intent |
0..* | CD | Intent of prescription | |
| note |
0..1 | ST | Extra information about the prescription that could not be conveyed by the other attributes. | |
| verification |
0..* | Class | Represents whether the prescription is verified | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Healthcare practitoner or a device which verifies the prescription | |
| verificationTime |
1..1 | DT | The date and time when this medication prescription was verified | |
| courseOfTherapyType |
0..* | CD | Type of therapy | |
| prescriptionCategory |
0..* | CD | Category of prescription. | |
| repeatCategory |
0..* | CD | Prescriptions to repeat | |
| prescribedAmount |
0..1 | Class | How much medication prescribed on prescription. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| prescribedAmountPackage |
0..1 | INT | The number of medication packages. | |
| prescibedAmountTotal |
0..1 | INT | How much medication prescribed in total on prescription. | |
| prescriptionValidityTime |
0..* | DT | For expressing the validity of the prescription(s). | |
| prescriptionAuthorization |
0..* | CD | Defines the authorization of the prescription. | |
| cancelledPrescription |
0..1 | Class | Cancellation of prescription. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| cancelledStatusReason |
0..* | CD | Reason for cancellation. | |
| cancelledTime |
0..* | DT | Time of cancellation. | |
| substitution |
0..1 | Class | Whether and which type of substitution is allowed for this medication. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substitutionAllowed |
0..1 | BL | Whether substitution is allowed for this medication. | |
| substitutionType |
1..1 | CD | The type of substitution that is allowed. | |
| substitutionTypeReason |
0..1 | CD | Coded reason for the substitution requirement | |
| substitutionTypeReasonText |
0..1 | ST | Textual reason for the substitution requirement | |
| practitioner |
1..1 | Reference(Practitioner TJT - logical model) | Practitioner who is creating prescription. | |
| organisation |
1..1 | Reference() | Organisation connected to practitioner and prescription. | |
| patient |
1..1 | Reference(Patient TJT - logical model) | Patient | |
| reimbursement |
1..1 | Class | For representation of the reimbursement rate and reason of prescription medicine. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reimbursementRate |
1..1 | CD | Reimbursement of medication. | |
| reimbursementReason |
1..1 | ST | Reason of the reimbursement rate. | |
| reimbursementParameters |
1..1 | Class | Insurance response. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reimbursementEu |
0..1 | BL | EU insurance. | |
| reimbursementOldAgeRetirement |
0..1 | BL | Old age pension. | |
| reimbursementIncapacityForWork |
0..1 | BL | Pension for incapacity for work. | |
| reimbursementEstonian |
0..1 | BL | Estonian insurance. | |
| unauthorizedMedicationRequest |
0..1 | Class | Requesting usage permit for unauthorized medication. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
1..1 | II | Unauthorized medication request number. | |
| requestReason |
1..1 | CD | Unauthorized medication reason. | |
| status |
0..1 | CD | Status of unauthorized medication request can be positive or negative. | |
| requestDate |
1..1 | DT | Date when the request was made. | |
| requestDecision |
0..1 | CD | If requestStatus is negative there has to be a reason explaining the negative decision. | |
| requestDecisionText |
0..1 | ST | If requestStatus is negative there has to be a reason explaining the negative decision in text | |
| dosage |
0..* | Class | Dosage | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequence |
0..1 | INT | Order of the dosage instruction, in case one treatment consists of several dosaging schemes. | |
| text |
0..1 | ST | Free text usage/dosage instructions. | |
| patientInstruction |
0..1 | ST | Patient oriented instructions as free text. | |
| additionalInstruction |
0..* | CD | Coded instructions, e.g warnings to the patient, like 'may cause drowsiness' etc | |
| doseAndRate |
0..* | Class | Amount of medication administered per one dose (one timing). | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
0..1 | CD | The kind of dose or rate specified e.g calculated, ordered, etc. | |
| dose |
0..1 | PQ | Amount of medication per one dose e.g 1 tablet, 1-2 tablets, 100 ml. | |
| rate |
0..1 | RTO | Amount of medication per unit of time. Time period during which one defined dose is administered e.g per 1 hour, per 5-10 minutes. | |
| timing |
0..1 | Class | When medication should be administered e.g period, time of day, frequency, etc. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event |
0..* | DT | Exact date and/or time of the administration. | |
| code |
0..1 | CD | Timing abbreviation, e.g AM - morning. | |
| repeat |
0..1 | Class | Repetition of the administration. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| bounds |
0..1 | Class | Time bounds for the treatment (current dosaging scheme). | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| duration |
0..1 | PQ | Number of time units, e.g 10 days. | |
| range |
0..1 | Class | A range of numbers of time units, e.g 5-10 days. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| rangeMinimum |
0..1 | PQ | Minimum number of time units. | |
| rangeMaximum |
0..1 | PQ | Maximum number of time units. | |
| period |
0..1 | Class | Start and end date, 12.04.2024 - 12.06.2024. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| startDate |
0..1 | DT | Start date of administering medication. | |
| endDate |
0..1 | DT | End time of administering medication. | |
| count |
0..1 | Class | Number of times to repeat, exact or range. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| count |
1..1 | INT | Number of times e.g twice, 10 times. | |
| countMax |
0..1 | INT | Maximum number of times e.g maximum 15 times. | |
| duration |
0..1 | Class | Duration of one administration, exact or range. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| duration |
1..1 | PQ | Duration of administration e.g 15 minutes, 2 hour. | |
| durationMax |
0..1 | PQ | Maximum duration of administration e.g maximum 20 minutes. | |
| frequency |
0..1 | Class | Frequency of intake/administration e.g 4 times a day. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| numberOfTimes |
1..1 | INT | Number of times per period e.g 8 times. | |
| maxNumberOfTimes |
0..1 | INT | Maximum number of times per period e.g. maximum 8 times. | |
| period |
1..1 | PQ | Duration to which the frequency applies e.g '... / 1 day. | |
| periodMax |
0..1 | PQ | Upper limit of the period e.g 4-6 hours. | |
| dayOfWeek |
0..* | CD | The day of the week of administration, e.g Mon, Tue, etc. | |
| timeOfDay |
0..* | DT | Time of day of administration e.g 15:00. | |
| eventTime |
0..* | Class | An event the administration is bound to, e.g before meal, 30 min before meal. | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| when |
0..* | CD | Time period or event e.g before meal, morning. | |
| offset |
0..1 | INT | Minutes from event, before or after. | |
| asNeeded |
0..1 | BL | Take as needed. | |
| asNeededFor |
0..* | CD | Take as needed for the coded reason. | |
| bodySite |
0..1 | CD | Body site of administration. | |
| routeOfAdministration |
0..1 | CD | Route of administration. | |
| methodOfAdministration |
0..1 | CD | Method or technique for administering medication. | |
| maxDose |
0..* | Class | Maximum dose for the patient | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| maxDosePerPeriod |
0..* | RTO | Upper limit on medication per unit of time | |
| maxDosePerAdministration |
0..1 | PQ | Upper limit on medication per one administration | |
| maxDosePerLifetime |
1..1 | PQ | Upper limit on medication per lifetime of the patient | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Summary
Mandatory: 0 element(45 nested mandatory elements)
Structures
This structure refers to these other structures: