Class Subscription

The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system is able to take an appropriate action.

Inheritance
System.Object
Resource
DomainResource
Subscription
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class Subscription : DomainResource, IFhirJsonSerializable

Properties

| Improve this Doc View Source

_Criteria

Extension container element for Criteria

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

_End

Extension container element for End

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

_Error

Extension container element for Error

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

_Reason

Extension container element for Reason

Declaration
public Element _Reason { 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

Channel

Details where to send notifications when resources are received that meet the criteria.

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

Contact

Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

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

Criteria

The rules that the server should use to determine when to generate notifications for this subscription.

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

End

The time for the server to turn the subscription off.

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

Error

A record of the last error that occurred when the server processed a notification.

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

Reason

A description of why this subscription is defined.

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

ResourceType

Resource Type Name

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

Status

The status of the subscription, which marks the server state for managing the subscription.

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

Tag

A tag to add to any resource that matches the criteria, after the subscription is processed.

Declaration
public List<Coding> Tag { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Coding>

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