MedicationKnowledge constructor
- @Default(R4ResourceType.MedicationKnowledge) @JsonKey(unknownEnumValue: R4ResourceType.MedicationKnowledge) R4ResourceType resourceType,
- @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
- @JsonKey(name: 'id') String? fhirId,
- FhirMeta? meta,
- FhirUri? implicitRules,
- @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
- FhirCode? language,
- @JsonKey(name: '_language') Element? languageElement,
- Narrative? text,
- List<
Resource> ? contained, - @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - List<
FhirExtension> ? modifierExtension, - CodeableConcept? code,
- FhirCode? status,
- @JsonKey(name: '_status') Element? statusElement,
- Reference? manufacturer,
- CodeableConcept? doseForm,
- Quantity? amount,
- List<
String> ? synonym, - @JsonKey(name: '_synonym') List<
Element?> ? synonymElement, - List<
Reference> ? associatedMedication, - List<
CodeableConcept> ? productType, - List<
MedicationKnowledgeMonograph> ? monograph, - List<
MedicationKnowledgeIngredient> ? ingredient, - FhirMarkdown? preparationInstruction,
- @JsonKey(name: '_preparationInstruction') Element? preparationInstructionElement,
- List<
CodeableConcept> ? intendedRoute, - List<
MedicationKnowledgeCost> ? cost, - List<
MedicationKnowledgeMonitoringProgram> ? monitoringProgram, - List<
MedicationKnowledgeAdministrationGuidelines> ? administrationGuidelines, - List<
MedicationKnowledgeMedicineClassification> ? medicineClassification, - MedicationKnowledgePackaging? packaging,
- List<
MedicationKnowledgeDrugCharacteristic> ? drugCharacteristic, - List<
Reference> ? contraindication, - List<
MedicationKnowledgeRegulatory> ? regulatory, - List<
MedicationKnowledgeKinetics> ? kinetics,
MedicationKnowledge Information about a medication that is used to support knowledge.
resourceType
This is a MedicationKnowledge resource
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta
The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not always
be associated with version changes to the resource.
implicitRules
A reference to a set of rules that were followed when the
resource was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
implicitRulesElement
Extensions for implicitRules
language
The base language in which the resource is written.
languageElement
Extensions for language
text
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human. The
narrative need not encode all the structured data, but is required to
contain sufficient detail to make it "clinically safe" for a human to just
read the narrative. Resource definitions may define what content should be
represented in the narrative to ensure clinical safety.
contained
These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, and nor can they have their own independent transaction
scope.
extension_
May be used to represent additional information that is not
part of the basic definition of the resource. To make the use of
extensions safe and manageable, there is a strict set of governance
applied to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL be met
as part of the definition of the extension.
modifierExtension
May be used to represent additional information that
is not part of the basic definition of the resource and that modifies the
understanding of the element that contains it and/or the understanding of
the containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define an
extension, there is a set of requirements that SHALL be met as part of the
definition of the extension. Applications processing a resource are
required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on
Resource or DomainResource (including cannot change the meaning of
modifierExtension itself).
code
A code that specifies this medication, or a textual description if
no code is available. Usage note: This could be a standard medication code
such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a
national or local formulary code, optionally with translations to other
code systems.
status
A code to indicate if the medication is in active use. The
status refers to the validity about the information of the medication and
not to its medicinal properties.
statusElement
Extensions for status
manufacturer
Describes the details of the manufacturer of the
medication product. This is not intended to represent the distributor of
a medication product.
doseForm
Describes the form of the item. Powder; tablets; capsule.
amount
Specific amount of the drug in the packaged product. For
example, when specifying a product that has the same strength (For
example, Insulin glargine 100 unit per mL solution for injection), this
attribute provides additional clarification of the package amount (For
example, 3 mL, 10mL, etc.).
synonym
Additional names for a medication, for example, the name(s)
given to a medication in different countries. For example, acetaminophen
and paracetamol or salbutamol and albuterol.
synonymElement
Extensions for synonym
relatedMedicationKnowledge
Associated or related knowledge about a
medication.
associatedMedication
Associated or related medications. For example,
if the medication is a branded product (e.g. Crestor), this is the
Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication
(e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
productType
Category of the medication or product (e.g. branded
product, therapeutic moeity, generic product, innovator product, etc.).
monograph
Associated documentation about the medication.
ingredient
Identifies a particular constituent of interest in the
product.
preparationInstruction
The instructions for preparing the medication.
preparationInstructionElement
Extensions for preparationInstruction
intendedRoute
The intended or approved route of administration.
cost
The price of the medication.
monitoringProgram
The program under which the medication is reviewed.
administrationGuidelines
Guidelines for the administration of the
medication.
medicineClassification
Categorization of the medication within a
formulary or classification system.
packaging
Information that only applies to packages (not products).
drugCharacteristic
Specifies descriptive properties of the medicine,
such as color, shape, imprints, etc.
contraindication
Potential clinical issue with or between medication(s)
(for example, drug-drug interaction, drug-disease contraindication,
drug-allergy interaction, etc.).
regulatory
Regulatory information about a medication.
kinetics
The time course of drug absorption, distribution, metabolism
and excretion of a medication from the body.
Implementation
const factory MedicationKnowledge({
@Default(R4ResourceType.MedicationKnowledge)
@JsonKey(unknownEnumValue: R4ResourceType.MedicationKnowledge)
/// [resourceType] This is a MedicationKnowledge resource
R4ResourceType resourceType,
@JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
/// [id] The logical id of the resource, as used in the URL for the resource.
/// Once assigned, this value never changes.
@JsonKey(name: 'id') String? fhirId,
/// [meta] The metadata about the resource. This is content that is
/// maintained by the infrastructure. Changes to the content might not always
/// be associated with version changes to the resource.
FhirMeta? meta,
/// [implicitRules] A reference to a set of rules that were followed when the
/// resource was constructed, and which must be understood when processing the
/// content. Often, this is a reference to an implementation guide that
/// defines the special rules along with other profiles etc.
FhirUri? implicitRules,
/// [implicitRulesElement] Extensions for implicitRules
@JsonKey(name: '_implicitRules') Element? implicitRulesElement,
/// [language] The base language in which the resource is written.
FhirCode? language,
/// [languageElement] Extensions for language
@JsonKey(name: '_language') Element? languageElement,
/// [text] A human-readable narrative that contains a summary of the resource
/// and can be used to represent the content of the resource to a human. The
/// narrative need not encode all the structured data, but is required to
/// contain sufficient detail to make it "clinically safe" for a human to just
/// read the narrative. Resource definitions may define what content should be
/// represented in the narrative to ensure clinical safety.
Narrative? text,
/// [contained] These resources do not have an independent existence apart
/// from the resource that contains them - they cannot be identified
/// independently, and nor can they have their own independent transaction
/// scope.
List<Resource>? contained,
/// [extension_] May be used to represent additional information that is not
/// part of the basic definition of the resource. To make the use of
/// extensions safe and manageable, there is a strict set of governance
/// applied to the definition and use of extensions. Though any implementer
/// can define an extension, there is a set of requirements that SHALL be met
/// as part of the definition of the extension.
@JsonKey(name: 'extension') List<FhirExtension>? extension_,
/// [modifierExtension] May be used to represent additional information that
/// is not part of the basic definition of the resource and that modifies the
/// understanding of the element that contains it and/or the understanding of
/// the containing element's descendants. Usually modifier elements provide
/// negation or qualification. To make the use of extensions safe and
/// manageable, there is a strict set of governance applied to the definition
/// and use of extensions. Though any implementer is allowed to define an
/// extension, there is a set of requirements that SHALL be met as part of the
/// definition of the extension. Applications processing a resource are
/// required to check for modifier extensions.
/// Modifier extensions SHALL NOT change the meaning of any elements on
/// Resource or DomainResource (including cannot change the meaning of
/// modifierExtension itself).
List<FhirExtension>? modifierExtension,
/// [code] A code that specifies this medication, or a textual description if
/// no code is available. Usage note: This could be a standard medication code
/// such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a
/// national or local formulary code, optionally with translations to other
/// code systems.
CodeableConcept? code,
/// [status] A code to indicate if the medication is in active use. The
/// status refers to the validity about the information of the medication and
/// not to its medicinal properties.
FhirCode? status,
/// [statusElement] Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [manufacturer] Describes the details of the manufacturer of the
/// medication product. This is not intended to represent the distributor of
/// a medication product.
Reference? manufacturer,
/// [doseForm] Describes the form of the item. Powder; tablets; capsule.
CodeableConcept? doseForm,
/// [amount] Specific amount of the drug in the packaged product. For
/// example, when specifying a product that has the same strength (For
/// example, Insulin glargine 100 unit per mL solution for injection), this
/// attribute provides additional clarification of the package amount (For
/// example, 3 mL, 10mL, etc.).
Quantity? amount,
/// [synonym] Additional names for a medication, for example, the name(s)
/// given to a medication in different countries. For example, acetaminophen
/// and paracetamol or salbutamol and albuterol.
List<String>? synonym,
/// [synonymElement] Extensions for synonym
@JsonKey(name: '_synonym') List<Element?>? synonymElement,
List<MedicationKnowledgeRelatedMedicationKnowledge>?
/// [relatedMedicationKnowledge] Associated or related knowledge about a
/// medication.
relatedMedicationKnowledge,
/// [associatedMedication] Associated or related medications. For example,
/// if the medication is a branded product (e.g. Crestor), this is the
/// Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication
/// (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
List<Reference>? associatedMedication,
/// [productType] Category of the medication or product (e.g. branded
/// product, therapeutic moeity, generic product, innovator product, etc.).
List<CodeableConcept>? productType,
/// [monograph] Associated documentation about the medication.
List<MedicationKnowledgeMonograph>? monograph,
/// [ingredient] Identifies a particular constituent of interest in the
/// product.
List<MedicationKnowledgeIngredient>? ingredient,
/// [preparationInstruction] The instructions for preparing the medication.
FhirMarkdown? preparationInstruction,
@JsonKey(name: '_preparationInstruction')
/// [preparationInstructionElement] Extensions for preparationInstruction
Element? preparationInstructionElement,
/// [intendedRoute] The intended or approved route of administration.
List<CodeableConcept>? intendedRoute,
/// [cost] The price of the medication.
List<MedicationKnowledgeCost>? cost,
/// [monitoringProgram] The program under which the medication is reviewed.
List<MedicationKnowledgeMonitoringProgram>? monitoringProgram,
/// [administrationGuidelines] Guidelines for the administration of the
/// medication.
List<MedicationKnowledgeAdministrationGuidelines>? administrationGuidelines,
/// [medicineClassification] Categorization of the medication within a
/// formulary or classification system.
List<MedicationKnowledgeMedicineClassification>? medicineClassification,
/// [packaging] Information that only applies to packages (not products).
MedicationKnowledgePackaging? packaging,
/// [drugCharacteristic] Specifies descriptive properties of the medicine,
/// such as color, shape, imprints, etc.
List<MedicationKnowledgeDrugCharacteristic>? drugCharacteristic,
/// [contraindication] Potential clinical issue with or between medication(s)
/// (for example, drug-drug interaction, drug-disease contraindication,
/// drug-allergy interaction, etc.).
List<Reference>? contraindication,
/// [regulatory] Regulatory information about a medication.
List<MedicationKnowledgeRegulatory>? regulatory,
/// [kinetics] The time course of drug absorption, distribution, metabolism
/// and excretion of a medication from the body.
List<MedicationKnowledgeKinetics>? kinetics,
}) = _MedicationKnowledge;