MedicationKnowledge constructor
- @Default(R5ResourceType.MedicationKnowledge) @JsonKey(unknownEnumValue: R5ResourceType.MedicationKnowledge) R5ResourceType resourceType,
- @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
- @JsonKey(name: 'id') FhirId? 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, - FhirUri? url,
- @JsonKey(name: '_url') Element? urlElement,
- List<
Identifier> ? identifier, - String? version,
- @JsonKey(name: '_version') Element? versionElement,
- String? versionAlgorithmString,
- @JsonKey(name: '_versionAlgorithmString') Element? versionAlgorithmStringElement,
- Coding? versionAlgorithmCoding,
- List<
String> ? name, - @JsonKey(name: '_name') List<
Element> ? nameElement, - String? title,
- @JsonKey(name: '_title') Element? titleElement,
- FhirCode? status,
- @JsonKey(name: '_status') Element? statusElement,
- FhirBoolean? experimental,
- @JsonKey(name: '_experimental') Element? experimentalElement,
- FhirDateTime? date,
- @JsonKey(name: '_date') Element? dateElement,
- String? publisher,
- @JsonKey(name: '_publisher') Element? publisherElement,
- List<
ContactDetail> ? contact, - FhirMarkdown? description,
- @JsonKey(name: '_description') Element? descriptionElement,
- List<
UsageContext> ? useContext, - List<
CodeableConcept> ? jurisdiction, - FhirMarkdown? purpose,
- @JsonKey(name: '_purpose') Element? purposeElement,
- FhirMarkdown? copyright,
- @JsonKey(name: '_copyright') Element? copyrightElement,
- String? copyrightLabel,
- @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement,
- FhirDate? approvalDate,
- @JsonKey(name: '_approvalDate') Element? approvalDateElement,
- FhirDate? lastReviewDate,
- @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement,
- Period? effectivePeriod,
- List<
CodeableConcept> ? topic, - Reference? author,
- List<
ContactDetail> ? editor, - List<
ContactDetail> ? reviewer, - List<
ContactDetail> ? endorser, - CodeableConcept? code,
- List<
CodeableConcept> ? intendedJurisdiction, - List<
Reference> ? associatedMedication, - List<
CodeableConcept> ? productType, - List<
MedicationKnowledgeMonograph> ? monograph, - FhirMarkdown? preparationInstruction,
- @JsonKey(name: '_preparationInstruction') Element? preparationInstructionElement,
- List<
MedicationKnowledgeCost> ? cost, - List<
MedicationKnowledgeMonitoringProgram> ? monitoringProgram, - List<
MedicationKnowledgeIndicationGuideline> ? indicationGuideline, - List<
MedicationKnowledgeMedicineClassification> ? medicineClassification, - List<
MedicationKnowledgePackaging> ? packaging, - List<
Reference> ? clinicalUseIssue, - List<
MedicationKnowledgeStorageGuideline> ? storageGuideline, - List<
MedicationKnowledgeRegulatory> ? regulatory, - MedicationKnowledgeDefinitional? definitional,
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
("_implicitRules") Extensions for implicitRules
language
The base language in which the resource is written.
languageElement
("_language") 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, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it is
referenced by a resource that provides context/meaning.
extension_
("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 managable, 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 managable, 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).
url
An absolute URI that is used to identify this {{title}} when it is
referenced in a specification, model, design or an instance; also called
its canonical identifier. This SHOULD be globally unique and SHOULD be a
literal address at which an authoritative instance of this {{title}} is
(or will be) published. This URL can be the target of a canonical
reference. It SHALL remain the same when the {{title}} is stored on
different servers.
urlElement
("_url") Extensions for url
identifier
Business identifier for this medication.
version
The identifier that is used to identify this version of the
{{title}} when it is referenced in a specification, model, design or
instance. This is an arbitrary value managed by the {{title}} author and
is not expected to be globally unique. For example, it might be a
timestamp (e.g. yyyymmdd) if a managed version is not available. There
is also no expectation that versions can be placed in a lexicographical
sequence without additional knowledge. (See the versionAlgorithm
element.)
versionElement
("_version") Extensions for version
versionAlgorithmString
Indicates the mechanism used to compare versions
to determine which is more current.
versionAlgorithmStringElement
("_versionAlgorithmString") Extensions
for versionAlgorithmString
versionAlgorithmCoding
Indicates the mechanism used to compare versions
to determine which is more current.
name
All of the 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.
nameElement
("_name") Extensions for name
title
A short, descriptive, user-friendly title for the {{title}}.
titleElement
("_title") Extensions for title
status
A code to indicate if the medication referred to by this
MedicationKnowledge is in active use within the drug database or
inventory system. The status refers to the validity about the
information of the medication and not to its medicinal properties.
statusElement
("_status") Extensions for status
experimental
A Boolean value to indicate that this {{title}} is
authored for testing purposes (or education/evaluation/marketing) and is
not intended for genuine usage.
experimentalElement
("_experimental") Extensions for experimental
date
The date (and optionally time) when the {{title}} was last
significantly changed. The date must change when the business version
changes and it must change if the status code changes. In addition, it
should change when the substantive content of the {{title}} changes.
dateElement
("_date") Extensions for date
publisher
The name of the organization or individual responsible for
the release and ongoing maintenance of the {{title}}.
publisherElement
("_publisher") Extensions for publisher
contact
Contact details to assist a user in finding and communicating
with the publisher.
description
A free text natural language description of the {{title}}
from a consumer's perspective.
descriptionElement
("_description") Extensions for description
useContext
The content was developed with a focus and intent of
supporting the contexts that are listed. These contexts may be general
categories (gender, age, ...) or may be references to specific programs
(insurance plans, studies, ...) and may be used to assist with indexing
and searching for appropriate {{title}}s.
jurisdiction
A legal or geographic region in which the {{title}} is
intended to be used.
purpose
Explanation of why this {{title}} is needed and why it has been
designed as it has.
purposeElement
("_purpose") Extensions for purpose
copyright
A copyright statement relating to the {{title}} and/or its
contents. Copyright statements are generally legal restrictions on the
use and publishing of the {{title}}.
copyrightElement
("_copyright") Extensions for copyright
copyrightLabel
A short string (<50 characters), suitable for inclusion
in a page footer that identifies the copyright holder, effective period,
and optionally whether rights are resctricted. (e.g. 'All rights
reserved', 'Some rights reserved').
copyrightLabelElement
("_copyrightLabel") Extensions for copyrightLabel
approvalDate
The date on which the resource content was approved by the
publisher. Approval happens once when the content is officially approved
for usage.
approvalDateElement
("_approvalDate") Extensions for approvalDate
lastReviewDate
The date on which the resource content was last
reviewed. Review happens periodically after approval but does not change
the original approval date.
lastReviewDateElement
("_lastReviewDate") Extensions for lastReviewDate
effectivePeriod
The period during which the {{title}} content was or is
planned to be in active use.
topic
Descriptive topics related to the content of the {{title}}.
Topics provide a high-level categorization as well as keywords for the
{{title}} that can be useful for filtering and searching.
author
The creator or owner of the knowledge or information about the
medication.
editor
An individual or organization primarily responsible for internal
coherence of the {{title}}.
reviewer
An individual or organization asserted by the publisher to be
primarily responsible for review of some aspect of the {{title}}.
endorser
An individual or organization asserted by the publisher to be
responsible for officially endorsing the {{title}} for use in some
setting.
relatedArtifact
Related artifacts such as additional documentation,
justification, dependencies, bibliographic references, and predecessor
and successor artifacts.
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.
intendedJurisdiction
Lists the jurisdictions that this medication
knowledge was written for.
relatedMedicationKnowledge
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.
associatedMedication
Links to associated medications that could be
prescribed, dispensed or administered.
productType
Category of the medication or product (e.g. branded
product, therapeutic moeity, generic product, innovator product, etc.).
monograph
Associated documentation about the medication.
preparationInstruction
The instructions for preparing the medication.
preparationInstructionElement
("_preparationInstruction") Extensions
for preparationInstruction
cost
The price of the medication.
monitoringProgram
The program under which the medication is reviewed.
indicationGuideline
Guidelines or protocols that are applicable for the
administration of the medication based on indication.
medicineClassification
Categorization of the medication within a
formulary or classification system.
packaging
Information that only applies to packages (not products).
clinicalUseIssue
Potential clinical issue with or between medication(s)
(for example, drug-drug interaction, drug-disease contraindication,
drug-allergy interaction, etc.).
storageGuideline
Information on how the medication should be stored,
for example, refrigeration temperatures and length of stability at a
given temperature.
regulatory
Regulatory information about a medication.
definitional
Along with the link to a Medicinal Product Definition
resource, this information provides common definitional elements that
are needed to understand the specific medication that is being described.
Implementation
const factory MedicationKnowledge({
/// [resourceType] This is a MedicationKnowledge resource
@Default(R5ResourceType.MedicationKnowledge)
@JsonKey(unknownEnumValue: R5ResourceType.MedicationKnowledge)
R5ResourceType 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') FhirId? 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] ("_implicitRules") Extensions for implicitRules
@JsonKey(name: '_implicitRules') Element? implicitRulesElement,
/// [language] The base language in which the resource is written.
FhirCode? language,
/// [languageElement] ("_language") 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, nor can they have their own independent transaction
/// scope. This is allowed to be a Parameters resource if and only if it
/// is referenced by a resource that provides context/meaning.
List<Resource>? contained,
/// [extension_] ("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 managable, 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 managable, 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,
/// [url] An absolute URI that is used to identify this {{title}} when it
/// is referenced in a specification, model, design or an instance; also
/// called its canonical identifier. This SHOULD be globally unique and
/// SHOULD be a literal address at which an authoritative instance of this
/// {{title}} is (or will be) published. This URL can be the target of a
/// canonical reference. It SHALL remain the same when the {{title}} is
/// stored on different servers.
FhirUri? url,
/// [urlElement] ("_url") Extensions for url
@JsonKey(name: '_url') Element? urlElement,
/// [identifier] Business identifier for this medication.
List<Identifier>? identifier,
/// [version] The identifier that is used to identify this version of the
/// {{title}} when it is referenced in a specification, model, design or
/// instance. This is an arbitrary value managed by the {{title}} author
/// and is not expected to be globally unique. For example, it might be a
/// timestamp (e.g. yyyymmdd) if a managed version is not available. There
/// is also no expectation that versions can be placed in a
/// lexicographical sequence without additional knowledge. (See the
/// versionAlgorithm element.)
String? version,
/// [versionElement] ("_version") Extensions for version
@JsonKey(name: '_version') Element? versionElement,
/// [versionAlgorithmString] Indicates the mechanism used to compare
/// versions to determine which is more current.
String? versionAlgorithmString,
/// [versionAlgorithmStringElement] ("_versionAlgorithmString") Extensions
/// for versionAlgorithmString
@JsonKey(name: '_versionAlgorithmString')
Element? versionAlgorithmStringElement,
/// [versionAlgorithmCoding] Indicates the mechanism used to compare
/// versions to determine which is more current.
Coding? versionAlgorithmCoding,
/// [name] All of the 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>? name,
/// [nameElement] ("_name") Extensions for name
@JsonKey(name: '_name') List<Element>? nameElement,
/// [title] A short, descriptive, user-friendly title for the {{title}}.
String? title,
/// [titleElement] ("_title") Extensions for title
@JsonKey(name: '_title') Element? titleElement,
/// [status] A code to indicate if the medication referred to by this
/// MedicationKnowledge is in active use within the drug database or
/// inventory system. The status refers to the validity about the
/// information of the medication and not to its medicinal properties.
FhirCode? status,
/// [statusElement] ("_status") Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [experimental] A Boolean value to indicate that this {{title}} is
/// authored for testing purposes (or education/evaluation/marketing) and
/// is not intended for genuine usage.
FhirBoolean? experimental,
/// [experimentalElement] ("_experimental") Extensions for experimental
@JsonKey(name: '_experimental') Element? experimentalElement,
/// [date] The date (and optionally time) when the {{title}} was last
/// significantly changed. The date must change when the business version
/// changes and it must change if the status code changes. In addition, it
/// should change when the substantive content of the {{title}} changes.
FhirDateTime? date,
/// [dateElement] ("_date") Extensions for date
@JsonKey(name: '_date') Element? dateElement,
/// [publisher] The name of the organization or individual responsible for
/// the release and ongoing maintenance of the {{title}}.
String? publisher,
/// [publisherElement] ("_publisher") Extensions for publisher
@JsonKey(name: '_publisher') Element? publisherElement,
/// [contact] Contact details to assist a user in finding and communicating
/// with the publisher.
List<ContactDetail>? contact,
/// [description] A free text natural language description of the {{title}}
/// from a consumer's perspective.
FhirMarkdown? description,
/// [descriptionElement] ("_description") Extensions for description
@JsonKey(name: '_description') Element? descriptionElement,
/// [useContext] The content was developed with a focus and intent of
/// supporting the contexts that are listed. These contexts may be general
/// categories (gender, age, ...) or may be references to specific
/// programs (insurance plans, studies, ...) and may be used to assist
/// with indexing and searching for appropriate {{title}}s.
List<UsageContext>? useContext,
/// [jurisdiction] A legal or geographic region in which the {{title}} is
/// intended to be used.
List<CodeableConcept>? jurisdiction,
/// [purpose] Explanation of why this {{title}} is needed and why it has
/// been designed as it has.
FhirMarkdown? purpose,
/// [purposeElement] ("_purpose") Extensions for purpose
@JsonKey(name: '_purpose') Element? purposeElement,
/// [copyright] A copyright statement relating to the {{title}} and/or its
/// contents. Copyright statements are generally legal restrictions on the
/// use and publishing of the {{title}}.
FhirMarkdown? copyright,
/// [copyrightElement] ("_copyright") Extensions for copyright
@JsonKey(name: '_copyright') Element? copyrightElement,
/// [copyrightLabel] A short string (<50 characters), suitable for
/// inclusion in a page footer that identifies the copyright holder,
/// effective period, and optionally whether rights are resctricted. (e.g.
/// 'All rights reserved', 'Some rights reserved').
String? copyrightLabel,
/// [copyrightLabelElement] ("_copyrightLabel") Extensions for
/// copyrightLabel
@JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement,
/// [approvalDate] The date on which the resource content was approved by
/// the publisher. Approval happens once when the content is officially
/// approved for usage.
FhirDate? approvalDate,
/// [approvalDateElement] ("_approvalDate") Extensions for approvalDate
@JsonKey(name: '_approvalDate') Element? approvalDateElement,
/// [lastReviewDate] The date on which the resource content was last
/// reviewed. Review happens periodically after approval but does not
/// change the original approval date.
FhirDate? lastReviewDate,
/// [lastReviewDateElement] ("_lastReviewDate") Extensions for
/// lastReviewDate
@JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement,
/// [effectivePeriod] The period during which the {{title}} content was or
/// is planned to be in active use.
Period? effectivePeriod,
/// [topic] Descriptive topics related to the content of the {{title}}.
/// Topics provide a high-level categorization as well as keywords for the
/// {{title}} that can be useful for filtering and searching.
List<CodeableConcept>? topic,
/// [author] The creator or owner of the knowledge or information about the
/// medication.
Reference? author,
/// [editor] An individual or organization primarily responsible for
/// internal coherence of the {{title}}.
List<ContactDetail>? editor,
/// [reviewer] An individual or organization asserted by the publisher to
/// be primarily responsible for review of some aspect of the {{title}}.
List<ContactDetail>? reviewer,
/// [endorser] An individual or organization asserted by the publisher to
/// be responsible for officially endorsing the {{title}} for use in some
/// setting.
List<ContactDetail>? endorser,
/// [relatedArtifact] Related artifacts such as additional documentation,
/// justification, dependencies, bibliographic references, and predecessor
/// and successor artifacts.
List<RelatedArtifact>? relatedArtifact,
/// [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,
/// [intendedJurisdiction] Lists the jurisdictions that this medication
/// knowledge was written for.
List<CodeableConcept>? intendedJurisdiction,
/// [relatedMedicationKnowledge] 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<MedicationKnowledgeRelatedMedicationKnowledge>?
relatedMedicationKnowledge,
/// [associatedMedication] Links to associated medications that could be
/// prescribed, dispensed or administered.
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,
/// [preparationInstruction] The instructions for preparing the medication.
FhirMarkdown? preparationInstruction,
/// [preparationInstructionElement] ("_preparationInstruction") Extensions
/// for preparationInstruction
@JsonKey(name: '_preparationInstruction')
Element? preparationInstructionElement,
/// [cost] The price of the medication.
List<MedicationKnowledgeCost>? cost,
/// [monitoringProgram] The program under which the medication is reviewed.
List<MedicationKnowledgeMonitoringProgram>? monitoringProgram,
/// [indicationGuideline] Guidelines or protocols that are applicable for
/// the administration of the medication based on indication.
List<MedicationKnowledgeIndicationGuideline>? indicationGuideline,
/// [medicineClassification] Categorization of the medication within a
/// formulary or classification system.
List<MedicationKnowledgeMedicineClassification>? medicineClassification,
/// [packaging] Information that only applies to packages (not products).
List<MedicationKnowledgePackaging>? packaging,
/// [clinicalUseIssue] Potential clinical issue with or between
/// medication(s) (for example, drug-drug interaction, drug-disease
/// contraindication, drug-allergy interaction, etc.).
List<Reference>? clinicalUseIssue,
/// [storageGuideline] Information on how the medication should be stored,
/// for example, refrigeration temperatures and length of stability at a
/// given temperature.
List<MedicationKnowledgeStorageGuideline>? storageGuideline,
/// [regulatory] Regulatory information about a medication.
List<MedicationKnowledgeRegulatory>? regulatory,
/// [definitional] Along with the link to a Medicinal Product Definition
/// resource, this information provides common definitional elements that
/// are needed to understand the specific medication that is being
/// described.
MedicationKnowledgeDefinitional? definitional,
}) = _MedicationKnowledge;