ObservationDefinition constructor

const ObservationDefinition({
  1. @Default(R4ResourceType.ObservationDefinition) @JsonKey(unknownEnumValue: R4ResourceType.ObservationDefinition) R4ResourceType resourceType,
  2. @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
  3. @JsonKey(name: 'id') String? fhirId,
  4. FhirMeta? meta,
  5. FhirUri? implicitRules,
  6. @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
  7. FhirCode? language,
  8. @JsonKey(name: '_language') Element? languageElement,
  9. Narrative? text,
  10. List<Resource>? contained,
  11. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  12. List<FhirExtension>? modifierExtension,
  13. List<CodeableConcept>? category,
  14. required CodeableConcept code,
  15. List<Identifier>? identifier,
  16. List<FhirCode>? permittedDataType,
  17. @JsonKey(name: '_permittedDataType') List<Element>? permittedDataTypeElement,
  18. FhirBoolean? multipleResultsAllowed,
  19. @JsonKey(name: '_multipleResultsAllowed') Element? multipleResultsAllowedElement,
  20. CodeableConcept? method,
  21. String? preferredReportName,
  22. @JsonKey(name: '_preferredReportName') Element? preferredReportNameElement,
  23. ObservationDefinitionQuantitativeDetails? quantitativeDetails,
  24. List<ObservationDefinitionQualifiedInterval>? qualifiedInterval,
  25. Reference? validCodedValueSet,
  26. Reference? normalCodedValueSet,
  27. Reference? abnormalCodedValueSet,
  28. Reference? criticalCodedValueSet,
})

ObservationDefinition Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

resourceType This is a ObservationDefinition 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 Extensions for implicitRules

language The base language in which the resource is written.

languageElement 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, and nor can they have their own independent transaction scope.

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.

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

category A code that classifies the general type of observation.

code Describes what will be observed. Sometimes this is called the observation "name".

identifier A unique identifier assigned to this ObservationDefinition artifact.

permittedDataType The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

permittedDataTypeElement Extensions for permittedDataType

multipleResultsAllowed Multiple results allowed for observations conforming to this ObservationDefinition.

multipleResultsAllowedElement Extensions for multipleResultsAllowed

method The method or technique used to perform the observation.

preferredReportName The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.

preferredReportNameElement Extensions for preferredReportName

quantitativeDetails Characteristics for quantitative results of this observation.

qualifiedInterval Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.

validCodedValueSet The set of valid coded results for the observations conforming to this ObservationDefinition.

normalCodedValueSet The set of normal coded results for the observations conforming to this ObservationDefinition.

abnormalCodedValueSet The set of abnormal coded results for the observation conforming to this ObservationDefinition.

criticalCodedValueSet The set of critical coded results for the observation conforming to this ObservationDefinition.

Implementation

const factory ObservationDefinition({
  @Default(R4ResourceType.ObservationDefinition)
  @JsonKey(unknownEnumValue: R4ResourceType.ObservationDefinition)

  /// [resourceType] This is a ObservationDefinition resource
  R4ResourceType 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') String? 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] Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] 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, and nor can they have their own independent transaction
  ///  scope.
  List<Resource>? contained,

  /// [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.
  @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
  /// 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).
  List<FhirExtension>? modifierExtension,

  /// [category] A code that classifies the general type of observation.
  List<CodeableConcept>? category,

  /// [code] Describes what will be observed. Sometimes this is called the
  ///  observation "name".
  required CodeableConcept code,

  /// [identifier] A unique identifier assigned to this ObservationDefinition
  ///  artifact.
  List<Identifier>? identifier,

  /// [permittedDataType] The data types allowed for the value element of the
  ///  instance observations conforming to this ObservationDefinition.
  List<FhirCode>? permittedDataType,
  @JsonKey(name: '_permittedDataType')

  /// [permittedDataTypeElement] Extensions for permittedDataType
  List<Element>? permittedDataTypeElement,

  /// [multipleResultsAllowed] Multiple results allowed for observations
  ///  conforming to this ObservationDefinition.
  FhirBoolean? multipleResultsAllowed,
  @JsonKey(name: '_multipleResultsAllowed')

  /// [multipleResultsAllowedElement] Extensions for multipleResultsAllowed
  Element? multipleResultsAllowedElement,

  /// [method] The method or technique used to perform the observation.
  CodeableConcept? method,

  /// [preferredReportName] The preferred name to be used when reporting the
  ///  results of observations conforming to this ObservationDefinition.
  String? preferredReportName,

  /// [preferredReportNameElement] Extensions for preferredReportName
  @JsonKey(name: '_preferredReportName') Element? preferredReportNameElement,

  /// [quantitativeDetails] Characteristics for quantitative results of this
  ///  observation.
  ObservationDefinitionQuantitativeDetails? quantitativeDetails,

  /// [qualifiedInterval] Multiple  ranges of results qualified by different
  /// contexts for ordinal or continuous observations conforming to this
  ///  ObservationDefinition.
  List<ObservationDefinitionQualifiedInterval>? qualifiedInterval,

  /// [validCodedValueSet] The set of valid coded results for the observations
  ///  conforming to this ObservationDefinition.
  Reference? validCodedValueSet,

  /// [normalCodedValueSet] The set of normal coded results for the
  ///  observations conforming to this ObservationDefinition.
  Reference? normalCodedValueSet,

  /// [abnormalCodedValueSet] The set of abnormal coded results for the
  ///  observation conforming to this ObservationDefinition.
  Reference? abnormalCodedValueSet,

  /// [criticalCodedValueSet] The set of critical coded results for the
  ///  observation conforming to this ObservationDefinition.
  Reference? criticalCodedValueSet,
}) = _ObservationDefinition;