SubstanceDefinition constructor

const SubstanceDefinition({ @Default(R5ResourceType.SubstanceDefinition) @JsonKey(unknownEnumValue: R5ResourceType.SubstanceDefinition) 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, 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<SubstanceDefinitionCharacterization>? characterization, List<SubstanceDefinitionProperty>? property, Reference? referenceInformation, List<SubstanceDefinitionMolecularWeight>? molecularWeight, SubstanceDefinitionStructure? structure, List<SubstanceDefinitionCode>? code, List<SubstanceDefinitionName>? name, List<SubstanceDefinitionRelationship>? relationship, Reference? nucleicAcid, Reference? polymer, Reference? protein, SubstanceDefinitionSourceMaterial? sourceMaterial, })

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

resourceType This is a SubstanceDefinition 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).

identifier Identifier by which this substance is known.

version A business level version identifier of the substance.

versionElement ("_version") Extensions for version

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

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

domain If the substance applies to human or veterinary use.

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

description Textual description of the substance.

descriptionElement ("_description") Extensions for description

informationSource Supporting literature.

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

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

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

moiety Moiety, for structural modifications.

characterization General specifications for this substance.

property General specifications for this substance.

referenceInformation General information detailing this substance.

molecularWeight The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.

structure Structural information.

code Codes associated with the substance.

name Names applicable to this substance.

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

nucleicAcid Data items specific to nucleic acids.

polymer Data items specific to polymers.

protein Data items specific to proteins.

sourceMaterial Material or taxonomic/anatomical source for the substance.

Implementation

const factory SubstanceDefinition({
  /// [resourceType] This is a SubstanceDefinition resource
  @Default(R5ResourceType.SubstanceDefinition)
  @JsonKey(unknownEnumValue: R5ResourceType.SubstanceDefinition)
  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,

  /// [identifier] Identifier by which this substance is known.
  List<Identifier>? identifier,

  /// [version] A business level version identifier of the substance.
  String? version,

  /// [versionElement] ("_version") Extensions for version
  @JsonKey(name: '_version') Element? versionElement,

  /// [status] Status of substance within the catalogue e.g. active, retired.
  CodeableConcept? status,

  /// [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).
  List<CodeableConcept>? classification,

  /// [domain] If the substance applies to human or veterinary use.
  CodeableConcept? domain,

  /// [grade] The quality standard, established benchmark, to which substance
  ///  complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).
  List<CodeableConcept>? grade,

  /// [description] Textual description of the substance.
  FhirMarkdown? description,

  /// [descriptionElement] ("_description") Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [informationSource] Supporting literature.
  List<Reference>? informationSource,

  /// [note] Textual comment about the substance's catalogue or registry
  ///  record.
  List<Annotation>? note,

  /// [manufacturer] The entity that creates, makes, produces or fabricates
  ///  the substance. This is a set of potential manufacturers but is not
  ///  necessarily comprehensive.
  List<Reference>? manufacturer,

  /// [supplier] An entity that is the source for the substance. It may be
  ///  different from the manufacturer. Supplier is synonymous to a
  ///  distributor.
  List<Reference>? supplier,

  /// [moiety] Moiety, for structural modifications.
  List<SubstanceDefinitionMoiety>? moiety,

  /// [characterization] General specifications for this substance.
  List<SubstanceDefinitionCharacterization>? characterization,

  /// [property] General specifications for this substance.
  List<SubstanceDefinitionProperty>? property,

  /// [referenceInformation] General information detailing this substance.
  Reference? referenceInformation,

  /// [molecularWeight] The average mass of a molecule of a compound compared
  ///  to 1/12 the mass of carbon 12 and calculated as the sum of the atomic
  ///  weights of the constituent atoms.
  List<SubstanceDefinitionMolecularWeight>? molecularWeight,

  /// [structure] Structural information.
  SubstanceDefinitionStructure? structure,

  /// [code] Codes associated with the substance.
  List<SubstanceDefinitionCode>? code,

  /// [name] Names applicable to this substance.
  List<SubstanceDefinitionName>? name,

  /// [relationship] A link between this substance and another, with details
  ///  of the relationship.
  List<SubstanceDefinitionRelationship>? relationship,

  /// [nucleicAcid] Data items specific to nucleic acids.
  Reference? nucleicAcid,

  /// [polymer] Data items specific to polymers.
  Reference? polymer,

  /// [protein] Data items specific to proteins.
  Reference? protein,

  /// [sourceMaterial] Material or taxonomic/anatomical source for the
  ///  substance.
  SubstanceDefinitionSourceMaterial? sourceMaterial,
}) = _SubstanceDefinition;