ClinicalUseDefinition class

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

Mixed in types
Annotations
  • @freezed

Constructors

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.
const
factory
ClinicalUseDefinition.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
ClinicalUseDefinition.fromJsonString(String source)
Acts like a constructor, returns a ClinicalUseDefinition, accepts a String as an argument, mostly because I got tired of typing it out
factory
ClinicalUseDefinition.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

category List<CodeableConcept>?
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".;
no setterinherited
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 setterinherited
contraindication ClinicalUseDefinitionContraindication?
contraindication Specifics for when this is a contraindication.;
no setterinherited
copyWith → $ClinicalUseDefinitionCopyWith<ClinicalUseDefinition>
no setterinherited
dbId int?
no setterinherited
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 setterinherited
fhirId String?
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.;
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
identifier List<Identifier>?
identifier Business identifier for this issue.;
no setterinherited
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 setterinherited
implicitRulesElement Element?
implicitRulesElement (_implicitRules): Extensions for implicitRules;
no setterinherited
indication ClinicalUseDefinitionIndication?
indication Specifics for when this is an indication.;
no setterinherited
interaction ClinicalUseDefinitionInteraction?
interaction Specifics for when this is an interaction.;
no setterinherited
language FhirCode?
language The base language in which the resource is written.;
no setterinherited
languageElement Element?
languageElement (_language): Extensions for language;
no setterinherited
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 setterinherited
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 setterinherited
path String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
population List<Reference>?
population The population group to which this applies.;
no setterinherited
resourceType R4ResourceType
resourceType This is a ClinicalUseDefinition resource;
no setterinherited
resourceTypeString String?
produce a string of the resourceType
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
status CodeableConcept?
status Whether this is a current issue or one that has been retired etc.;
no setterinherited
subject List<Reference>?
subject The medication or procedure for which this is an indication.;
no setterinherited
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 setterinherited
thisReference Reference
Convenience method to return a Reference referring to that Resource
no setterinherited
type FhirCode?
type indication | contraindication | interaction | undesirable-effect | warning.;
no setterinherited
typeElement Element?
typeElement (_type): Extensions for type;
no setterinherited
undesirableEffect ClinicalUseDefinitionUndesirableEffect?
undesirableEffect Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.;
no setterinherited
warning ClinicalUseDefinitionWarning?
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'.;
no setterinherited

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