Show / Hide Table of Contents

Class Communication

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.

Inheritance
System.Object
Resource
DomainResource
Communication
Implements
IFhirJsonSerializable
Inherited Members
DomainResource.Contained
DomainResource.Extension
DomainResource.ModifierExtension
DomainResource.Text
Resource.Id
Resource._Id
Resource.ImplicitRules
Resource._ImplicitRules
Resource.Language
Resource._Language
Resource.Meta
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class Communication : DomainResource, IFhirJsonSerializable

Properties

| Improve this Doc View Source

_Received

Extension container element for Received

Declaration
public Element _Received { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Sent

Extension container element for Sent

Declaration
public Element _Sent { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Status

Extension container element for Status

Declaration
public Element _Status { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

Category

The type of message conveyed such as alert, notification, reminder, instruction, etc.

Declaration
public CodeableConcept Category { get; set; }
Property Value
Type Description
CodeableConcept
| Improve this Doc View Source

Encounter

The encounter within which the communication was sent.

Declaration
public Reference Encounter { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

Identifier

Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Declaration
public List<Identifier> Identifier { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Identifier>
| Improve this Doc View Source

Medium

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

Declaration
public List<CodeableConcept> Medium { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<CodeableConcept>
| Improve this Doc View Source

Payload

Text, attachment(s), or resource(s) that was communicated to the recipient.

Declaration
public List<CommunicationPayload> Payload { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<CommunicationPayload>
| Improve this Doc View Source

Reason

The reason or justification for the communication.

Declaration
public List<CodeableConcept> Reason { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<CodeableConcept>
| Improve this Doc View Source

Received

The time when this communication arrived at the destination.

Declaration
public string Received { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Recipient

The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).

Declaration
public List<Reference> Recipient { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Reference>
| Improve this Doc View Source

RequestDetail

The communication request that was responsible for producing this communication.

Declaration
public Reference RequestDetail { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

ResourceType

Resource Type Name

Declaration
public override string ResourceType { get; }
Property Value
Type Description
System.String
Overrides
Resource.ResourceType
| Improve this Doc View Source

Sender

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

Declaration
public Reference Sender { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

Sent

The time when this communication was sent.

Declaration
public string Sent { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Status

The status of the transmission.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Subject

The patient who was the focus of this communication.

Declaration
public Reference Subject { get; set; }
Property Value
Type Description
Reference

Methods

| Improve this Doc View Source

DeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)

Deserialize a JSON object

Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
| Improve this Doc View Source

DeserializeJsonProperty(ref Utf8JsonReader, JsonSerializerOptions, String)

Deserialize a JSON property

Declaration
public void DeserializeJsonProperty(ref Utf8JsonReader reader, JsonSerializerOptions options, string propertyName)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
System.String propertyName
| Improve this Doc View Source

SerializeJson(Utf8JsonWriter, JsonSerializerOptions, Boolean)

Serialize to a JSON object

Declaration
public void SerializeJson(Utf8JsonWriter writer, JsonSerializerOptions options, bool includeStartObject = true)
Parameters
Type Name Description
Utf8JsonWriter writer
JsonSerializerOptions options
System.Boolean includeStartObject

Implements

IFhirJsonSerializable
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX