SubstanceDefinitionName constructor
- @JsonKey(name: 'id') FhirId? fhirId,
- @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - List<
FhirExtension> ? modifierExtension, - String? name,
- @JsonKey(name: '_name') Element? nameElement,
- CodeableConcept? type,
- CodeableConcept? status,
- FhirBoolean? preferred,
- @JsonKey(name: '_preferred') Element? preferredElement,
- List<
CodeableConcept> ? language, - List<
CodeableConcept> ? domain, - List<
CodeableConcept> ? jurisdiction, - List<
SubstanceDefinitionName> ? synonym, - List<
SubstanceDefinitionName> ? translation, - List<
SubstanceDefinitionOfficial> ? official, - List<
Reference> ? source,
SubstanceDefinitionName The detailed description of a substance, typically at a level beyond what is used for prescribing.
id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.;
extension_
May be used to represent additional information that is not part of the basic definition of the element. 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.;
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).;
name
The actual name.;
nameElement
(_name): Extensions for name;
type
Name type, for example 'systematic', 'scientific, 'brand'.;
status
The status of the name, for example 'current', 'proposed'.;
preferred
If this is the preferred name for this substance.;
preferredElement
(_preferred): Extensions for preferred;
language
Human language that the name is written in.;
domain
The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.;
jurisdiction
The jurisdiction where this name applies.;
synonym
A synonym of this particular name, by which the substance is also known.;
translation
A translation for this name into another human language.;
official
Details of the official nature of this name.;
source
Supporting literature.;
Implementation
///
/// [id] Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.;
///
/// [extension_] May be used to represent additional information that is not part of the basic definition of the element. 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.;
///
/// [modifierExtension] May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).;
///
/// [name] The actual name.;
///
/// [nameElement] (_name): Extensions for name;
///
/// [type] Name type, for example 'systematic', 'scientific, 'brand'.;
///
/// [status] The status of the name, for example 'current', 'proposed'.;
///
/// [preferred] If this is the preferred name for this substance.;
///
/// [preferredElement] (_preferred): Extensions for preferred;
///
/// [language] Human language that the name is written in.;
///
/// [domain] The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.;
///
/// [jurisdiction] The jurisdiction where this name applies.;
///
/// [synonym] A synonym of this particular name, by which the substance is also known.;
///
/// [translation] A translation for this name into another human language.;
///
/// [official] Details of the official nature of this name.;
///
/// [source] Supporting literature.;
const factory SubstanceDefinitionName({
/// [id] Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.;
@JsonKey(name: 'id') FhirId? fhirId,
/// [extension_] May be used to represent additional information that is not part of the basic definition of the element. 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.;
@JsonKey(name: 'extension') List<FhirExtension>? extension_,
/// [modifierExtension] May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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,
/// [name] The actual name.;
String? name,
/// [nameElement] (_name): Extensions for name;
@JsonKey(name: '_name') Element? nameElement,
/// [type] Name type, for example 'systematic', 'scientific, 'brand'.;
CodeableConcept? type,
/// [status] The status of the name, for example 'current', 'proposed'.;
CodeableConcept? status,
/// [preferred] If this is the preferred name for this substance.;
FhirBoolean? preferred,
/// [preferredElement] (_preferred): Extensions for preferred;
@JsonKey(name: '_preferred') Element? preferredElement,
/// [language] Human language that the name is written in.;
List<CodeableConcept>? language,
/// [domain] The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.;
List<CodeableConcept>? domain,
/// [jurisdiction] The jurisdiction where this name applies.;
List<CodeableConcept>? jurisdiction,
/// [synonym] A synonym of this particular name, by which the substance is also known.;
List<SubstanceDefinitionName>? synonym,
/// [translation] A translation for this name into another human language.;
List<SubstanceDefinitionName>? translation,
/// [official] Details of the official nature of this name.;
List<SubstanceDefinitionOfficial>? official,
/// [source] Supporting literature.;
List<Reference>? source,
}) = _SubstanceDefinitionName;