Composition class

Composition A set of healthcare-related information that is assembled

Mixed in types
Annotations
  • @freezed

Constructors

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.).
const
factory
Composition.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
Composition.fromJsonString(String source)
Acts like a constructor, returns a Composition, accepts a String as an argument, mostly because I got tired of typing it out
factory
Composition.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

attester → List<CompositionAttester>?
attester A participant who has attested to the accuracy of the composition/document.
no setterinherited
author → List<Reference>
author Identifies who is responsible for the information in the composition, not necessarily who typed it in.
no setterinherited
category → List<CodeableConcept>?
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.
no setterinherited
confidentiality → FhirCode?
confidentiality The code specifying the level of confidentiality of the Composition.
no setterinherited
confidentialityElement → Element?
confidentialityElement Extensions for confidentiality
no setterinherited
contained → List<Resource>?
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.
no setterinherited
copyWith → $CompositionCopyWith<Composition>
no setterinherited
custodian → Reference?
custodian Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
no setterinherited
date → FhirDateTime?
date The composition editing time, when the composition was last logically changed by the author.
no setterinherited
dateElement → Element?
dateElement Extensions for date
no setterinherited
dbId → int?
no setterinherited
encounter → Reference?
encounter Describes the clinical encounter or type of care this documentation is associated with.
no setterinherited
event → List<CompositionEvent>?
event The clinical service, such as a colonoscopy or an appendectomy, being documented.
no setterinherited
extension_ → List<FhirExtension>?
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.
no setterinherited
fhirId → String?
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
identifier → Identifier?
identifier A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
no setterinherited
implicitRules → FhirUri?
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.
no setterinherited
implicitRulesElement → Element?
implicitRulesElement Extensions for implicitRules
no setterinherited
language → FhirCode?
language The base language in which the resource is written.
no setterinherited
languageElement → Element?
languageElement Extensions for language
no setterinherited
meta → FhirMeta?
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.
no setterinherited
modifierExtension → List<FhirExtension>?
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).
no setterinherited
path → String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
relatesTo → List<CompositionRelatesTo>?
relatesTo Relationships that this composition has with other compositions or documents that already exist.
no setterinherited
resourceType → R4ResourceType
no setterinherited
resourceTypeString → String?
produce a string of the resourceType
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
section → List<CompositionSection>?
section The root of the sections that make up the composition.
no setterinherited
status → FhirCode?
status The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
no setterinherited
statusElement → Element?
statusElement Extensions for status
no setterinherited
subject → Reference?
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).
no setterinherited
text → Narrative?
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.
no setterinherited
thisReference → Reference
Convenience method to return a Reference referring to that Resource
no setterinherited
title → String?
title Official human-readable label for the composition.
no setterinherited
titleElement → Element?
titleElement Extensions for title
no setterinherited
type → CodeableConcept
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.
no setterinherited

Methods

newId() → Resource
returns the same resource with a new ID (even if there is already an ID present)
inherited
newIdIfNoId() → Resource
returns the same resource with a new ID if there is no current ID
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDbJson() → Map<String, dynamic>
The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids
inherited
toJson() → Map<String, dynamic>
inherited
toJsonString() → String
Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map
override
toString() → String
A string representation of this object.
inherited
toYaml() → String
Produces a Yaml formatted String version of the object
inherited
updateVersion({FhirMeta? oldMeta}) → Resource
Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited