ClinicalUseDefinition constructor

const ClinicalUseDefinition({ @Default(R4ResourceType.ClinicalUseDefinition) 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, FhirCode? type, @JsonKey(name: '_type') Element? typeElement, List<CodeableConcept>? category, List<Reference>? subject, CodeableConcept? status, ClinicalUseDefinitionContraindication? contraindication, ClinicalUseDefinitionIndication? indication, ClinicalUseDefinitionInteraction? interaction, List<Reference>? population, ClinicalUseDefinitionUndesirableEffect? undesirableEffect, ClinicalUseDefinitionWarning? warning, })

ClinicalUseDefinition A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.

resourceType This is a ClinicalUseDefinition 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.;

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

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

identifier Business identifier for this issue.;

type indication | contraindication | interaction | undesirable-effect | warning.;

typeElement (_type): Extensions for type;

category A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines".;

subject The medication or procedure for which this is an indication.;

status Whether this is a current issue or one that has been retired etc.;

contraindication Specifics for when this is a contraindication.;

indication Specifics for when this is an indication.;

interaction Specifics for when this is an interaction.;

population The population group to which this applies.;

undesirableEffect Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.;

warning A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.;

Implementation

///
/// [resourceType] This is a ClinicalUseDefinition 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.;
///
/// [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.;
///
/// [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).;
///
/// [identifier] Business identifier for this issue.;
///
/// [type] indication | contraindication | interaction | undesirable-effect | warning.;
///
/// [typeElement] (_type): Extensions for type;
///
/// [category] A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines".;
///
/// [subject] The medication or procedure for which this is an indication.;
///
/// [status] Whether this is a current issue or one that has been retired etc.;
///
/// [contraindication] Specifics for when this is a contraindication.;
///
/// [indication] Specifics for when this is an indication.;
///
/// [interaction] Specifics for when this is an interaction.;
///
/// [population] The population group to which this applies.;
///
/// [undesirableEffect] Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.;
///
/// [warning] A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.;
const factory ClinicalUseDefinition({
  /// [resourceType] This is a ClinicalUseDefinition resource;
  @Default(R4ResourceType.ClinicalUseDefinition) R4ResourceType 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') String? 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.;
  List<Resource>? contained,

  /// [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.;
  @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 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).;
  List<FhirExtension>? modifierExtension,

  /// [identifier] Business identifier for this issue.;
  List<Identifier>? identifier,

  /// [type] indication | contraindication | interaction | undesirable-effect | warning.;
  FhirCode? type,

  /// [typeElement] (_type): Extensions for type;
  @JsonKey(name: '_type') Element? typeElement,

  /// [category] A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines".;
  List<CodeableConcept>? category,

  /// [subject] The medication or procedure for which this is an indication.;
  List<Reference>? subject,

  /// [status] Whether this is a current issue or one that has been retired etc.;
  CodeableConcept? status,

  /// [contraindication] Specifics for when this is a contraindication.;
  ClinicalUseDefinitionContraindication? contraindication,

  /// [indication] Specifics for when this is an indication.;
  ClinicalUseDefinitionIndication? indication,

  /// [interaction] Specifics for when this is an interaction.;
  ClinicalUseDefinitionInteraction? interaction,

  /// [population] The population group to which this applies.;
  List<Reference>? population,

  /// [undesirableEffect] Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.;
  ClinicalUseDefinitionUndesirableEffect? undesirableEffect,

  /// [warning] A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.;
  ClinicalUseDefinitionWarning? warning,
}) = _ClinicalUseDefinition;