MedicinalProductDefinition class

MedicinalProductDefinition A medicinal product, being a substance or combination of substances that is intended to treat, prevent or diagnose a disease, or to restore, correct or modify physiological functions by exerting a pharmacological, immunological or metabolic action. This resource is intended to define and detail such products and their properties, for uses other than direct patient care (e.g. regulatory use, or drug catalogs).

Mixed in types

• Resource

Annotations

• @freezed

Constructors

MedicinalProductDefinition({@Default(R4ResourceType.MedicinalProductDefinition) 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, List<Identifier>? identifier, CodeableConcept? type, CodeableConcept? domain, String? version, @JsonKey(name: '_version') Element? versionElement, CodeableConcept? status, FhirDateTime? statusDate, @JsonKey(name: '_statusDate') Element? statusDateElement, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, CodeableConcept? combinedPharmaceuticalDoseForm, List<CodeableConcept>? route, FhirMarkdown? indication, @JsonKey(name: '_indication') Element? indicationElement, CodeableConcept? legalStatusOfSupply, CodeableConcept? additionalMonitoringIndicator, List<CodeableConcept>? specialMeasures, CodeableConcept? pediatricUseIndicator, List<CodeableConcept>? classification, List<MarketingStatus>? marketingStatus, List<CodeableConcept>? packagedMedicinalProduct, List<CodeableConcept>? ingredient, List<CodeableReference>? impurity, List<Reference>? attachedDocument, List<Reference>? masterFile, List<MedicinalProductDefinitionContact>? contact, List<Reference>? clinicalTrial, List<Coding>? code, required List<MedicinalProductDefinitionName> name, List<MedicinalProductDefinitionCrossReference>? crossReference, List<MedicinalProductDefinitionOperation>? operation, List<MedicinalProductDefinitionCharacteristic>? characteristic})

MedicinalProductDefinition A medicinal product, being a substance or combination of substances that is intended to treat, prevent or diagnose a disease, or to restore, correct or modify physiological functions by exerting a pharmacological, immunological or metabolic action. This resource is intended to define and detail such products and their properties, for uses other than direct patient care (e.g. regulatory use, or drug catalogs).

const

factory

MedicinalProductDefinition.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

MedicinalProductDefinition.fromJsonString(String source)

Acts like a constructor, returns a MedicinalProductDefinition, accepts a String as an argument, mostly because I got tired of typing it out

factory

MedicinalProductDefinition.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

additionalMonitoringIndicator → CodeableConcept?

additionalMonitoringIndicator Whether the Medicinal Product is subject to additional monitoring for regulatory reasons, such as heightened reporting requirements.;

no setter, inherited

attachedDocument → List<Reference>?

attachedDocument Additional information or supporting documentation about the medicinal product.;

no setter, inherited

characteristic → List<MedicinalProductDefinitionCharacteristic>?

characteristic Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".;

no setter, inherited

classification → List<CodeableConcept>?

classification Allows the product to be classified by various systems, commonly WHO ATC.;

no setter, inherited

clinicalTrial → List<Reference>?

clinicalTrial Clinical trials or studies that this product is involved in.;

no setter, inherited

code → List<Coding>?

code A code that this product is known by, usually within some formal terminology, perhaps assigned by a third party (i.e. not the manufacturer or regulator). Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations.;

no setter, inherited

combinedPharmaceuticalDoseForm → CodeableConcept?

combinedPharmaceuticalDoseForm The dose form for a single part product, or combined form of a multiple part product. This is one concept that describes all the components. It does not represent the form with components physically mixed, if that might be necessary, for which see (AdministrableProductDefinition.administrableDoseForm).;

no setter, inherited

contact → List<MedicinalProductDefinitionContact>?

contact A product specific contact, person (in a role), or an organization.;

no setter, inherited

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.;

no setter, inherited

copyWith → $MedicinalProductDefinitionCopyWith<MedicinalProductDefinition>

no setter, inherited

crossReference → List<MedicinalProductDefinitionCrossReference>?

crossReference Reference to another product, e.g. for linking authorised to investigational product, or a virtual product.;

no setter, inherited

dbId → int?

no setter, inherited

description → FhirMarkdown?

description General description of this product.;

no setter, inherited

descriptionElement → Element?

descriptionElement (_description): Extensions for description;

no setter, inherited

domain → CodeableConcept?

domain If this medicine applies to human or veterinary uses.;

no setter, inherited

extension_ → List<FhirExtension>?

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.;

no setter, inherited

fhirId → String?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.;

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

identifier Business identifier for this product. Could be an MPID. When in development or being regulated, products are typically referenced by official identifiers, assigned by a manufacturer or regulator, and unique to a product (which, when compared to a product instance being prescribed, is actually a product type). See also MedicinalProductDefinition.code.;

no setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement (_implicitRules): Extensions for implicitRules;

no setter, inherited

impurity → List<CodeableReference>?

impurity Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products.;

no setter, inherited

indication → FhirMarkdown?

indication Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate.;

no setter, inherited

indicationElement → Element?

indicationElement (_indication): Extensions for indication;

no setter, inherited

ingredient → List<CodeableConcept>?

ingredient The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource, or indirectly via incoming AdministrableProductDefinition, PackagedProductDefinition or ManufacturedItemDefinition references. In cases where those levels of detail are not used, the ingredients may be specified directly here as codes.;

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.;

no setter, inherited

languageElement → Element?

languageElement (_language): Extensions for language;

no setter, inherited

legalStatusOfSupply → CodeableConcept?

legalStatusOfSupply The legal status of supply of the medicinal product as classified by the regulator.;

no setter, inherited

marketingStatus → List<MarketingStatus>?

marketingStatus Marketing status of the medicinal product, in contrast to marketing authorization. This refers to the product being actually 'on the market' as opposed to being allowed to be on the market (which is an authorization).;

no setter, inherited

masterFile → List<Reference>?

masterFile A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products.;

no setter, inherited

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 setter, inherited

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 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).;

no setter, inherited

name → List<MedicinalProductDefinitionName>

name The product's name, including full name and possibly coded parts.;

no setter, inherited

operation → List<MedicinalProductDefinitionOperation>?

operation A manufacturing or administrative process or step associated with (or performed on) the medicinal product.;

no setter, inherited

packagedMedicinalProduct → List<CodeableConcept>?

packagedMedicinalProduct Package type for the product. See also the PackagedProductDefinition resource.;

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

pediatricUseIndicator → CodeableConcept?

pediatricUseIndicator If authorised for use in children, or infants, neonates etc.;

no setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

route → List<CodeableConcept>?

route The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. See also AdministrableProductDefinition resource. MedicinalProductDefinition.route is the same concept as AdministrableProductDefinition.routeOfAdministration.code, and they cannot be used together.;

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

specialMeasures → List<CodeableConcept>?

specialMeasures Whether the Medicinal Product is subject to special measures for regulatory reasons, such as a requirement to conduct post-authorisation studies.;

no setter, inherited

status → CodeableConcept?

status The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status.;

no setter, inherited

statusDate → FhirDateTime?

statusDate The date at which the given status became applicable.;

no setter, inherited

statusDateElement → Element?

statusDateElement (_statusDate): Extensions for statusDate;

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

type → CodeableConcept?

type Regulatory type, e.g. Investigational or Authorized.;

no setter, inherited

version → String?

version A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.;

no setter, inherited

versionElement → Element?

versionElement (_version): Extensions for version;

no setter, inherited

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

inherited

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