ActivityDefinition class

ActivityDefinition This resource allows for the definition of some

Mixed in types
Annotations
  • @freezed

Constructors

ActivityDefinition({@Default(R4ResourceType.ActivityDefinition) @JsonKey(unknownEnumValue: R4ResourceType.ActivityDefinition) 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, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, List<Identifier>? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, String? subtitle, @JsonKey(name: '_subtitle') Element? subtitleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, CodeableConcept? subjectCodeableConcept, Reference? subjectReference, FhirCanonical? subjectCanonical, @JsonKey(name: '_subjectCanonical') Element? subjectCanonicalElement, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, String? publisher, @JsonKey(name: '_publisher') Element? publisherElement, List<ContactDetail>? contact, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<UsageContext>? useContext, List<CodeableConcept>? jurisdiction, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, String? usage, @JsonKey(name: '_usage') Element? usageElement, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, FhirDate? approvalDate, @JsonKey(name: '_approvalDate') Element? approvalDateElement, FhirDate? lastReviewDate, @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement, Period? effectivePeriod, List<CodeableConcept>? topic, List<ContactDetail>? author, List<ContactDetail>? editor, List<ContactDetail>? reviewer, List<ContactDetail>? endorser, List<RelatedArtifact>? relatedArtifact, @JsonKey(name: 'library') List<FhirCanonical>? library_, FhirCode? kind, @JsonKey(name: '_kind') Element? kindElement, FhirCanonical? profile, CodeableConcept? code, FhirCode? intent, @JsonKey(name: '_intent') Element? intentElement, FhirCode? priority, @JsonKey(name: '_priority') Element? priorityElement, FhirBoolean? doNotPerform, @JsonKey(name: '_doNotPerform') Element? doNotPerformElement, Timing? timingTiming, FhirDateTime? timingDateTime, @JsonKey(name: '_timingDateTime') Element? timingDateTimeElement, Age? timingAge, Period? timingPeriod, Range? timingRange, FhirDuration? timingDuration, Reference? location, List<ActivityDefinitionParticipant>? participant, Reference? productReference, CodeableConcept? productCodeableConcept, Quantity? quantity, List<Dosage>? dosage, List<CodeableConcept>? bodySite, List<Reference>? specimenRequirement, List<Reference>? observationRequirement, List<Reference>? observationResultRequirement, FhirCanonical? transform, List<ActivityDefinitionDynamicValue>? dynamicValue})
ActivityDefinition This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
const
factory
ActivityDefinition.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
ActivityDefinition.fromJsonString(String source)
Acts like a constructor, returns a ActivityDefinition, accepts a String as an argument, mostly because I got tired of typing it out
factory
ActivityDefinition.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

