SubstanceDefinition class

SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing.

Mixed in types

• Resource

Annotations

• @freezed

Constructors

SubstanceDefinition({@Default(R4ResourceType.SubstanceDefinition) 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, String? version, @JsonKey(name: '_version') Element? versionElement, CodeableConcept? status, List<CodeableConcept>? classification, CodeableConcept? domain, List<CodeableConcept>? grade, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<Reference>? informationSource, List<Annotation>? note, List<Reference>? manufacturer, List<Reference>? supplier, List<SubstanceDefinitionMoiety>? moiety, List<SubstanceDefinitionProperty>? property, List<SubstanceDefinitionMolecularWeight>? molecularWeight, SubstanceDefinitionStructure? structure, List<SubstanceDefinitionCode>? code, List<SubstanceDefinitionName>? name, List<SubstanceDefinitionRelationship>? relationship, SubstanceDefinitionSourceMaterial? sourceMaterial})

SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing.

const

factory

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

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

factory

SubstanceDefinition.fromJsonString(String source)

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

factory

SubstanceDefinition.fromYaml(dynamic yaml)

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

factory

Properties

classification → List<CodeableConcept>?

classification A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).;

no setter, inherited

code → List<SubstanceDefinitionCode>?

code Codes associated with the substance.;

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 → $SubstanceDefinitionCopyWith<SubstanceDefinition>

no setter, inherited

dbId → int?

no setter, inherited

description → FhirMarkdown?

description Textual description of the substance.;

no setter, inherited

descriptionElement → Element?

descriptionElement (_description): Extensions for description;

no setter, inherited

domain → CodeableConcept?

domain If the substance applies to human or veterinary use.;

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

grade → List<CodeableConcept>?

grade The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).;

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

identifier Identifier by which this substance is known.;

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

informationSource → List<Reference>?

informationSource Supporting literature.;

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

manufacturer → List<Reference>?

manufacturer The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.;

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

moiety → List<SubstanceDefinitionMoiety>?

moiety Moiety, for structural modifications.;

no setter, inherited

molecularWeight → List<SubstanceDefinitionMolecularWeight>?

molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids).;

no setter, inherited

name → List<SubstanceDefinitionName>?

name Names applicable to this substance.;

no setter, inherited

note → List<Annotation>?

note Textual comment about the substance's catalogue or registry record.;

no setter, inherited

path → String

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

no setter, inherited

property → List<SubstanceDefinitionProperty>?

property General specifications for this substance.;

no setter, inherited

relationship → List<SubstanceDefinitionRelationship>?

relationship A link between this substance and another, with details of the relationship.;

no setter, inherited

resourceType → R4ResourceType

resourceType This is a SubstanceDefinition resource;

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sourceMaterial → SubstanceDefinitionSourceMaterial?

sourceMaterial Material or taxonomic/anatomical source for the substance.;

no setter, inherited

status → CodeableConcept?

status Status of substance within the catalogue e.g. active, retired.;

no setter, inherited

structure → SubstanceDefinitionStructure?

structure Structural information.;

no setter, inherited

supplier → List<Reference>?

supplier An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.;

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

version → String?

version A business level version identifier of the substance.;

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