Composition class

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

Mixed in types

• Resource

Annotations

• @freezed

Constructors

Composition({@Default(R5ResourceType.Composition) @JsonKey(unknownEnumValue: R5ResourceType.Composition) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? 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, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, List<Identifier>? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, required CodeableConcept type, List<CodeableConcept>? category, List<Reference>? subject, Reference? encounter, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, List<UsageContext>? useContext, required List<Reference> author, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, List<Annotation>? note, List<CompositionAttester>? attester, Reference? custodian, List<RelatedArtifact>? 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 setter, inherited

author → List<Reference>

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

no setter, inherited

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 setter, inherited

contained → List<Resource>?

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

no setter, inherited

copyWith → $CompositionCopyWith<Composition>

no setter, inherited

custodian → Reference?

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

no setter, inherited

date → FhirDateTime?

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

no setter, inherited

dateElement → Element?

dateElement ("_date") Extensions for date

no setter, inherited

dbId → int?

no setter, inherited

encounter → Reference?

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

no setter, inherited

event → List<CompositionEvent>?

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

no setter, inherited

extension_ → List<FhirExtension>?

extension_ ("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 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.

no setter, inherited

fhirId → FhirId?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

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

no setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement ("_implicitRules") Extensions for implicitRules

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement ("_language") Extensions for language

no setter, inherited

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 setter, inherited

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 managable, 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 setter, inherited

name → String?

name A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.

no setter, inherited

nameElement → Element?

nameElement ("_name") Extensions for name

no setter, inherited

note → List<Annotation>?

note For any additional notes.

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

relatesTo → List<RelatedArtifact>?

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

no setter, inherited

resourceType → R5ResourceType

resourceType This is a Composition resource

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

section → List<CompositionSection>?

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

no setter, inherited

status → FhirCode?

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

no setter, inherited

statusElement → Element?

statusElement ("_status") Extensions for status

no setter, inherited

subject → List<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 setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

title → String?

title Official human-readable label for the composition.

no setter, inherited

titleElement → Element?

titleElement ("_title") Extensions for title

no setter, inherited

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 setter, inherited

url → FhirUri?

url An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers.

no setter, inherited

urlElement → Element?

urlElement ("_url") Extensions for url

no setter, inherited

useContext → List<UsageContext>?

useContext The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances.

no setter, inherited

version → String?

version An explicitly assigned identifer of a variation of the content in the Composition.

no setter, inherited

versionElement → Element?

versionElement ("_version") Extensions for version

no setter, inherited

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

override

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