approvalDate → FhirDate?
approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
no setterinherited
approvalDateElement → Element?
approvalDateElement Extensions for approvalDate
no setterinherited
author → List<ContactDetail>?
author An individiual or organization primarily involved in the creation and maintenance of the content.
no setterinherited
bodySite → List<CodeableConcept>?
bodySite Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
no setterinherited
code → CodeableConcept?
code Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
no setterinherited
contact → List<ContactDetail>?
contact Contact details to assist a user in finding and communicating with the publisher.
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, and nor can they have their own independent transaction scope.
no setterinherited
copyright A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
no setterinherited
copyrightElement → Element?
copyrightElement Extensions for copyright
no setterinherited
copyWith → $ActivityDefinitionCopyWith<ActivityDefinition>
no setterinherited
date → FhirDateTime?
date The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
no setterinherited
dateElement → Element?
dateElement Extensions for date
no setterinherited
dbId → int?
no setterinherited
description → FhirMarkdown?
description A free text natural language description of the activity definition from a consumer's perspective.
no setterinherited
descriptionElement → Element?
descriptionElement Extensions for description
no setterinherited
doNotPerform → FhirBoolean?
doNotPerform Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
no setterinherited
doNotPerformElement → Element?
doNotPerformElement Extensions for doNotPerform
no setterinherited
dosage → List<Dosage>?
dosage Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
no setterinherited
dynamicValue → List<ActivityDefinitionDynamicValue>?
dynamicValue Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
no setterinherited
editor → List<ContactDetail>?
editor An individual or organization primarily responsible for internal coherence of the content.
no setterinherited
effectivePeriod → Period?
effectivePeriod The period during which the activity definition content was or is planned to be in active use.
no setterinherited
endorser → List<ContactDetail>?
endorser An individual or organization responsible for officially endorsing the content for use in some setting.
no setterinherited
experimental → FhirBoolean?
experimental A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
no setterinherited
experimentalElement → Element?
experimentalElement Extensions for experimental
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 A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
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 Extensions for implicitRules
no setterinherited
intent → FhirCode?
intent Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
no setterinherited
intentElement → Element?
intentElement Extensions for intent
no setterinherited
jurisdiction → List<CodeableConcept>?
jurisdiction A legal or geographic region in which the activity definition is intended to be used.
no setterinherited
kind → FhirCode?
kind A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
no setterinherited
kindElement → Element?
kindElement Extensions for kind
no setterinherited
language → FhirCode?
language The base language in which the resource is written.
no setterinherited
languageElement → Element?
languageElement Extensions for language
no setterinherited
lastReviewDate → FhirDate?
lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
no setterinherited
lastReviewDateElement → Element?
lastReviewDateElement Extensions for lastReviewDate
no setterinherited
library_ → List<FhirCanonical>?
library A reference to a Library resource containing any formal logic used by the activity definition.
no setterinherited
location → Reference?
location Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
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
name → String?
name A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
no setterinherited
nameElement → Element?
nameElement Extensions for name
no setterinherited
observationRequirement → List<Reference>?
observationRequirement Defines observation requirements for the action to be performed, such as body weight or surface area.
no setterinherited
observationResultRequirement → List<Reference>?
observationResultRequirement Defines the observations that are expected to be produced by the action.
no setterinherited
participant → List<ActivityDefinitionParticipant>?
participant Indicates who should participate in performing the action described.
no setterinherited
path → String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
priority → FhirCode?
priority Indicates how quickly the activity should be addressed with respect to other requests.
no setterinherited
priorityElement → Element?
priorityElement Extensions for priority
no setterinherited
productCodeableConcept → CodeableConcept?
productCodeableConcept Identifies the food, drug or other product being consumed or supplied in the activity.
no setterinherited
productReference → Reference?
productReference Identifies the food, drug or other product being consumed or supplied in the activity.
no setterinherited
profile → FhirCanonical?
profile A profile to which the target of the activity definition is expected to conform.
no setterinherited
publisher → String?
publisher The name of the organization or individual that published the activity definition.
no setterinherited
publisherElement → Element?
publisherElement Extensions for publisher
no setterinherited
purpose → FhirMarkdown?
purpose Explanation of why this activity definition is needed and why it has been designed as it has.
no setterinherited
purposeElement → Element?
purposeElement Extensions for purpose
no setterinherited
quantity → Quantity?
quantity Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
no setterinherited
relatedArtifact → List<RelatedArtifact>?
relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references.
no setterinherited
resourceType → R4ResourceType
no setterinherited
resourceTypeString → String?
produce a string of the resourceType
no setterinherited
reviewer → List<ContactDetail>?
reviewer An individual or organization primarily responsible for review of some aspect of the content.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
specimenRequirement → List<Reference>?
specimenRequirement Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
no setterinherited
status → FhirCode?
status The status of this activity definition. Enables tracking the life-cycle of the content.
no setterinherited
statusElement → Element?
statusElement Extensions for status
no setterinherited
subjectCanonical → FhirCanonical?
no setterinherited
subjectCanonicalElement → Element?
no setterinherited
subjectCodeableConcept → CodeableConcept?
subjectCodeableConcept A code or group definition that describes the intended subject of the activity being defined.
no setterinherited
subjectReference → Reference?
subjectReference A code or group definition that describes the intended subject of the activity being defined.
no setterinherited
subtitle → String?
subtitle An explanatory or alternate title for the activity definition giving additional information about its content.
no setterinherited
subtitleElement → Element?
subtitleElement Extensions for subtitle
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
timingAge → Age?
timingAge The period, timing or frequency upon which the described activity is to occur.
no setterinherited
timingDateTime → FhirDateTime?
timingDateTime The period, timing or frequency upon which the described activity is to occur.
no setterinherited
timingDateTimeElement → Element?
timingDateTimeElement Extensions for timingDateTime
no setterinherited
timingDuration → FhirDuration?
timingDuration The period, timing or frequency upon which the described activity is to occur.
no setterinherited
timingPeriod → Period?
timingPeriod The period, timing or frequency upon which the described activity is to occur.
no setterinherited
timingRange → Range?
timingRange The period, timing or frequency upon which the described activity is to occur.
no setterinherited
timingTiming → Timing?
timingTiming The period, timing or frequency upon which the described activity is to occur.
no setterinherited
title → String?
title A short, descriptive, user-friendly title for the activity definition.
no setterinherited
titleElement → Element?
titleElement Extensions for title
no setterinherited
topic → List<CodeableConcept>?
topic Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
no setterinherited
transform → FhirCanonical?
transform A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
no setterinherited
url → FhirUri?
url An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
no setterinherited
urlElement → Element?
urlElement Extensions for url
no setterinherited
usage → String?
usage A detailed description of how the activity definition is used from a clinical perspective.
no setterinherited
usageElement → Element?
usageElement Extensions for usage
no setterinherited
useContext → List<UsageContext>?
useContext The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.
no setterinherited
version → String?
version The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
no setterinherited
versionElement → Element?
versionElement Extensions for version
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