CitationRelatesTo constructor

const CitationRelatesTo({
  1. @JsonKey(name: 'id') String? fhirId,
  2. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  3. List<FhirExtension>? modifierExtension,
  4. FhirCode? type,
  5. @JsonKey(name: '_type') Element? typeElement,
  6. List<CodeableConcept>? classifier,
  7. String? label,
  8. @JsonKey(name: '_label') Element? labelElement,
  9. String? display,
  10. @JsonKey(name: '_display') Element? displayElement,
  11. FhirMarkdown? citation,
  12. @JsonKey(name: '_citation') Element? citationElement,
  13. Attachment? document,
  14. FhirCanonical? resource,
  15. @JsonKey(name: '_resource') Element? resourceElement,
  16. Reference? resourceReference,
})

CitationRelatesTo The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.

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

type The type of relationship to the related artifact.

typeElement ("_type") Extensions for type

classifier Provides additional classifiers of the related artifact.

label A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.

labelElement ("_label") Extensions for label

display A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

displayElement ("_display") Extensions for display

citation A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

citationElement ("_citation") Extensions for citation

document The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact.

resource The related artifact, such as a library, value set, profile, or other knowledge resource.

resourceElement ("_resource") Extensions for resource

resourceReference The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Implementation

const factory CitationRelatesTo({
  /// [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,

  /// [type] The type of relationship to the related artifact.
  FhirCode? type,

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

  /// [classifier] Provides additional classifiers of the related artifact.
  List<CodeableConcept>? classifier,

  /// [label] A short label that can be used to reference the related
  ///  artifact from elsewhere in the containing artifact, such as a footnote
  ///  index.
  String? label,

  /// [labelElement] ("_label") Extensions for label
  @JsonKey(name: '_label') Element? labelElement,

  /// [display] A brief description of the document or knowledge resource
  ///  being referenced, suitable for display to a consumer.
  String? display,

  /// [displayElement] ("_display") Extensions for display
  @JsonKey(name: '_display') Element? displayElement,

  /// [citation] A bibliographic citation for the related artifact. This text
  ///  SHOULD be formatted according to an accepted citation format.
  FhirMarkdown? citation,

  /// [citationElement] ("_citation") Extensions for citation
  @JsonKey(name: '_citation') Element? citationElement,

  /// [document] The document being referenced, represented as an attachment.
  ///  Do not use this element if using the resource element to provide the
  ///  canonical to the related artifact.
  Attachment? document,

  /// [resource] The related artifact, such as a library, value set, profile,
  ///  or other knowledge resource.
  FhirCanonical? resource,

  /// [resourceElement] ("_resource") Extensions for resource
  @JsonKey(name: '_resource') Element? resourceElement,

  /// [resourceReference] The related artifact, if the artifact is not a
  ///  canonical resource, or a resource reference to a canonical resource.
  Reference? resourceReference,
}) = _CitationRelatesTo;