ExampleScenarioInstance constructor

const ExampleScenarioInstance({
  1. @JsonKey(name: 'id') String? fhirId,
  2. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  3. List<FhirExtension>? modifierExtension,
  4. String? key,
  5. @JsonKey(name: '_key') Element? keyElement,
  6. required Coding structureType,
  7. String? structureVersion,
  8. @JsonKey(name: '_structureVersion') Element? structureVersionElement,
  9. FhirCanonical? structureProfileCanonical,
  10. @JsonKey(name: '_structureProfileCanonical') Element? structureProfileCanonicalElement,
  11. FhirUri? structureProfileUri,
  12. @JsonKey(name: '_structureProfileUri') Element? structureProfileUriElement,
  13. String? title,
  14. @JsonKey(name: '_title') Element? titleElement,
  15. FhirMarkdown? description,
  16. @JsonKey(name: '_description') Element? descriptionElement,
  17. Reference? content,
  18. List<ExampleScenarioVersion>? version,
  19. List<ExampleScenarioContainedInstance>? containedInstance,
})

ExampleScenarioInstance Example of workflow instance.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the element. 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 element and that modifies the understanding of the element in which it is contained 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 can 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).

key A unique string within the scenario that is used to reference the instance.

keyElement ("_key") Extensions for key

structureType A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.

structureVersion Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.

structureVersionElement ("_structureVersion") Extensions for structureVersion

structureProfileCanonical Refers to a profile, template or other ruleset the instance adheres to.

structureProfileCanonicalElement ("_structureProfileCanonical") Extensions for structureProfileCanonical

structureProfileUri Refers to a profile, template or other ruleset the instance adheres to.

structureProfileUriElement ("_structureProfileUri") Extensions for structureProfileUri

title A short descriptive label the instance to be used in tables or diagrams.

titleElement ("_title") Extensions for title

description An explanation of what the instance contains and what it's for.

descriptionElement ("_description") Extensions for description

content Points to an instance (typically an example) that shows the data that would corespond to this instance.

version Represents the instance as it was at a specific time-point.

containedInstance References to other instances that can be found within this instance (e.g. the observations contained in a bundle).

Implementation

const factory ExampleScenarioInstance({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [extension_] ("extension") May be used to represent additional
  ///  information that is not part of the basic definition of the element.
  ///  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 element and that
  ///  modifies the understanding of the element in which it is contained
  ///  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 can 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,

  /// [key] A unique string within the scenario that is used to reference the
  ///  instance.
  String? key,

  /// [keyElement] ("_key") Extensions for key
  @JsonKey(name: '_key') Element? keyElement,

  /// [structureType] A code indicating the kind of data structure (FHIR
  ///  resource or some other standard) this is an instance of.
  required Coding structureType,

  /// [structureVersion] Conveys the version of the data structure
  ///  instantiated.  I.e. what release of FHIR, X12, OpenEHR, etc. is
  ///  instance compliant with.
  String? structureVersion,

  /// [structureVersionElement] ("_structureVersion") Extensions for
  ///  structureVersion
  @JsonKey(name: '_structureVersion') Element? structureVersionElement,

  /// [structureProfileCanonical] Refers to a profile, template or other
  ///  ruleset the instance adheres to.
  FhirCanonical? structureProfileCanonical,

  /// [structureProfileCanonicalElement] ("_structureProfileCanonical")
  ///  Extensions for structureProfileCanonical
  @JsonKey(name: '_structureProfileCanonical')
  Element? structureProfileCanonicalElement,

  /// [structureProfileUri] Refers to a profile, template or other ruleset
  ///  the instance adheres to.
  FhirUri? structureProfileUri,

  /// [structureProfileUriElement] ("_structureProfileUri") Extensions for
  ///  structureProfileUri
  @JsonKey(name: '_structureProfileUri') Element? structureProfileUriElement,

  /// [title] A short descriptive label the instance to be used in tables or
  ///  diagrams.
  String? title,

  /// [titleElement] ("_title") Extensions for title
  @JsonKey(name: '_title') Element? titleElement,

  /// [description] An explanation of what the instance contains and what
  ///  it's for.
  FhirMarkdown? description,

  /// [descriptionElement] ("_description") Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [content] Points to an instance (typically an example) that shows the
  ///  data that would corespond to this instance.
  Reference? content,

  /// [version] Represents the instance as it was at a specific time-point.
  List<ExampleScenarioVersion>? version,

  /// [containedInstance] References to other instances that can be found
  ///  within this instance (e.g. the observations contained in a bundle).
  List<ExampleScenarioContainedInstance>? containedInstance,
}) = _ExampleScenarioInstance;