Composition constructor

const Composition({ @Default(R4ResourceType.Composition) @JsonKey(unknownEnumValue: R4ResourceType.Composition) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, Identifier? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, required CodeableConcept type, List<CodeableConcept>? category, Reference? subject, Reference? encounter, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, required List<Reference> author, String? title, @JsonKey(name: '_title') Element? titleElement, FhirCode? confidentiality, @JsonKey(name: '_confidentiality') Element? confidentialityElement, List<CompositionAttester>? attester, Reference? custodian, List<CompositionRelatesTo>? relatesTo, List<CompositionEvent>? event, List<CompositionSection>? section, })

Composition A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

resourceType This is a Composition 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).

identifier A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

status The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

statusElement Extensions for status

type Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

category A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

subject Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

encounter Describes the clinical encounter or type of care this documentation is associated with.

date The composition editing time, when the composition was last logically changed by the author.

dateElement Extensions for date

author Identifies who is responsible for the information in the composition, not necessarily who typed it in.

title Official human-readable label for the composition.

titleElement Extensions for title

confidentiality The code specifying the level of confidentiality of the Composition.

confidentialityElement Extensions for confidentiality

attester A participant who has attested to the accuracy of the composition/document.

custodian Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

relatesTo Relationships that this composition has with other compositions or documents that already exist.

event The clinical service, such as a colonoscopy or an appendectomy, being documented.

section The root of the sections that make up the composition.

Implementation

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

  /// [resourceType] This is a Composition 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,

  /// [identifier] A version-independent identifier for the Composition. This
  ///  identifier stays constant as the composition is changed over time.
  Identifier? identifier,

  /// [status] The workflow/clinical status of this composition. The status is
  ///  a marker for the clinical standing of the document.
  FhirCode? status,

  /// [statusElement] Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [type] Specifies the particular kind of composition (e.g. History and
  /// Physical, Discharge Summary, Progress Note). This usually equates to the
  ///  purpose of making the composition.
  required CodeableConcept type,

  /// [category] A categorization for the type of the composition - helps for
  /// indexing and searching. This may be implied by or derived from the code
  ///  specified in the Composition Type.
  List<CodeableConcept>? category,

  /// [subject] Who or what the composition is about. The composition can be
  /// about a person, (patient or healthcare practitioner), a device (e.g. a
  /// machine) or even a group of subjects (such as a document about a herd of
  ///  livestock, or a set of patients that share a common exposure).
  Reference? subject,

  /// [encounter] Describes the clinical encounter or type of care this
  ///  documentation is associated with.
  Reference? encounter,

  /// [date] The composition editing time, when the composition was last
  ///  logically changed by the author.
  FhirDateTime? date,

  /// [dateElement] Extensions for date
  @JsonKey(name: '_date') Element? dateElement,

  /// [author] Identifies who is responsible for the information in the
  ///  composition, not necessarily who typed it in.
  required List<Reference> author,

  /// [title] Official human-readable label for the composition.
  String? title,

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

  /// [confidentiality] The code specifying the level of confidentiality of the
  ///  Composition.
  FhirCode? confidentiality,

  /// [confidentialityElement] Extensions for confidentiality
  @JsonKey(name: '_confidentiality') Element? confidentialityElement,

  /// [attester] A participant who has attested to the accuracy of the
  ///  composition/document.
  List<CompositionAttester>? attester,

  /// [custodian] Identifies the organization or group who is responsible for
  /// ongoing maintenance of and access to the composition/document
  ///  information.
  Reference? custodian,

  /// [relatesTo] Relationships that this composition has with other
  ///  compositions or documents that already exist.
  List<CompositionRelatesTo>? relatesTo,

  /// [event] The clinical service, such as a colonoscopy or an appendectomy,
  ///  being documented.
  List<CompositionEvent>? event,

  /// [section] The root of the sections that make up the composition.
  List<CompositionSection>? section,
}) = _Composition;