Class 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.
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class CommunicationRequest : DomainResource, IFhirJsonSerializable
Properties
| Improve this Doc View Source_RequestedOn
Extension container element for RequestedOn
Declaration
public Element _RequestedOn { get; set; }
Property Value
| Type | Description |
|---|---|
| Element |
_ScheduledDateTime
Extension container element for ScheduledDateTime
Declaration
public Element _ScheduledDateTime { get; set; }
Property Value
| Type | Description |
|---|---|
| Element |
_Status
Extension container element for Status
Declaration
public Element _Status { get; set; }
Property Value
| Type | Description |
|---|---|
| Element |
Category
The type of message to be sent such as alert, notification, reminder, instruction, etc.
Declaration
public CodeableConcept Category { get; set; }
Property Value
| Type | Description |
|---|---|
| CodeableConcept |
Encounter
The encounter within which the communication request was created.
Declaration
public Reference Encounter { get; set; }
Property Value
| Type | Description |
|---|---|
| Reference |
Identifier
A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
Declaration
public List<Identifier> Identifier { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<Identifier> |
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> |
Payload
Text, attachment(s), or resource(s) to be communicated to the recipient.
Declaration
public List<CommunicationRequestPayload> Payload { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<CommunicationRequestPayload> |
Priority
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
Declaration
public CodeableConcept Priority { get; set; }
Property Value
| Type | Description |
|---|---|
| CodeableConcept |
Reason
The reason or justification for the communication request.
Declaration
public List<CodeableConcept> Reason { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<CodeableConcept> |
Recipient
The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.
Declaration
public List<Reference> Recipient { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<Reference> |
RequestedOn
The time when the request was made.
Declaration
public string RequestedOn { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Requester
The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.
Declaration
public Reference Requester { get; set; }
Property Value
| Type | Description |
|---|---|
| Reference |
ResourceType
Resource Type Name
Declaration
public override string ResourceType { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
| Improve this Doc View SourceScheduledDateTime
The time when this communication is to occur.
Declaration
public string ScheduledDateTime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ScheduledPeriod
The time when this communication is to occur.
Declaration
public Period ScheduledPeriod { get; set; }
Property Value
| Type | Description |
|---|---|
| Period |
Sender
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
Declaration
public Reference Sender { get; set; }
Property Value
| Type | Description |
|---|---|
| Reference |
Status
The status of the proposal or order.
Declaration
public string Status { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Subject
The patient who is the focus of this communication request.
Declaration
public Reference Subject { get; set; }
Property Value
| Type | Description |
|---|---|
| Reference |
Methods
| Improve this Doc View SourceDeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)
Deserialize a JSON object
Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| Utf8JsonReader | reader | |
| JsonSerializerOptions | options |
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 |
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 |