Communication class

Communication A clinical or business level record of information being transmitted or shared; e.g. an alert that was sent to a responsible provider, a public health agency communication to a provider/reporter in response to a case report for a reportable condition.

Inheritance
Available extensions

Constructors

Communication({FhirString? id, FhirMeta? meta, FhirUri? implicitRules, AllLanguages? language, Narrative? text, List<Resource>? contained, List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, List<Identifier>? identifier, List<FhirCanonical>? instantiatesCanonical, List<FhirUri>? instantiatesUri, List<Reference>? basedOn, List<Reference>? partOf, List<Reference>? inResponseTo, required EventStatus status, CodeableConcept? statusReason, List<CodeableConcept>? category, RequestPriority? priority, List<CodeableConcept>? medium, Reference? subject, CodeableConcept? topic, List<Reference>? about, Reference? encounter, FhirDateTime? sent, FhirDateTime? received, List<Reference>? recipient, Reference? sender, List<CodeableReference>? reason, List<CommunicationPayload>? payload, List<Annotation>? note})
Primary constructor for Communication
const
Communication.fromJson(Map<String, dynamic> json)
Factory constructor that accepts Map<String, dynamic> as an argument
factory
Communication.fromJsonString(String source)
Factory constructor for Communication that takes in a String Convenience method to avoid the json Encoding/Decoding normally required to get data from a String
factory
Communication.fromYaml(dynamic yaml)
Deserialize Communication from a String or YamlMap object
factory

Properties

about → List<Reference>?
about Other resources that pertain to this communication and to which this communication should be associated.
final
basedOn → List<Reference>?
basedOn An order, proposal or plan fulfilled in whole or in part by this Communication.
final
category → List<CodeableConcept>?
category The type of message conveyed such as alert, notification, reminder, instruction, etc.
final
contained → List<Resource>?
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
finalinherited
copyWith → $CommunicationCopyWith<Communication>
Copy function for Communication Returns a copy of the current instance with the provided fields modified. If a field is not provided, it will retain its original value. If a null is provided, this will clearn the field, unless the field is required, in which case it will keep its current value.
no setteroverride
copyWith → $CommunicationCopyWith<Communication>

Available on Communication, provided by the CommunicationCopyWithExtension extension

no setter
encounter → Reference?
encounter The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
final
extension_ → List<FhirExtension>?
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.",
finalinherited
fhirType → String
Returns the FHIR type of the object.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
hasPrimitiveValue → bool
Checks if the object has a primitive value.
no setterinherited
id → FhirString?
The logical id of the resource, as used in the URL for the resource.
finalinherited
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.
final
implicitRules → FhirUri?
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.
finalinherited
inResponseTo → List<Reference>?
inResponseTo Prior communication that this communication is in response to.
final
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.
final
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.
final
isMetadataBased → bool
All FhirBases and Resources are NOT metadata based
no setterinherited
isPrimitive → bool
Checks if the object is primitive.
no setterinherited
language → AllLanguages?
The base language in which the resource is written. This should be the language of the text value in the content element when a text value is present.
finalinherited
medium → List<CodeableConcept>?
medium A channel that was used for this communication (e.g. email, fax).
final
meta → FhirMeta?
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.
finalinherited
modifierExtension → List<FhirExtension>?
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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
finalinherited
note → List<Annotation>?
note Additional notes or commentary about the communication by the sender, receiver or other interested parties.
final
partOf → List<Reference>?
partOf A larger event (e.g. Communication, Procedure) of which this particular communication is a component or step.
final
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.
final
primitiveValue → String?
Retrieves the primitive value of the object.
no setterinherited
priority → RequestPriority?
priority Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
final
reason → List<CodeableReference>?
reason The reason or justification for the communication.
final
received → FhirDateTime?
received The time when this communication arrived at the destination.
final
recipient → List<Reference>?
recipient The entity (e.g. person, organization, clinical information system, care team or device) which is the target of the communication.
final
resourceType → R5ResourceType
The type of resource
finalinherited
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 is the source of the communication.
final
sent → FhirDateTime?
sent The time when this communication was sent.
final
status → EventStatus
status The status of the transmission.
final
statusReason → CodeableConcept?
statusReason Captures the reason for the current state of the Communication.
final
subject → Reference?
subject The patient or group that was the focus of this communication.
final
text → Narrative?
A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
finalinherited
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.
final

Methods

clone() → Communication
Subclasses must implement the clone method.
override
compareDeepStrings(String? s1, String? s2, bool allowNull) → bool
Checks if the object is equal to another object.
inherited
equalsDeep(FhirBase? o) → bool
Performs a deep comparison between two instances.
override
getChildByName(String name) → FhirBase?
Retrieves a single field value by its name.
override
getChildrenByName(String fieldName, [bool checkValid = false]) → List<FhirBase>
Retrieves all matching child fields by name. Optionally validates the name.
override
hasType(List<String> names) → bool
Checks if the object has a given type.
inherited
hasValues() → bool
Checks if the object has values.
inherited
isAs<T extends FhirBase>() → T?
Returns an Object cast as a Type if it is that type.
inherited
isEmpty() → bool
Checks if the object is empty.
inherited
listChildrenNames() → List<String>
Lists the JSON keys for the object.
override
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
prettyPrint() → String
Converts the object to a pretty JSON string.
inherited
toJson() → Map<String, dynamic>
Returns a Map<String, dynamic> of the DomainResource
override
toJsonString() → String
Converts the object to a JSON string.
inherited
toString() → String
A string representation of this object.
inherited
toYaml() → String
Converts the object to a YAML string.
inherited
updateVersion({FhirMeta? oldMeta, bool versionIdAsTime = false}) → 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