EventDefinition constructor
- @Default(R5ResourceType.EventDefinition) @JsonKey(unknownEnumValue: R5ResourceType.EventDefinition) 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,
- 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, - String? subtitle,
- @JsonKey(name: '_subtitle') Element? subtitleElement,
- CodeableConcept? subjectCodeableConcept,
- Reference? subjectReference,
- FhirMarkdown? usage,
- @JsonKey(name: '_usage') Element? usageElement,
- required List<
TriggerDefinition> trigger,
EventDefinition The EventDefinition resource provides a reusable description of when a particular event can occur.
resourceType
This is a EventDefinition 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. This is allowed to be a Parameters resource if and only if it is
referenced by a resource that provides context/meaning.
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.
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).
url
An absolute URI that is used to identify this event 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
event definition is (or will be) published. This URL can be the target
of a canonical reference. It SHALL remain the same when the event
definition is stored on different servers.
urlElement
("_url") Extensions for url
identifier
A formal identifier that is used to identify this event
definition when it is represented in other formats, or referenced in a
specification, model, design or an instance.
version
The identifier that is used to identify this version of the
event definition when it is referenced in a specification, model, design
or instance. This is an arbitrary value managed by the event 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.
versionElement
("_version") Extensions for version
versionAlgorithmString
Indicates the mechanism used to compare versions
to determine which is more current.
versionAlgorithmStringElement
("_versionAlgorithmString") Extensions
for versionAlgorithmString
versionAlgorithmCoding
Indicates the mechanism used to compare versions
to determine which is more current.
name
A natural language name identifying the event definition. This
name should be usable as an identifier for the module by machine
processing applications such as code generation.
nameElement
("_name") Extensions for name
title
A short, descriptive, user-friendly title for the event
definition.
titleElement
("_title") Extensions for title
status
The status of this event definition. Enables tracking the
life-cycle of the content.
statusElement
("_status") Extensions for status
experimental
A Boolean value to indicate that this event definition is
authored for testing purposes (or education/evaluation/marketing) and is
not intended to be used for genuine usage.
experimentalElement
("_experimental") Extensions for experimental
date
The date (and optionally time) when the event 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 event definition
changes.
dateElement
("_date") Extensions for date
publisher
The name of the organization or individual responsible for
the release and ongoing maintenance of the event definition.
publisherElement
("_publisher") Extensions for publisher
contact
Contact details to assist a user in finding and communicating
with the publisher.
description
A free text natural language description of the event
definition from a consumer's perspective.
descriptionElement
("_description") Extensions for description
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 event definition instances.
jurisdiction
A legal or geographic region in which the event definition
is intended to be used.
purpose
Explanation of why this event definition is needed and why it
has been designed as it has.
purposeElement
("_purpose") Extensions for purpose
copyright
A copyright statement relating to the event definition and/or
its contents. Copyright statements are generally legal restrictions on
the use and publishing of the event definition.
copyrightElement
("_copyright") Extensions for copyright
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').
copyrightLabelElement
("_copyrightLabel") Extensions for copyrightLabel
approvalDate
The date on which the resource content was approved by the
publisher. Approval happens once when the content is officially approved
for usage.
approvalDateElement
("_approvalDate") Extensions for approvalDate
lastReviewDate
The date on which the resource content was last
reviewed. Review happens periodically after approval but does not change
the original approval date.
lastReviewDateElement
("_lastReviewDate") Extensions for lastReviewDate
effectivePeriod
The period during which the event definition content
was or is planned to be in active use.
topic
Descriptive topics related to the module. Topics provide a
high-level categorization of the module that can be useful for filtering
and searching.
author
An individiual or organization primarily involved in the
creation and maintenance of the content.
editor
An individual or organization primarily responsible for internal
coherence of the content.
reviewer
An individual or organization asserted by the publisher to be
primarily responsible for review of some aspect of the content.
endorser
An individual or organization asserted by the publisher to be
responsible for officially endorsing the content for use in some setting.
relatedArtifact
Related resources such as additional documentation,
justification, or bibliographic references.
subtitle
An explanatory or alternate title for the event definition
giving additional information about its content.
subtitleElement
("_subtitle") Extensions for subtitle
subjectCodeableConcept
A code or group definition that describes the
intended subject of the event definition.
subjectReference
A code or group definition that describes the intended
subject of the event definition.
usage
A detailed description of how the event definition is used from a
clinical perspective.
usageElement
("_usage") Extensions for usage
trigger
The trigger element defines when the event occurs. If more than
one trigger condition is specified, the event fires whenever any one of
the trigger conditions is met.
Implementation
const factory EventDefinition({
/// [resourceType] This is a EventDefinition resource
@Default(R5ResourceType.EventDefinition)
@JsonKey(unknownEnumValue: R5ResourceType.EventDefinition)
R5ResourceType 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') FhirId? 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. This is allowed to be a Parameters resource if and only if it
/// is referenced by a resource that provides context/meaning.
List<Resource>? contained,
/// [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.
@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 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).
List<FhirExtension>? modifierExtension,
/// [url] An absolute URI that is used to identify this event 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 event definition is (or will be)
/// published. This URL can be the target of a canonical reference. It
/// SHALL remain the same when the event definition is stored on different
/// servers.
FhirUri? url,
/// [urlElement] ("_url") Extensions for url
@JsonKey(name: '_url') Element? urlElement,
/// [identifier] A formal identifier that is used to identify this event
/// definition when it is represented in other formats, or referenced in a
/// specification, model, design or an instance.
List<Identifier>? identifier,
/// [version] The identifier that is used to identify this version of the
/// event definition when it is referenced in a specification, model,
/// design or instance. This is an arbitrary value managed by the event
/// 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.
String? version,
/// [versionElement] ("_version") Extensions for version
@JsonKey(name: '_version') Element? versionElement,
/// [versionAlgorithmString] Indicates the mechanism used to compare
/// versions to determine which is more current.
String? versionAlgorithmString,
/// [versionAlgorithmStringElement] ("_versionAlgorithmString") Extensions
/// for versionAlgorithmString
@JsonKey(name: '_versionAlgorithmString')
Element? versionAlgorithmStringElement,
/// [versionAlgorithmCoding] Indicates the mechanism used to compare
/// versions to determine which is more current.
Coding? versionAlgorithmCoding,
/// [name] A natural language name identifying the event definition. This
/// name should be usable as an identifier for the module by machine
/// processing applications such as code generation.
String? name,
/// [nameElement] ("_name") Extensions for name
@JsonKey(name: '_name') Element? nameElement,
/// [title] A short, descriptive, user-friendly title for the event
/// definition.
String? title,
/// [titleElement] ("_title") Extensions for title
@JsonKey(name: '_title') Element? titleElement,
/// [status] The status of this event definition. Enables tracking the
/// life-cycle of the content.
FhirCode? status,
/// [statusElement] ("_status") Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [experimental] A Boolean value to indicate that this event definition
/// is authored for testing purposes (or education/evaluation/marketing)
/// and is not intended to be used for genuine usage.
FhirBoolean? experimental,
/// [experimentalElement] ("_experimental") Extensions for experimental
@JsonKey(name: '_experimental') Element? experimentalElement,
/// [date] The date (and optionally time) when the event 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 event
/// definition changes.
FhirDateTime? date,
/// [dateElement] ("_date") Extensions for date
@JsonKey(name: '_date') Element? dateElement,
/// [publisher] The name of the organization or individual responsible for
/// the release and ongoing maintenance of the event definition.
String? publisher,
/// [publisherElement] ("_publisher") Extensions for publisher
@JsonKey(name: '_publisher') Element? publisherElement,
/// [contact] Contact details to assist a user in finding and communicating
/// with the publisher.
List<ContactDetail>? contact,
/// [description] A free text natural language description of the event
/// definition from a consumer's perspective.
FhirMarkdown? description,
/// [descriptionElement] ("_description") Extensions for description
@JsonKey(name: '_description') Element? descriptionElement,
/// [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 event definition instances.
List<UsageContext>? useContext,
/// [jurisdiction] A legal or geographic region in which the event
/// definition is intended to be used.
List<CodeableConcept>? jurisdiction,
/// [purpose] Explanation of why this event definition is needed and why it
/// has been designed as it has.
FhirMarkdown? purpose,
/// [purposeElement] ("_purpose") Extensions for purpose
@JsonKey(name: '_purpose') Element? purposeElement,
/// [copyright] A copyright statement relating to the event definition
/// and/or its contents. Copyright statements are generally legal
/// restrictions on the use and publishing of the event definition.
FhirMarkdown? copyright,
/// [copyrightElement] ("_copyright") Extensions for copyright
@JsonKey(name: '_copyright') Element? copyrightElement,
/// [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').
String? copyrightLabel,
/// [copyrightLabelElement] ("_copyrightLabel") Extensions for
/// copyrightLabel
@JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement,
/// [approvalDate] The date on which the resource content was approved by
/// the publisher. Approval happens once when the content is officially
/// approved for usage.
FhirDate? approvalDate,
/// [approvalDateElement] ("_approvalDate") Extensions for approvalDate
@JsonKey(name: '_approvalDate') Element? approvalDateElement,
/// [lastReviewDate] The date on which the resource content was last
/// reviewed. Review happens periodically after approval but does not
/// change the original approval date.
FhirDate? lastReviewDate,
/// [lastReviewDateElement] ("_lastReviewDate") Extensions for
/// lastReviewDate
@JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement,
/// [effectivePeriod] The period during which the event definition content
/// was or is planned to be in active use.
Period? effectivePeriod,
/// [topic] Descriptive topics related to the module. Topics provide a
/// high-level categorization of the module that can be useful for
/// filtering and searching.
List<CodeableConcept>? topic,
/// [author] An individiual or organization primarily involved in the
/// creation and maintenance of the content.
List<ContactDetail>? author,
/// [editor] An individual or organization primarily responsible for
/// internal coherence of the content.
List<ContactDetail>? editor,
/// [reviewer] An individual or organization asserted by the publisher to
/// be primarily responsible for review of some aspect of the content.
List<ContactDetail>? reviewer,
/// [endorser] An individual or organization asserted by the publisher to
/// be responsible for officially endorsing the content for use in some
/// setting.
List<ContactDetail>? endorser,
/// [relatedArtifact] Related resources such as additional documentation,
/// justification, or bibliographic references.
List<RelatedArtifact>? relatedArtifact,
/// [subtitle] An explanatory or alternate title for the event definition
/// giving additional information about its content.
String? subtitle,
/// [subtitleElement] ("_subtitle") Extensions for subtitle
@JsonKey(name: '_subtitle') Element? subtitleElement,
/// [subjectCodeableConcept] A code or group definition that describes the
/// intended subject of the event definition.
CodeableConcept? subjectCodeableConcept,
/// [subjectReference] A code or group definition that describes the
/// intended subject of the event definition.
Reference? subjectReference,
/// [usage] A detailed description of how the event definition is used from
/// a clinical perspective.
FhirMarkdown? usage,
/// [usageElement] ("_usage") Extensions for usage
@JsonKey(name: '_usage') Element? usageElement,
/// [trigger] The trigger element defines when the event occurs. If more
/// than one trigger condition is specified, the event fires whenever any
/// one of the trigger conditions is met.
required List<TriggerDefinition> trigger,
}) = _EventDefinition;