ActorDefinition class

ActorDefinition Describes an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.

Mixed in types

• Resource

Annotations

• @freezed

Constructors

ActorDefinition({@Default(R5ResourceType.ActorDefinition) @JsonKey(unknownEnumValue: R5ResourceType.ActorDefinition) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? 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? versionAlgorithmString, @JsonKey(name: '_versionAlgorithmString') Element? versionAlgorithmStringElement, Coding? versionAlgorithmCoding, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, 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, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, String? copyrightLabel, @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement, FhirCode? type, @JsonKey(name: '_type') Element? typeElement, FhirMarkdown? documentation, @JsonKey(name: '_documentation') Element? documentationElement, List<FhirUrl>? reference, @JsonKey(name: '_reference') List<Element>? referenceElement, FhirCanonical? capabilities, List<FhirCanonical>? derivedFrom})

ActorDefinition Describes an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.

const

factory

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

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

factory

ActorDefinition.fromJsonString(String source)

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

factory

ActorDefinition.fromYaml(dynamic yaml)

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

factory

Properties

capabilities → FhirCanonical?

capabilities The capability statement for the actor (if the concept is applicable).

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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

no setter, inherited

copyright → FhirMarkdown?

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

no setter, inherited

copyrightElement → Element?

copyrightElement ("_copyright") Extensions for copyright

no setter, inherited

copyrightLabel → String?

copyrightLabel A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

no setter, inherited

copyrightLabelElement → Element?

copyrightLabelElement ("_copyrightLabel") Extensions for copyrightLabel

no setter, inherited

copyWith → $ActorDefinitionCopyWith<ActorDefinition>

no setter, inherited

date → FhirDateTime?

date The date (and optionally time) when the actor definition was last significantly changed. 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 actor definition changes.

no setter, inherited

dateElement → Element?

dateElement ("_date") Extensions for date

no setter, inherited

dbId → int?

no setter, inherited

derivedFrom → List<FhirCanonical>?

derivedFrom A url that identifies the definition of this actor in another IG (which IG must be listed in the dependencies). This actor inherits all the obligations etc. as defined in the other IG.

no setter, inherited

description → FhirMarkdown?

description A free text natural language description of the actor.

no setter, inherited

descriptionElement → Element?

descriptionElement ("_description") Extensions for description

no setter, inherited

documentation → FhirMarkdown?

documentation Documentation about the functionality of the actor.

no setter, inherited

documentationElement → Element?

documentationElement ("_documentation") Extensions for documentation

no setter, inherited

experimental → FhirBoolean?

experimental A Boolean value to indicate that this actor 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 ("_experimental") Extensions for experimental

no setter, inherited

extension_ → List<FhirExtension>?

extension_ ("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 managable, 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 → FhirId?

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

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 actor 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 ("_implicitRules") Extensions for implicitRules

no setter, inherited

jurisdiction → List<CodeableConcept>?

jurisdiction A legal or geographic region in which the actor 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 ("_language") Extensions for language

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 managable, 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 actor 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 ("_name") 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 responsible for the release and ongoing maintenance of the actor definition.

no setter, inherited

publisherElement → Element?

publisherElement ("_publisher") Extensions for publisher

no setter, inherited

purpose → FhirMarkdown?

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

no setter, inherited

purposeElement → Element?

purposeElement ("_purpose") Extensions for purpose

no setter, inherited

reference → List<FhirUrl>?

reference A reference to additional documentation about the actor, but description and documentation.

no setter, inherited

referenceElement → List<Element>?

referenceElement ("_reference") Extensions for reference

no setter, inherited

resourceType → R5ResourceType

resourceType This is a ActorDefinition resource

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → FhirCode?

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

no setter, inherited

statusElement → Element?

statusElement ("_status") Extensions for status

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 actor definition.

no setter, inherited

titleElement → Element?

titleElement ("_title") Extensions for title

no setter, inherited

type → FhirCode?

type Whether the actor represents a human or an appliction.

no setter, inherited

typeElement → Element?

typeElement ("_type") Extensions for type

no setter, inherited

url → FhirUri?

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

no setter, inherited

urlElement → Element?

urlElement ("_url") Extensions for url

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

no setter, inherited

version → String?

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

no setter, inherited

versionAlgorithmCoding → Coding?

versionAlgorithmCoding Indicates the mechanism used to compare versions to determine which is more current.

no setter, inherited

versionAlgorithmString → String?

versionAlgorithmString Indicates the mechanism used to compare versions to determine which is more current.

no setter, inherited

versionAlgorithmStringElement → Element?

versionAlgorithmStringElement ("_versionAlgorithmString") Extensions for versionAlgorithmString

no setter, inherited

versionElement → Element?

versionElement ("_version") 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

override

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