PlanDefinition class

PlanDefinition This resource allows for the definition of various types

Mixed in types

• Resource

Annotations

• @freezed

Constructors

PlanDefinition({@Default(R4ResourceType.PlanDefinition) @JsonKey(unknownEnumValue: R4ResourceType.PlanDefinition) 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, CodeableConcept? type, 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_, List<PlanDefinitionGoal>? goal, List<PlanDefinitionAction>? action})

PlanDefinition This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

const

factory

PlanDefinition.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

PlanDefinition.fromJsonString(String source)

Acts like a constructor, returns a PlanDefinition, accepts a String as an argument, mostly because I got tired of typing it out

factory

PlanDefinition.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

action → List<PlanDefinitionAction>?

action An action or group of actions to be taken as part of the plan.

no setter, inherited

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 setter, inherited

approvalDateElement → Element?

approvalDateElement Extensions for approvalDate

no setter, inherited

author → List<ContactDetail>?

author An individiual or organization primarily involved in the creation and maintenance of the content.

no setter, inherited

contact → List<ContactDetail>?

contact Contact details to assist a user in finding and communicating with the publisher.

no setter, inherited

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 setter, inherited

copyright → FhirMarkdown?

copyright A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

no setter, inherited

copyrightElement → Element?

copyrightElement Extensions for copyright

no setter, inherited

copyWith → $PlanDefinitionCopyWith<PlanDefinition>

no setter, inherited

date → FhirDateTime?

date The date (and optionally time) when the plan 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 plan definition changes.

no setter, inherited

dateElement → Element?

dateElement Extensions for date

no setter, inherited

dbId → int?

no setter, inherited

description → FhirMarkdown?

description A free text natural language description of the plan definition from a consumer's perspective.

no setter, inherited

descriptionElement → Element?

descriptionElement Extensions for description

no setter, inherited

editor → List<ContactDetail>?

editor An individual or organization primarily responsible for internal coherence of the content.

no setter, inherited

effectivePeriod → Period?

effectivePeriod The period during which the plan definition content was or is planned to be in active use.

no setter, inherited

endorser → List<ContactDetail>?

endorser An individual or organization responsible for officially endorsing the content for use in some setting.

no setter, inherited

experimental → FhirBoolean?

experimental A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

no setter, inherited

experimentalElement → Element?

experimentalElement Extensions for experimental

no setter, inherited

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 setter, inherited

fhirId → String?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

goal → List<PlanDefinitionGoal>?

goal Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

identifier A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

no setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement Extensions for implicitRules

no setter, inherited

jurisdiction → List<CodeableConcept>?

jurisdiction A legal or geographic region in which the plan definition is intended to be used.

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

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 setter, inherited

lastReviewDateElement → Element?

lastReviewDateElement Extensions for lastReviewDate

no setter, inherited

library_ → List<FhirCanonical>?

library A reference to a Library resource containing any formal logic used by the plan definition.

no setter, inherited

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 setter, inherited

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 setter, inherited

name → String?

name A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

no setter, inherited

nameElement → Element?

nameElement Extensions for name

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

publisher → String?

publisher The name of the organization or individual that published the plan definition.

no setter, inherited

publisherElement → Element?

publisherElement Extensions for publisher

no setter, inherited

purpose → FhirMarkdown?

purpose Explanation of why this plan definition is needed and why it has been designed as it has.

no setter, inherited

purposeElement → Element?

purposeElement Extensions for purpose

no setter, inherited

relatedArtifact → List<RelatedArtifact>?

relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references.

no setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

reviewer → List<ContactDetail>?

reviewer An individual or organization primarily responsible for review of some aspect of the content.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → FhirCode?

status The status of this plan definition. Enables tracking the life-cycle of the content.

no setter, inherited

statusElement → Element?

statusElement Extensions for status

no setter, inherited

subjectCanonical → FhirCanonical?

no setter, inherited

subjectCanonicalElement → Element?

no setter, inherited

subjectCodeableConcept → CodeableConcept?

subjectCodeableConcept A code or group definition that describes the intended subject of the plan definition.

no setter, inherited

subjectReference → Reference?

subjectReference A code or group definition that describes the intended subject of the plan definition.

no setter, inherited

subtitle → String?

subtitle An explanatory or alternate title for the plan definition giving additional information about its content.

no setter, inherited

subtitleElement → Element?

subtitleElement Extensions for subtitle

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

title → String?

title A short, descriptive, user-friendly title for the plan definition.

no setter, inherited

titleElement → Element?

titleElement Extensions for title

no setter, inherited

topic → List<CodeableConcept>?

topic Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

no setter, inherited

type → CodeableConcept?

type A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

no setter, inherited

url → FhirUri?

url An absolute URI that is used to identify this plan 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 plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

no setter, inherited

urlElement → Element?

urlElement Extensions for url

no setter, inherited

usage → String?

usage A detailed description of how the plan definition is used from a clinical perspective.

no setter, inherited

usageElement → Element?

usageElement Extensions for usage

no setter, inherited

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 plan definition instances.

no setter, inherited

version → String?

version The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan 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 artifacts.

no setter, inherited

versionElement → Element?

versionElement Extensions for version

no setter, inherited

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