DataRequirement constructor

const DataRequirement({ @JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, FhirCode? type, @JsonKey(name: '_type') Element? typeElement, List<FhirCanonical>? profile, CodeableConcept? subjectCodeableConcept, Reference? subjectReference, List<String>? mustSupport, @JsonKey(name: '_mustSupport') List<Element?>? mustSupportElement, List<DataRequirementCodeFilter>? codeFilter, List<DataRequirementDateFilter>? dateFilter, FhirPositiveInt? limit, @JsonKey(name: '_limit') Element? limitElement, List<DataRequirementSort>? sort, })

DataRequirement Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

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

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

type The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

typeElement Extensions for type

profile The profile of the required data, specified as the uri of the profile definition.

subjectCodeableConcept The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

subjectReference The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

mustSupport Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

mustSupportElement Extensions for mustSupport

codeFilter Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

dateFilter Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

limit Specifies a maximum number of results that are required (uses the _count search parameter).

limitElement Extensions for limit

sort Specifies the order of the results to be returned.

Implementation

const factory DataRequirement({
  /// [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_] 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 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [type] The type of the required data, specified as the type name of a
  /// resource. For profiles, this value is set to the type of the base resource
  ///  of the profile.
  FhirCode? type,

  /// [typeElement] Extensions for type
  @JsonKey(name: '_type') Element? typeElement,

  /// [profile] The profile of the required data, specified as the uri of the
  ///  profile definition.
  List<FhirCanonical>? profile,

  /// [subjectCodeableConcept] The intended subjects of the data requirement.
  ///  If this element is not provided, a Patient subject is assumed.
  CodeableConcept? subjectCodeableConcept,

  /// [subjectReference] The intended subjects of the data requirement. If this
  ///  element is not provided, a Patient subject is assumed.
  Reference? subjectReference,

  /// [mustSupport] Indicates that specific elements of the type are referenced
  /// by the knowledge module and must be supported by the consumer in order to
  /// obtain an effective evaluation. This does not mean that a value is
  /// required for this element, only that the consuming system must understand
  ///  the element and be able to provide values for it if they are available.
  /// The value of mustSupport SHALL be a FHIRPath resolveable on the type of
  /// the DataRequirement. The path SHALL consist only of identifiers, constant
  /// indexers, and .resolve() (see the [Simple FHIRPath
  ///  Profile](fhirpath.html#simple) for full details).
  List<String>? mustSupport,

  /// [mustSupportElement] Extensions for mustSupport
  @JsonKey(name: '_mustSupport') List<Element?>? mustSupportElement,

  /// [codeFilter] Code filters specify additional constraints on the data,
  /// specifying the value set of interest for a particular element of the data.
  /// Each code filter defines an additional constraint on the data, i.e. code
  ///  filters are AND'ed, not OR'ed.
  List<DataRequirementCodeFilter>? codeFilter,

  /// [dateFilter] Date filters specify additional constraints on the data in
  /// terms of the applicable date range for specific elements. Each date filter
  /// specifies an additional constraint on the data, i.e. date filters are
  ///  AND'ed, not OR'ed.
  List<DataRequirementDateFilter>? dateFilter,

  /// [limit] Specifies a maximum number of results that are required (uses the
  ///  _count search parameter).
  FhirPositiveInt? limit,

  /// [limitElement] Extensions for limit
  @JsonKey(name: '_limit') Element? limitElement,

  /// [sort] Specifies the order of the results to be returned.
  List<DataRequirementSort>? sort,
}) = _DataRequirement;