CommunicationRequest class

CommunicationRequest A request to convey information; e.g. the CDS

Mixed in types

• Resource

Annotations

• @freezed

Constructors

CommunicationRequest({@Default(R4ResourceType.CommunicationRequest) @JsonKey(unknownEnumValue: R4ResourceType.CommunicationRequest) 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<Reference>? basedOn, List<Reference>? replaces, Identifier? groupIdentifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? statusReason, List<CodeableConcept>? category, FhirCode? priority, @JsonKey(name: '_priority') Element? priorityElement, FhirBoolean? doNotPerform, @JsonKey(name: '_doNotPerform') Element? doNotPerformElement, List<CodeableConcept>? medium, Reference? subject, List<Reference>? about, Reference? encounter, List<CommunicationRequestPayload>? payload, FhirDateTime? occurrenceDateTime, @JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement, Period? occurrencePeriod, FhirDateTime? authoredOn, @JsonKey(name: '_authoredOn') Element? authoredOnElement, Reference? requester, List<Reference>? recipient, Reference? sender, List<CodeableConcept>? reasonCode, List<Reference>? reasonReference, List<Annotation>? note})

CommunicationRequest A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

const

factory

CommunicationRequest.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

CommunicationRequest.fromJsonString(String source)

Acts like a constructor, returns a CommunicationRequest, accepts a String as an argument, mostly because I got tired of typing it out

factory

CommunicationRequest.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 request and to which this communication request should be associated.

no setter, inherited

authoredOn → FhirDateTime?

authoredOn For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

no setter, inherited

authoredOnElement → Element?

authoredOnElement Extensions for authoredOn

no setter, inherited

basedOn → List<Reference>?

basedOn A plan or proposal that is fulfilled in whole or in part by this request.

no setter, inherited

category → List<CodeableConcept>?

category The type of message to be sent such as alert, notification, reminder, instruction, etc.

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, and nor can they have their own independent transaction scope.

no setter, inherited

copyWith → $CommunicationRequestCopyWith<CommunicationRequest>

no setter, inherited

dbId → int?

no setter, inherited

doNotPerform → FhirBoolean?

doNotPerform If true indicates that the CommunicationRequest is asking for the specified action to not occur.

no setter, inherited

doNotPerformElement → Element?

doNotPerformElement Extensions for doNotPerform

no setter, inherited

encounter → Reference?

encounter The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

no setter, inherited

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

fhirId → String?

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

no setter, inherited

groupIdentifier → Identifier?

groupIdentifier A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

identifier Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

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 Extensions for implicitRules

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

medium → List<CodeableConcept>?

medium A channel that was used for this communication (e.g. email, fax).

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

note → List<Annotation>?

note Comments made about the request by the requester, sender, recipient, subject or other participants.

no setter, inherited

occurrenceDateTime → FhirDateTime?

occurrenceDateTime The time when this communication is to occur.

no setter, inherited

occurrenceDateTimeElement → Element?

occurrenceDateTimeElement Extensions for occurrenceDateTime

no setter, inherited

occurrencePeriod → Period?

occurrencePeriod The time when this communication is to occur.

no setter, inherited

path → String

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

no setter, inherited

payload → List<CommunicationRequestPayload>?

payload Text, attachment(s), or resource(s) to be communicated to the recipient.

no setter, inherited

priority → FhirCode?

priority Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

no setter, inherited

priorityElement → Element?

priorityElement Extensions for priority

no setter, inherited

reasonCode → List<CodeableConcept>?

reasonCode Describes why the request is being made in coded or textual form.

no setter, inherited

reasonReference → List<Reference>?

reasonReference Indicates another resource whose existence justifies this request.

no setter, inherited

recipient → List<Reference>?

recipient The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

no setter, inherited

replaces → List<Reference>?

replaces Completed or terminated request(s) whose function is taken by this new request.

no setter, inherited

requester → Reference?

requester The device, individual, or organization who initiated the request and has responsibility for its activation.

no setter, inherited

resourceType → R4ResourceType

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

sender → Reference?

sender The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

no setter, inherited

status → FhirCode?

status The status of the proposal or order.

no setter, inherited

statusElement → Element?

statusElement Extensions for status

no setter, inherited

statusReason → CodeableConcept?

statusReason Captures the reason for the current state of the CommunicationRequest.

no setter, inherited

subject → Reference?

subject The patient or group that is the focus of this communication request.

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

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