Communication class
Communication An occurrence of information being transmitted; e.g. an
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Communication({@Default(R4ResourceType.Communication) @JsonKey(unknownEnumValue: R4ResourceType.Communication) 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, List<Identifier> ? identifier, List<FhirCanonical> ? instantiatesCanonical, List<FhirUri> ? instantiatesUri, @JsonKey(name: '_instantiatesUri') List<Element?> ? instantiatesUriElement, List<Reference> ? basedOn, List<Reference> ? partOf, List<Reference> ? inResponseTo, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? statusReason, List<CodeableConcept> ? category, FhirCode? priority, @JsonKey(name: '_priority') Element? priorityElement, List<CodeableConcept> ? medium, Reference? subject, CodeableConcept? topic, List<Reference> ? about, Reference? encounter, FhirDateTime? sent, @JsonKey(name: '_sent') Element? sentElement, FhirDateTime? received, @JsonKey(name: '_received') Element? receivedElement, List<Reference> ? recipient, Reference? sender, List<CodeableConcept> ? reasonCode, List<Reference> ? reasonReference, List<CommunicationPayload> ? payload, List<Annotation> ? note}) -
Communication An occurrence of information being transmitted; e.g. an
alert that was sent to a responsible provider, a public health agency that
was notified about a reportable condition.
constfactory
-
Communication.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Communication.fromJsonString(String source)
-
Acts like a constructor, returns a Communication, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Communication.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
about
→ List<
Reference> ? -
about Other resources that pertain to this communication and to which
this communication should be associated.
no setterinherited
-
basedOn
→ List<
Reference> ? -
basedOn An order, proposal or plan fulfilled in whole or in part by
this Communication.
no setterinherited
-
category
→ List<
CodeableConcept> ? -
category The type of message conveyed such as alert, notification,
reminder, instruction, etc.
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
→ $CommunicationCopyWith<
Communication> -
no setterinherited
- dbId → int?
-
no setterinherited
- encounter → Reference?
-
encounter The Encounter during which this Communication was created or
to which the creation of this record is tightly associated.
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
→ List<
Identifier> ? -
identifier Business identifiers assigned to this communication by the
performer or other systems which remain constant as the resource is
updated and propagates from server to server.
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
-
inResponseTo
→ List<
Reference> ? -
inResponseTo Prior communication that this communication is in response
to.
no setterinherited
-
instantiatesCanonical
→ List<
FhirCanonical> ? -
instantiatesCanonical The URL pointing to a FHIR-defined protocol,
guideline, orderset or other definition that is adhered to in whole or in
part by this Communication.
no setterinherited
-
instantiatesUri
→ List<
FhirUri> ? -
instantiatesUri The URL pointing to an externally maintained protocol,
guideline, orderset or other definition that is adhered to in whole or in
part by this Communication.
no setterinherited
-
instantiatesUriElement
→ List<
Element?> ? -
instantiatesUriElement Extensions for instantiatesUri
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement Extensions for language
no setterinherited
-
medium
→ List<
CodeableConcept> ? -
medium A channel that was used for this communication (e.g. email,
fax).
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
-
note
→ List<
Annotation> ? -
note Additional notes or commentary about the communication by the
sender, receiver or other interested parties.
no setterinherited
-
partOf
→ List<
Reference> ? -
partOf Part of this action.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
payload
→ List<
CommunicationPayload> ? -
payload Text, attachment(s), or resource(s) that was communicated to
the recipient.
no setterinherited
- priority → FhirCode?
-
priority Characterizes how quickly the planned or in progress
communication must be addressed. Includes concepts such as stat, urgent,
routine.
no setterinherited
- priorityElement → Element?
-
priorityElement Extensions for priority
no setterinherited
-
reasonCode
→ List<
CodeableConcept> ? -
reasonCode The reason or justification for the communication.
no setterinherited
-
reasonReference
→ List<
Reference> ? -
reasonReference Indicates another resource whose existence justifies
this communication.
no setterinherited
- received → FhirDateTime?
-
received The time when this communication arrived at the destination.
no setterinherited
- receivedElement → Element?
-
receivedElement Extensions for received
no setterinherited
-
recipient
→ List<
Reference> ? -
recipient The entity (e.g. person, organization, clinical information
system, care team or device) which was the target of the communication. If
receipts need to be tracked by an individual, a separate resource instance
will need to be created for each recipient. Multiple recipient
communications are intended where either receipts are not tracked (e.g. a
mass mail-out) or a receipt is captured in aggregate (all emails confirmed
received by a particular time).
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
- sender → Reference?
-
sender The entity (e.g. person, organization, clinical information
system, or device) which was the source of the communication.
no setterinherited
- sent → FhirDateTime?
-
sent The time when this communication was sent.
no setterinherited
- sentElement → Element?
-
sentElement Extensions for sent
no setterinherited
- status → FhirCode?
-
status The status of the transmission.
no setterinherited
- statusElement → Element?
-
statusElement Extensions for status
no setterinherited
- statusReason → CodeableConcept?
-
statusReason Captures the reason for the current state of the
Communication.
no setterinherited
- subject → Reference?
-
subject The patient or group that was the focus of this communication.
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
- topic → CodeableConcept?
-
topic Description of the purpose/content, similar to a subject line in
an email.
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