Show / Hide Table of Contents

Class Appointment

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Inheritance
System.Object
Resource
DomainResource
Appointment
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 Appointment : DomainResource, IFhirJsonSerializable

Properties

| Improve this Doc View Source

_Comment

Extension container element for Comment

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

_Description

Extension container element for Description

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

_Start

Extension container element for Start

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

Comment

Additional comments about the appointment.

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

Description

The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

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

End

Date/Time that the appointment is to conclude.

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

Identifier

This records identifiers associated with this appointment concern 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

MinutesDuration

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).

Declaration
public uint? MinutesDuration { get; set; }
Property Value
Type Description
System.Nullable<System.UInt32>
| Improve this Doc View Source

Participant

List of participants involved in the appointment.

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

Priority

The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

Declaration
public uint? Priority { get; set; }
Property Value
Type Description
System.Nullable<System.UInt32>
| Improve this Doc View Source

Reason

The reason that this appointment is being scheduled. This is more clinical than administrative.

Declaration
public CodeableConcept Reason { get; set; }
Property Value
Type Description
CodeableConcept
| 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

Slot

The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.

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

Start

Date/Time that the appointment is to take place.

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

Status

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

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

Type

The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService).

Declaration
public CodeableConcept Type { get; set; }
Property Value
Type Description
CodeableConcept

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