ExampleScenarioInstance class

ExampleScenarioInstance A single data collection that is shared as part of the scenario.

Inheritance
Available extensions

Constructors

ExampleScenarioInstance({FhirString? id, List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, required FhirString key, required Coding structureType, FhirString? structureVersion, StructureProfileXExampleScenarioInstance? structureProfileX, FhirCanonical? structureProfileCanonical, FhirUri? structureProfileUri, required FhirString title, FhirMarkdown? description, Reference? content, List<ExampleScenarioVersion>? version, List<ExampleScenarioContainedInstance>? containedInstance, bool? disallowExtensions = false})
Primary constructor for ExampleScenarioInstance
const
ExampleScenarioInstance.fromJson(Map<String, dynamic> json)
Factory constructor that accepts Map<String, dynamic> as an argument
factory
ExampleScenarioInstance.fromJsonString(String source)
Factory constructor for ExampleScenarioInstance that takes in a String Convenience method to avoid the json Encoding/Decoding normally required to get data from a String
factory
ExampleScenarioInstance.fromYaml(dynamic yaml)
Deserialize ExampleScenarioInstance from a String or YamlMap object
factory

Properties

containedInstance List<ExampleScenarioContainedInstance>?
containedInstance References to other instances that can be found within this instance (e.g. the observations contained in a bundle).
final
content Reference?
content Points to an instance (typically an example) that shows the data that would corespond to this instance.
final
copyWith $ExampleScenarioInstanceCopyWith<ExampleScenarioInstance>
Copy function for ExampleScenarioInstance Returns a copy of the current instance with the provided fields modified. If a field is not provided, it will retain its original value. If a null is provided, this will clearn the field, unless the field is required, in which case it will keep its current value.
no setteroverride
copyWith $ExampleScenarioInstanceCopyWith<ExampleScenarioInstance>

Available on ExampleScenarioInstance, provided by the ExampleScenarioInstanceCopyWithExtension extension

no setter
description FhirMarkdown?
description An explanation of what the instance contains and what it's for.
final
disallowExtensions bool?
This is used in the FHIRPath engine to record that no extensions are allowed for this item in the context in which it is used. to do: enforce this....
finalinherited
extension_ List<FhirExtension>?
List of extensions for additional information.
finalinherited
fhirType String
Returns the FHIR type of the object.
no setteroverride
hashCode int
The hash code for this object.
no setterinherited
hasId bool
Getter for checking if the element has an id.
no setterinherited
hasPrimitiveValue bool
Checks if the object has a primitive value.
no setterinherited
id FhirString?
Unique id for the element within a resource.
finalinherited
isMetadataBased bool
All Elements are metadata based.
no setterinherited
isPrimitive bool
Checks if the object is primitive.
no setterinherited
key FhirString
key A unique string within the scenario that is used to reference the instance.
final
modifierExtension List<FhirExtension>?
List of modifier extensions for additional, non-core information
finalinherited
primitiveValue String?
Retrieves the primitive value of the object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
structureProfileCanonical FhirCanonical?
Getter for structureProfileCanonical as a FhirCanonical
no setter
structureProfileUri FhirUri?
Getter for structureProfileUri as a FhirUri
no setter
structureProfileX StructureProfileXExampleScenarioInstance?
structureProfileX Refers to a profile, template or other ruleset the instance adheres to.
final
structureType Coding
structureType A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.
final
structureVersion FhirString?
structureVersion Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.
final
title FhirString
title A short descriptive label the instance to be used in tables or diagrams.
final
version List<ExampleScenarioVersion>?
version Represents the instance as it was at a specific time-point.
final

Methods

addExtension(FhirExtension ext) → void
Method to add an extension.
inherited
addModifierExtension(FhirExtension ext) → void
Adds a modifier extension
inherited
clone() ExampleScenarioInstance
Subclasses must implement the clone method.
override
compareDeepStrings(String? s1, String? s2, bool allowNull) bool
Checks if the object is equal to another object.
inherited
equalsDeep(FhirBase? o) bool
Performs a deep comparison between two instances.
override
equalsShallow(Element other) bool
Method to compare shallow equality of two elements.
inherited
getChildByName(String name) FhirBase?
Retrieves a single field value by its name.
override
getChildrenByName(String fieldName, [bool checkValid = false]) List<FhirBase>
Retrieves all matching child fields by name. Optionally validates the name.
override
getExtensionFirstRep() FhirExtension
Getter for the first extension.
inherited
getExtensionsByUrl(String url) List<FhirExtension>
Getter for the first extension by url.
inherited
getModifierExtensionFirstRep() FhirExtension
Gets the first repetition of modifier extensions
inherited
getModifierExtensionsByUrl(String url) List<FhirExtension>
Retrieves all modifier extensions by URL
inherited
hasExtension() bool
Extension handling methods.
inherited
hasExtensionByUrl(String url) bool
Method to check if an extension exists by url.
inherited
hasModifierExtension() bool
Method to check if there are any modifier extensions
inherited
hasType(List<String> names) bool
Checks if the object has a given type.
inherited
hasValues() bool
Checks if the object has values.
inherited
isAs<T extends FhirBase>() → T?
Returns an Object cast as a Type if it is that type.
inherited
isEmpty() bool
Checks if the object is empty.
inherited
listChildrenNames() List<String>
Lists the JSON keys for the object.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
prettyPrint() String
Converts the object to a pretty JSON string.
inherited
removeExtension(String url) → void
Method to remove an extension by url.
inherited
removeModifierExtension(String url) → void
Removes modifier extensions by URL
inherited
toJson() Map<String, dynamic>
Converts the object to a JSON representation.
override
toJsonString() String
Converts the object to a JSON string.
inherited
toString() String
A string representation of this object.
inherited
toYaml() String
Converts the object to a YAML string.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited