MedicationKnowledge class

MedicationKnowledge Information about a medication that is used to support knowledge.

Mixed in types
Annotations
  • @freezed

Constructors

MedicationKnowledge({@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, List<RelatedArtifact>? relatedArtifact, CodeableConcept? code, List<CodeableConcept>? intendedJurisdiction, List<MedicationKnowledgeRelatedMedicationKnowledge>? relatedMedicationKnowledge, 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.
const
factory
MedicationKnowledge.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
MedicationKnowledge.fromJsonString(String source)
Acts like a constructor, returns a MedicationKnowledge, accepts a String as an argument, mostly because I got tired of typing it out
factory
MedicationKnowledge.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

approvalDate → FhirDate?
approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
no setterinherited
approvalDateElement → Element?
approvalDateElement ("_approvalDate") Extensions for approvalDate
no setterinherited
associatedMedication → List<Reference>?
associatedMedication Links to associated medications that could be prescribed, dispensed or administered.
no setterinherited
author → Reference?
author The creator or owner of the knowledge or information about the medication.
no setterinherited
clinicalUseIssue → List<Reference>?
clinicalUseIssue Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
no setterinherited
code → CodeableConcept?
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.
no setterinherited
contact → List<ContactDetail>?
contact Contact details to assist a user in finding and communicating with the publisher.
no setterinherited
contained → List<Resource>?
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.
no setterinherited
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}}.
no setterinherited
copyrightElement → Element?
copyrightElement ("_copyright") Extensions for copyright
no setterinherited
copyrightLabel → String?
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').
no setterinherited
copyrightLabelElement → Element?
copyrightLabelElement ("_copyrightLabel") Extensions for copyrightLabel
no setterinherited
copyWith → $MedicationKnowledgeCopyWith<MedicationKnowledge>
no setterinherited
cost → List<MedicationKnowledgeCost>?
cost The price of the medication.
no setterinherited
date → FhirDateTime?
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.
no setterinherited
dateElement → Element?
dateElement ("_date") Extensions for date
no setterinherited
dbId → int?
no setterinherited
definitional → MedicationKnowledgeDefinitional?
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.
no setterinherited
description → FhirMarkdown?
description A free text natural language description of the {{title}} from a consumer's perspective.
no setterinherited
descriptionElement → Element?
descriptionElement ("_description") Extensions for description
no setterinherited
editor → List<ContactDetail>?
editor An individual or organization primarily responsible for internal coherence of the {{title}}.
no setterinherited
effectivePeriod → Period?
effectivePeriod The period during which the {{title}} content was or is planned to be in active use.
no setterinherited
endorser → List<ContactDetail>?
endorser An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting.
no setterinherited
experimental → FhirBoolean?
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.
no setterinherited
experimentalElement → Element?
experimentalElement ("_experimental") Extensions for experimental
no setterinherited
extension_ → List<FhirExtension>?
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.
no setterinherited
fhirId → FhirId?
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
identifier → List<Identifier>?
identifier Business identifier for this medication.
no setterinherited
implicitRules → FhirUri?
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.
no setterinherited
implicitRulesElement → Element?
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
indicationGuideline → List<MedicationKnowledgeIndicationGuideline>?
indicationGuideline Guidelines or protocols that are applicable for the administration of the medication based on indication.
no setterinherited
intendedJurisdiction → List<CodeableConcept>?
intendedJurisdiction Lists the jurisdictions that this medication knowledge was written for.
no setterinherited
jurisdiction → List<CodeableConcept>?
jurisdiction A legal or geographic region in which the {{title}} is intended to be used.
no setterinherited
language → FhirCode?
language The base language in which the resource is written.
no setterinherited
languageElement → Element?
languageElement ("_language") Extensions for language
no setterinherited
lastReviewDate → FhirDate?
lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
no setterinherited
lastReviewDateElement → Element?
lastReviewDateElement ("_lastReviewDate") Extensions for lastReviewDate
no setterinherited
medicineClassification → List<MedicationKnowledgeMedicineClassification>?
medicineClassification Categorization of the medication within a formulary or classification system.
no setterinherited
meta → FhirMeta?
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.
no setterinherited
modifierExtension → List<FhirExtension>?
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).
no setterinherited
monitoringProgram → List<MedicationKnowledgeMonitoringProgram>?
monitoringProgram The program under which the medication is reviewed.
no setterinherited
monograph → List<MedicationKnowledgeMonograph>?
monograph Associated documentation about the medication.
no setterinherited
name → List<String>?
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.
no setterinherited
nameElement → List<Element>?
nameElement ("_name") Extensions for name
no setterinherited
packaging → List<MedicationKnowledgePackaging>?
packaging Information that only applies to packages (not products).
no setterinherited
path → String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
preparationInstruction → FhirMarkdown?
preparationInstruction The instructions for preparing the medication.
no setterinherited
preparationInstructionElement → Element?
preparationInstructionElement ("_preparationInstruction") Extensions for preparationInstruction
no setterinherited
productType → List<CodeableConcept>?
productType Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
no setterinherited
publisher → String?
publisher The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}.
no setterinherited
publisherElement → Element?
publisherElement ("_publisher") Extensions for publisher
no setterinherited
purpose → FhirMarkdown?
purpose Explanation of why this {{title}} is needed and why it has been designed as it has.
no setterinherited
purposeElement → Element?
purposeElement ("_purpose") Extensions for purpose
no setterinherited
regulatory → List<MedicationKnowledgeRegulatory>?
regulatory Regulatory information about a medication.
no setterinherited
relatedArtifact → List<RelatedArtifact>?
relatedArtifact Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.
no setterinherited
relatedMedicationKnowledge → List<MedicationKnowledgeRelatedMedicationKnowledge>?
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.
no setterinherited
resourceType → R5ResourceType
resourceType This is a MedicationKnowledge resource
no setterinherited
resourceTypeString → String?
produce a string of the resourceType
no setterinherited
reviewer → List<ContactDetail>?
reviewer An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → FhirCode?
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.
no setterinherited
statusElement → Element?
statusElement ("_status") Extensions for status
no setterinherited
storageGuideline → List<MedicationKnowledgeStorageGuideline>?
storageGuideline Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.
no setterinherited
text → Narrative?
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.
no setterinherited
thisReference → Reference
Convenience method to return a Reference referring to that Resource
no setterinherited
title → String?
title A short, descriptive, user-friendly title for the {{title}}.
no setterinherited
titleElement → Element?
titleElement ("_title") Extensions for title
no setterinherited
topic → List<CodeableConcept>?
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.
no setterinherited
url → FhirUri?
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.
no setterinherited
urlElement → Element?
urlElement ("_url") Extensions for url
no setterinherited
useContext → List<UsageContext>?
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.
no setterinherited
version → String?
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.)
no setterinherited
versionAlgorithmCoding → Coding?
versionAlgorithmCoding Indicates the mechanism used to compare versions to determine which is more current.
no setterinherited
versionAlgorithmString → String?
versionAlgorithmString Indicates the mechanism used to compare versions to determine which is more current.
no setterinherited
versionAlgorithmStringElement → Element?
versionAlgorithmStringElement ("_versionAlgorithmString") Extensions for versionAlgorithmString
no setterinherited
versionElement → Element?
versionElement ("_version") Extensions for version
no setterinherited

Methods

newId() → Resource
returns the same resource with a new ID (even if there is already an ID present)
inherited
newIdIfNoId() → Resource
returns the same resource with a new ID if there is no current ID
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDbJson() → Map<String, dynamic>
The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids
inherited
toJson() → Map<String, dynamic>
inherited
toJsonString() → String
Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map
override
toString() → String
A string representation of this object.
inherited
toYaml() → String
Produces a Yaml formatted String version of the object
override
updateVersion({FhirMeta? oldMeta}) → Resource
Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited