ExampleScenario class
ExampleScenario Example of workflow instance.
- Mixed-in types
- Annotations
-
- @freezed
Constructors
-
ExampleScenario({@Default(R4ResourceType.ExampleScenario) @JsonKey(unknownEnumValue: R4ResourceType.ExampleScenario) 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, 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, List<UsageContext> ? useContext, List<CodeableConcept> ? jurisdiction, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, List<ExampleScenarioActor> ? actor, List<ExampleScenarioInstance> ? instance, List<ExampleScenarioProcess> ? process, List<FhirCanonical> ? workflow}) -
ExampleScenario Example of workflow instance.
constfactory
-
ExampleScenario.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- ExampleScenario.fromJsonString(String source)
-
Acts like a constructor, returns a ExampleScenario, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- ExampleScenario.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
actor
→ List<
ExampleScenarioActor> ? -
actor
Actor participating in the resource.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 → FhirMarkdown?
-
copyright
A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.no setterinherited - copyrightElement → Element?
-
copyrightElement
Extensions for copyrightno setterinherited -
copyWith
→ $ExampleScenarioCopyWith<
ExampleScenario> -
no setterinherited
- date → FhirDateTime?
-
date
The date (and optionally time) when the example scenario 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 example scenario changes. (e.g. the 'content logical definition').no setterinherited - dateElement → Element?
-
dateElement
Extensions for dateno setterinherited - dbId → int?
-
no setterinherited
- experimental → FhirBoolean?
-
experimental
A Boolean value to indicate that this example scenario 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 experimentalno 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 example scenario 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 implicitRulesno setterinherited -
instance
→ List<
ExampleScenarioInstance> ? -
instance
Each resource and each version that is present in the workflow.no setterinherited -
jurisdiction
→ List<
CodeableConcept> ? -
jurisdiction
A legal or geographic region in which the example scenario is intended to be used.no setterinherited - language → FhirCode?
-
language
The base language in which the resource is written.no setterinherited - languageElement → Element?
-
languageElement
Extensions for languageno 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 example scenario. 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 nameno setterinherited - path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
process
→ List<
ExampleScenarioProcess> ? -
process
Each major process - a group of operations.no setterinherited - publisher → String?
-
publisher
The name of the organization or individual that published the example scenario.no setterinherited - publisherElement → Element?
-
publisherElement
Extensions for publisherno setterinherited - purpose → FhirMarkdown?
-
purpose
What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.no setterinherited - purposeElement → Element?
-
purposeElement
Extensions for purposeno setterinherited - resourceType → R4ResourceType
-
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 → FhirCode?
-
status
The status of this example scenario. Enables tracking the life-cycle of the content.no setterinherited - statusElement → Element?
-
statusElement
Extensions for statusno 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
- url → FhirUri?
-
url
An absolute URI that is used to identify this example scenario 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 example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.no setterinherited - urlElement → Element?
-
urlElement
Extensions for urlno 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 example scenario instances.no setterinherited - version → String?
-
version
The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario 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 setterinherited - versionElement → Element?
-
versionElement
Extensions for versionno setterinherited -
workflow
→ List<
FhirCanonical> ? -
workflow
Another nested workflow.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