Appointment (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.model.Appointment

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Appointment
extends DomainResource
```
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).

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Appointment.AppointmentParticipantComponent`
`static class`	`Appointment.AppointmentStatus`
`static class`	`Appointment.AppointmentStatusEnumFactory`
`static class`	`Appointment.ParticipantRequired`
`static class`	`Appointment.ParticipantRequiredEnumFactory`
`static class`	`Appointment.ParticipationStatus`
`static class`	`Appointment.ParticipationStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ACTOR` Fluent Client search parameter constant for actor
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`APPOINTMENT_TYPE` Fluent Client search parameter constant for appointment-type
`protected CodeableConcept`	`appointmentType` The style of appointment or patient that has been booked in the slot (not service type).
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`BASED_ON` Fluent Client search parameter constant for based-on
`protected List<Reference>`	`basedOn` The service request this appointment is allocated to assess (e.g.
`protected List<ServiceRequest>`	`basedOnTarget` The actual objects that are the target of the reference (The service request this appointment is allocated to assess (e.g.
`protected CodeableConcept`	`cancelationReason` The coded reason for the appointment being cancelled.
`protected StringType`	`comment` Additional comments about the appointment.
`protected DateTimeType`	`created` The date that this appointment was initially created.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`protected StringType`	`description` The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list.
`protected InstantType`	`end` Date/Time that the appointment is to conclude.
`protected List<Identifier>`	`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ACTOR` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_BASED_ON` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_LOCATION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PRACTITIONER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_REASON_REFERENCE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SLOT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUPPORTING_INFO` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`LOCATION` Fluent Client search parameter constant for location
`protected PositiveIntType`	`minutesDuration` Number of minutes that the appointment is to take.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`PART_STATUS` Fluent Client search parameter constant for part-status
`protected List<Appointment.AppointmentParticipantComponent>`	`participant` List of participants involved in the appointment.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected StringType`	`patientInstruction` While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PRACTITIONER` Fluent Client search parameter constant for practitioner
`protected UnsignedIntType`	`priority` The priority of the appointment.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`REASON_CODE` Fluent Client search parameter constant for reason-code
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`REASON_REFERENCE` Fluent Client search parameter constant for reason-reference
`protected List<CodeableConcept>`	`reasonCode` The coded reason that this appointment is being scheduled.
`protected List<Reference>`	`reasonReference` Reason the appointment has been scheduled to take place, as specified using information from another resource.
`protected List<Resource>`	`reasonReferenceTarget` The actual objects that are the target of the reference (Reason the appointment has been scheduled to take place, as specified using information from another resource.
`protected List<Period>`	`requestedPeriod` A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SERVICE_CATEGORY` Fluent Client search parameter constant for service-category
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SERVICE_TYPE` Fluent Client search parameter constant for service-type
`protected List<CodeableConcept>`	`serviceCategory` A broad categorization of the service that is to be performed during this appointment.
`protected List<CodeableConcept>`	`serviceType` The specific service that is to be performed during this appointment.
`protected List<Reference>`	`slot` The slots from the participants' schedules that will be filled by the appointment.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SLOT` Fluent Client search parameter constant for slot
`protected List<Slot>`	`slotTarget` The actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.)
`static String`	`SP_ACTOR` Search parameter: actor
`static String`	`SP_APPOINTMENT_TYPE` Search parameter: appointment-type
`static String`	`SP_BASED_ON` Search parameter: based-on
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_LOCATION` Search parameter: location
`static String`	`SP_PART_STATUS` Search parameter: part-status
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_PRACTITIONER` Search parameter: practitioner
`static String`	`SP_REASON_CODE` Search parameter: reason-code
`static String`	`SP_REASON_REFERENCE` Search parameter: reason-reference
`static String`	`SP_SERVICE_CATEGORY` Search parameter: service-category
`static String`	`SP_SERVICE_TYPE` Search parameter: service-type
`static String`	`SP_SLOT` Search parameter: slot
`static String`	`SP_SPECIALTY` Search parameter: specialty
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_SUPPORTING_INFO` Search parameter: supporting-info
`protected List<CodeableConcept>`	`specialty` The specialty of a practitioner that would be required to perform the service requested in this appointment.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SPECIALTY` Fluent Client search parameter constant for specialty
`protected InstantType`	`start` Date/Time that the appointment is to take place.
`protected Enumeration<Appointment.AppointmentStatus>`	`status` The overall status of the Appointment.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUPPORTING_INFO` Fluent Client search parameter constant for supporting-info
`protected List<Reference>`	`supportingInformation` Additional information to support the appointment provided when making the appointment.
`protected List<Resource>`	`supportingInformationTarget` The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.)

Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Appointment()
Constructor

Appointment(Enumeration<Appointment.AppointmentStatus> status)
Constructor

Constructors
Constructor and Description
`Appointment()` Constructor
`Appointment(Enumeration<Appointment.AppointmentStatus> status)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Reference`	`addBasedOn()`
`Appointment`	`addBasedOn(Reference t)`
`ServiceRequest`	`addBasedOnTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Appointment`	`addIdentifier(Identifier t)`
`Appointment.AppointmentParticipantComponent`	`addParticipant()`
`Appointment`	`addParticipant(Appointment.AppointmentParticipantComponent t)`
`CodeableConcept`	`addReasonCode()`
`Appointment`	`addReasonCode(CodeableConcept t)`
`Reference`	`addReasonReference()`
`Appointment`	`addReasonReference(Reference t)`
`Period`	`addRequestedPeriod()`
`Appointment`	`addRequestedPeriod(Period t)`
`CodeableConcept`	`addServiceCategory()`
`Appointment`	`addServiceCategory(CodeableConcept t)`
`CodeableConcept`	`addServiceType()`
`Appointment`	`addServiceType(CodeableConcept t)`
`Reference`	`addSlot()`
`Appointment`	`addSlot(Reference t)`
`Slot`	`addSlotTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`CodeableConcept`	`addSpecialty()`
`Appointment`	`addSpecialty(CodeableConcept t)`
`Reference`	`addSupportingInformation()`
`Appointment`	`addSupportingInformation(Reference t)`
`Appointment`	`copy()`
`void`	`copyValues(Appointment dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`CodeableConcept`	`getAppointmentType()`
`List<Reference>`	`getBasedOn()`
`Reference`	`getBasedOnFirstRep()`
`List<ServiceRequest>`	`getBasedOnTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`CodeableConcept`	`getCancelationReason()`
`String`	`getComment()`
`StringType`	`getCommentElement()`
`Date`	`getCreated()`
`DateTimeType`	`getCreatedElement()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`Date`	`getEnd()`
`InstantType`	`getEndElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`int`	`getMinutesDuration()`
`PositiveIntType`	`getMinutesDurationElement()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<Appointment.AppointmentParticipantComponent>`	`getParticipant()`
`Appointment.AppointmentParticipantComponent`	`getParticipantFirstRep()`
`String`	`getPatientInstruction()`
`StringType`	`getPatientInstructionElement()`
`int`	`getPriority()`
`UnsignedIntType`	`getPriorityElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<CodeableConcept>`	`getReasonCode()`
`CodeableConcept`	`getReasonCodeFirstRep()`
`List<Reference>`	`getReasonReference()`
`Reference`	`getReasonReferenceFirstRep()`
`List<Resource>`	`getReasonReferenceTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<Period>`	`getRequestedPeriod()`
`Period`	`getRequestedPeriodFirstRep()`
`ResourceType`	`getResourceType()`
`List<CodeableConcept>`	`getServiceCategory()`
`CodeableConcept`	`getServiceCategoryFirstRep()`
`List<CodeableConcept>`	`getServiceType()`
`CodeableConcept`	`getServiceTypeFirstRep()`
`List<Reference>`	`getSlot()`
`Reference`	`getSlotFirstRep()`
`List<Slot>`	`getSlotTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<CodeableConcept>`	`getSpecialty()`
`CodeableConcept`	`getSpecialtyFirstRep()`
`Date`	`getStart()`
`InstantType`	`getStartElement()`
`Appointment.AppointmentStatus`	`getStatus()`
`Enumeration<Appointment.AppointmentStatus>`	`getStatusElement()`
`List<Reference>`	`getSupportingInformation()`
`Reference`	`getSupportingInformationFirstRep()`
`List<Resource>`	`getSupportingInformationTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAppointmentType()`
`boolean`	`hasBasedOn()`
`boolean`	`hasCancelationReason()`
`boolean`	`hasComment()`
`boolean`	`hasCommentElement()`
`boolean`	`hasCreated()`
`boolean`	`hasCreatedElement()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasEnd()`
`boolean`	`hasEndElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasMinutesDuration()`
`boolean`	`hasMinutesDurationElement()`
`boolean`	`hasParticipant()`
`boolean`	`hasPatientInstruction()`
`boolean`	`hasPatientInstructionElement()`
`boolean`	`hasPriority()`
`boolean`	`hasPriorityElement()`
`boolean`	`hasReasonCode()`
`boolean`	`hasReasonReference()`
`boolean`	`hasRequestedPeriod()`
`boolean`	`hasServiceCategory()`
`boolean`	`hasServiceType()`
`boolean`	`hasSlot()`
`boolean`	`hasSpecialty()`
`boolean`	`hasStart()`
`boolean`	`hasStartElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSupportingInformation()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Appointment`	`setAppointmentType(CodeableConcept value)`
`Appointment`	`setBasedOn(List<Reference> theBasedOn)`
`Appointment`	`setCancelationReason(CodeableConcept value)`
`Appointment`	`setComment(String value)`
`Appointment`	`setCommentElement(StringType value)`
`Appointment`	`setCreated(Date value)`
`Appointment`	`setCreatedElement(DateTimeType value)`
`Appointment`	`setDescription(String value)`
`Appointment`	`setDescriptionElement(StringType value)`
`Appointment`	`setEnd(Date value)`
`Appointment`	`setEndElement(InstantType value)`
`Appointment`	`setIdentifier(List<Identifier> theIdentifier)`
`Appointment`	`setMinutesDuration(int value)`
`Appointment`	`setMinutesDurationElement(PositiveIntType value)`
`Appointment`	`setParticipant(List<Appointment.AppointmentParticipantComponent> theParticipant)`
`Appointment`	`setPatientInstruction(String value)`
`Appointment`	`setPatientInstructionElement(StringType value)`
`Appointment`	`setPriority(int value)`
`Appointment`	`setPriorityElement(UnsignedIntType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Appointment`	`setReasonCode(List<CodeableConcept> theReasonCode)`
`Appointment`	`setReasonReference(List<Reference> theReasonReference)`
`Appointment`	`setRequestedPeriod(List<Period> theRequestedPeriod)`
`Appointment`	`setServiceCategory(List<CodeableConcept> theServiceCategory)`
`Appointment`	`setServiceType(List<CodeableConcept> theServiceType)`
`Appointment`	`setSlot(List<Reference> theSlot)`
`Appointment`	`setSpecialty(List<CodeableConcept> theSpecialty)`
`Appointment`	`setStart(Date value)`
`Appointment`	`setStartElement(InstantType value)`
`Appointment`	`setStatus(Appointment.AppointmentStatus value)`
`Appointment`	`setStatusElement(Enumeration<Appointment.AppointmentStatus> value)`
`Appointment`	`setSupportingInformation(List<Reference> theSupportingInformation)`
`protected Appointment`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> 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).
  - status
```
protected Enumeration<Appointment.AppointmentStatus> 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.
  - cancelationReason
```
protected CodeableConcept cancelationReason
```
    The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
  - serviceCategory
```
protected List<CodeableConcept> serviceCategory
```
    A broad categorization of the service that is to be performed during this appointment.
  - serviceType
```
protected List<CodeableConcept> serviceType
```
    The specific service that is to be performed during this appointment.
  - specialty
```
protected List<CodeableConcept> specialty
```
    The specialty of a practitioner that would be required to perform the service requested in this appointment.
  - appointmentType
```
protected CodeableConcept appointmentType
```
    The style of appointment or patient that has been booked in the slot (not service type).
  - reasonCode
```
protected List<CodeableConcept> reasonCode
```
    The coded reason that this appointment is being scheduled. This is more clinical than administrative.
  - reasonReference
```
protected List<Reference> reasonReference
```
    Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
  - reasonReferenceTarget
```
protected List<Resource> reasonReferenceTarget
```
    The actual objects that are the target of the reference (Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
  - priority
```
protected UnsignedIntType 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).
  - description
```
protected StringType 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.
  - supportingInformation
```
protected List<Reference> supportingInformation
```
    Additional information to support the appointment provided when making the appointment.
  - supportingInformationTarget
```
protected List<Resource> supportingInformationTarget
```
    The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.)
  - start
```
protected InstantType start
```
    Date/Time that the appointment is to take place.
  - end
```
protected InstantType end
```
    Date/Time that the appointment is to conclude.
  - minutesDuration
```
protected PositiveIntType minutesDuration
```
    Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
  - slot
```
protected List<Reference> slot
```
    The slots from the participants' schedules that will be filled by the appointment.
  - slotTarget
```
protected List<Slot> slotTarget
```
    The actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.)
  - created
```
protected DateTimeType created
```
    The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
  - comment
```
protected StringType comment
```
    Additional comments about the appointment.
  - patientInstruction
```
protected StringType patientInstruction
```
    While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
  - basedOn
```
protected List<Reference> basedOn
```
    The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
  - basedOnTarget
```
protected List<ServiceRequest> basedOnTarget
```
    The actual objects that are the target of the reference (The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).)
  - participant
```
protected List<Appointment.AppointmentParticipantComponent> participant
```
    List of participants involved in the appointment.
  - requestedPeriod
```
protected List<Period> requestedPeriod
```
    A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Appointment date/time.
    Type: date
    Path: Appointment.start
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Appointment date/time.
    Type: date
    Path: Appointment.start
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: An Identifier of the Appointment
    Type: token
    Path: Appointment.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: An Identifier of the Appointment
    Type: token
    Path: Appointment.identifier
  - SP_SPECIALTY
```
public static final String SP_SPECIALTY
```
    Search parameter: specialty
    Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
    Type: token
    Path: Appointment.specialty
    
    See Also:
    
    Constant Field Values
  - SPECIALTY
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIALTY
```
    Fluent Client search parameter constant for specialty
    Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
    Type: token
    Path: Appointment.specialty
  - SP_SERVICE_CATEGORY
```
public static final String SP_SERVICE_CATEGORY
```
    Search parameter: service-category
    Description: A broad categorization of the service that is to be performed during this appointment
    Type: token
    Path: Appointment.serviceCategory
    
    See Also:
    
    Constant Field Values
  - SERVICE_CATEGORY
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_CATEGORY
```
    Fluent Client search parameter constant for service-category
    Description: A broad categorization of the service that is to be performed during this appointment
    Type: token
    Path: Appointment.serviceCategory
  - SP_PRACTITIONER
```
public static final String SP_PRACTITIONER
```
    Search parameter: practitioner
    Description: One of the individuals of the appointment is this practitioner
    Type: reference
    Path: Appointment.participant.actor
    
    See Also:
    
    Constant Field Values
  - PRACTITIONER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
```
    Fluent Client search parameter constant for practitioner
    Description: One of the individuals of the appointment is this practitioner
    Type: reference
    Path: Appointment.participant.actor
  - INCLUDE_PRACTITIONER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:practitioner".
  - SP_PART_STATUS
```
public static final String SP_PART_STATUS
```
    Search parameter: part-status
    Description: The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
    Type: token
    Path: Appointment.participant.status
    
    See Also:
    
    Constant Field Values
  - PART_STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PART_STATUS
```
    Fluent Client search parameter constant for part-status
    Description: The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
    Type: token
    Path: Appointment.participant.status
  - SP_APPOINTMENT_TYPE
```
public static final String SP_APPOINTMENT_TYPE
```
    Search parameter: appointment-type
    Description: The style of appointment or patient that has been booked in the slot (not service type)
    Type: token
    Path: Appointment.appointmentType
    
    See Also:
    
    Constant Field Values
  - APPOINTMENT_TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam APPOINTMENT_TYPE
```
    Fluent Client search parameter constant for appointment-type
    Description: The style of appointment or patient that has been booked in the slot (not service type)
    Type: token
    Path: Appointment.appointmentType
  - SP_SERVICE_TYPE
```
public static final String SP_SERVICE_TYPE
```
    Search parameter: service-type
    Description: The specific service that is to be performed during this appointment
    Type: token
    Path: Appointment.serviceType
    
    See Also:
    
    Constant Field Values
  - SERVICE_TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_TYPE
```
    Fluent Client search parameter constant for service-type
    Description: The specific service that is to be performed during this appointment
    Type: token
    Path: Appointment.serviceType
  - SP_SLOT
```
public static final String SP_SLOT
```
    Search parameter: slot
    Description: The slots that this appointment is filling
    Type: reference
    Path: Appointment.slot
    
    See Also:
    
    Constant Field Values
  - SLOT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SLOT
```
    Fluent Client search parameter constant for slot
    Description: The slots that this appointment is filling
    Type: reference
    Path: Appointment.slot
  - INCLUDE_SLOT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SLOT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:slot".
  - SP_REASON_CODE
```
public static final String SP_REASON_CODE
```
    Search parameter: reason-code
    Description: Coded reason this appointment is scheduled
    Type: token
    Path: Appointment.reasonCode
    
    See Also:
    
    Constant Field Values
  - REASON_CODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_CODE
```
    Fluent Client search parameter constant for reason-code
    Description: Coded reason this appointment is scheduled
    Type: token
    Path: Appointment.reasonCode
  - SP_ACTOR
```
public static final String SP_ACTOR
```
    Search parameter: actor
    Description: Any one of the individuals participating in the appointment
    Type: reference
    Path: Appointment.participant.actor
    
    See Also:
    
    Constant Field Values
  - ACTOR
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACTOR
```
    Fluent Client search parameter constant for actor
    Description: Any one of the individuals participating in the appointment
    Type: reference
    Path: Appointment.participant.actor
  - INCLUDE_ACTOR
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:actor".
  - SP_BASED_ON
```
public static final String SP_BASED_ON
```
    Search parameter: based-on
    Description: The service request this appointment is allocated to assess
    Type: reference
    Path: Appointment.basedOn
    
    See Also:
    
    Constant Field Values
  - BASED_ON
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
```
    Fluent Client search parameter constant for based-on
    Description: The service request this appointment is allocated to assess
    Type: reference
    Path: Appointment.basedOn
  - INCLUDE_BASED_ON
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:based-on".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: One of the individuals of the appointment is this patient
    Type: reference
    Path: Appointment.participant.actor
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: One of the individuals of the appointment is this patient
    Type: reference
    Path: Appointment.participant.actor
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:patient".
  - SP_REASON_REFERENCE
```
public static final String SP_REASON_REFERENCE
```
    Search parameter: reason-reference
    Description: Reason the appointment is to take place (resource)
    Type: reference
    Path: Appointment.reasonReference
    
    See Also:
    
    Constant Field Values
  - REASON_REFERENCE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REASON_REFERENCE
```
    Fluent Client search parameter constant for reason-reference
    Description: Reason the appointment is to take place (resource)
    Type: reference
    Path: Appointment.reasonReference
  - INCLUDE_REASON_REFERENCE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_REASON_REFERENCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:reason-reference".
  - SP_SUPPORTING_INFO
```
public static final String SP_SUPPORTING_INFO
```
    Search parameter: supporting-info
    Description: Additional information to support the appointment
    Type: reference
    Path: Appointment.supportingInformation
    
    See Also:
    
    Constant Field Values
  - SUPPORTING_INFO
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPORTING_INFO
```
    Fluent Client search parameter constant for supporting-info
    Description: Additional information to support the appointment
    Type: reference
    Path: Appointment.supportingInformation
  - INCLUDE_SUPPORTING_INFO
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPORTING_INFO
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:supporting-info".
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    Search parameter: location
    Description: This location is listed in the participants of the appointment
    Type: reference
    Path: Appointment.participant.actor
    
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
```
    Fluent Client search parameter constant for location
    Description: This location is listed in the participants of the appointment
    Type: reference
    Path: Appointment.participant.actor
  - INCLUDE_LOCATION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:location".
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: The overall status of the appointment
    Type: token
    Path: Appointment.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: The overall status of the appointment
    Type: token
    Path: Appointment.status
- Constructor Detail
  - Appointment
```
public Appointment()
```
    Constructor
  - Appointment
```
public Appointment(Enumeration<Appointment.AppointmentStatus> status)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    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).)
  - setIdentifier
```
public Appointment setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Appointment addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getStatusElement
```
public Enumeration<Appointment.AppointmentStatus> getStatusElement()
```
    Returns:
    
    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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Appointment setStatusElement(Enumeration<Appointment.AppointmentStatus> value)
```
    Parameters:
    
    value - 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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Appointment.AppointmentStatus getStatus()
```
    Returns:
    
    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.
  - setStatus
```
public Appointment setStatus(Appointment.AppointmentStatus value)
```
    Parameters:
    
    value - 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.
  - getCancelationReason
```
public CodeableConcept getCancelationReason()
```
    Returns:
    
    cancelationReason (The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.)
  - hasCancelationReason
```
public boolean hasCancelationReason()
```
  - setCancelationReason
```
public Appointment setCancelationReason(CodeableConcept value)
```
    Parameters:
    
    value - cancelationReason (The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.)
  - getServiceCategory
```
public List<CodeableConcept> getServiceCategory()
```
    Returns:
    
    serviceCategory (A broad categorization of the service that is to be performed during this appointment.)
  - setServiceCategory
```
public Appointment setServiceCategory(List<CodeableConcept> theServiceCategory)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasServiceCategory
```
public boolean hasServiceCategory()
```
  - addServiceCategory
```
public CodeableConcept addServiceCategory()
```
  - addServiceCategory
```
public Appointment addServiceCategory(CodeableConcept t)
```
  - getServiceCategoryFirstRep
```
public CodeableConcept getServiceCategoryFirstRep()
```
    Returns:
    
    The first repetition of repeating field serviceCategory, creating it if it does not already exist
  - getServiceType
```
public List<CodeableConcept> getServiceType()
```
    Returns:
    
    serviceType (The specific service that is to be performed during this appointment.)
  - setServiceType
```
public Appointment setServiceType(List<CodeableConcept> theServiceType)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasServiceType
```
public boolean hasServiceType()
```
  - addServiceType
```
public CodeableConcept addServiceType()
```
  - addServiceType
```
public Appointment addServiceType(CodeableConcept t)
```
  - getServiceTypeFirstRep
```
public CodeableConcept getServiceTypeFirstRep()
```
    Returns:
    
    The first repetition of repeating field serviceType, creating it if it does not already exist
  - getSpecialty
```
public List<CodeableConcept> getSpecialty()
```
    Returns:
    
    specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)
  - setSpecialty
```
public Appointment setSpecialty(List<CodeableConcept> theSpecialty)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSpecialty
```
public boolean hasSpecialty()
```
  - addSpecialty
```
public CodeableConcept addSpecialty()
```
  - addSpecialty
```
public Appointment addSpecialty(CodeableConcept t)
```
  - getSpecialtyFirstRep
```
public CodeableConcept getSpecialtyFirstRep()
```
    Returns:
    
    The first repetition of repeating field specialty, creating it if it does not already exist
  - getAppointmentType
```
public CodeableConcept getAppointmentType()
```
    Returns:
    
    appointmentType (The style of appointment or patient that has been booked in the slot (not service type).)
  - hasAppointmentType
```
public boolean hasAppointmentType()
```
  - setAppointmentType
```
public Appointment setAppointmentType(CodeableConcept value)
```
    Parameters:
    
    value - appointmentType (The style of appointment or patient that has been booked in the slot (not service type).)
  - getReasonCode
```
public List<CodeableConcept> getReasonCode()
```
    Returns:
    
    reasonCode (The coded reason that this appointment is being scheduled. This is more clinical than administrative.)
  - setReasonCode
```
public Appointment setReasonCode(List<CodeableConcept> theReasonCode)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReasonCode
```
public boolean hasReasonCode()
```
  - addReasonCode
```
public CodeableConcept addReasonCode()
```
  - addReasonCode
```
public Appointment addReasonCode(CodeableConcept t)
```
  - getReasonCodeFirstRep
```
public CodeableConcept getReasonCodeFirstRep()
```
    Returns:
    
    The first repetition of repeating field reasonCode, creating it if it does not already exist
  - getReasonReference
```
public List<Reference> getReasonReference()
```
    Returns:
    
    reasonReference (Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
  - setReasonReference
```
public Appointment setReasonReference(List<Reference> theReasonReference)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReasonReference
```
public boolean hasReasonReference()
```
  - addReasonReference
```
public Reference addReasonReference()
```
  - addReasonReference
```
public Appointment addReasonReference(Reference t)
```
  - getReasonReferenceFirstRep
```
public Reference getReasonReferenceFirstRep()
```
    Returns:
    
    The first repetition of repeating field reasonReference, creating it if it does not already exist
  - getReasonReferenceTarget
```
@Deprecated
public List<Resource> getReasonReferenceTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getPriorityElement
```
public UnsignedIntType getPriorityElement()
```
    Returns:
    
    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).). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
  - hasPriorityElement
```
public boolean hasPriorityElement()
```
  - hasPriority
```
public boolean hasPriority()
```
  - setPriorityElement
```
public Appointment setPriorityElement(UnsignedIntType value)
```
    Parameters:
    
    value - 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).). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
  - getPriority
```
public int getPriority()
```
    Returns:
    
    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).
  - setPriority
```
public Appointment setPriority(int value)
```
    Parameters:
    
    value - 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).
  - getDescriptionElement
```
public StringType getDescriptionElement()
```
    Returns:
    
    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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
  - hasDescription
```
public boolean hasDescription()
```
  - setDescriptionElement
```
public Appointment setDescriptionElement(StringType value)
```
    Parameters:
    
    value - 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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Returns:
    
    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.
  - setDescription
```
public Appointment setDescription(String value)
```
    Parameters:
    
    value - 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.
  - getSupportingInformation
```
public List<Reference> getSupportingInformation()
```
    Returns:
    
    supportingInformation (Additional information to support the appointment provided when making the appointment.)
  - setSupportingInformation
```
public Appointment setSupportingInformation(List<Reference> theSupportingInformation)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSupportingInformation
```
public boolean hasSupportingInformation()
```
  - addSupportingInformation
```
public Reference addSupportingInformation()
```
  - addSupportingInformation
```
public Appointment addSupportingInformation(Reference t)
```
  - getSupportingInformationFirstRep
```
public Reference getSupportingInformationFirstRep()
```
    Returns:
    
    The first repetition of repeating field supportingInformation, creating it if it does not already exist
  - getSupportingInformationTarget
```
@Deprecated
public List<Resource> getSupportingInformationTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getStartElement
```
public InstantType getStartElement()
```
    Returns:
    
    start (Date/Time that the appointment is to take place.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value
  - hasStartElement
```
public boolean hasStartElement()
```
  - hasStart
```
public boolean hasStart()
```
  - setStartElement
```
public Appointment setStartElement(InstantType value)
```
    Parameters:
    
    value - start (Date/Time that the appointment is to take place.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value
  - getStart
```
public Date getStart()
```
    Returns:
    
    Date/Time that the appointment is to take place.
  - setStart
```
public Appointment setStart(Date value)
```
    Parameters:
    
    value - Date/Time that the appointment is to take place.
  - getEndElement
```
public InstantType getEndElement()
```
    Returns:
    
    end (Date/Time that the appointment is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value
  - hasEndElement
```
public boolean hasEndElement()
```
  - hasEnd
```
public boolean hasEnd()
```
  - setEndElement
```
public Appointment setEndElement(InstantType value)
```
    Parameters:
    
    value - end (Date/Time that the appointment is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value
  - getEnd
```
public Date getEnd()
```
    Returns:
    
    Date/Time that the appointment is to conclude.
  - setEnd
```
public Appointment setEnd(Date value)
```
    Parameters:
    
    value - Date/Time that the appointment is to conclude.
  - getMinutesDurationElement
```
public PositiveIntType getMinutesDurationElement()
```
    Returns:
    
    minutesDuration (Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the value
  - hasMinutesDurationElement
```
public boolean hasMinutesDurationElement()
```
  - hasMinutesDuration
```
public boolean hasMinutesDuration()
```
  - setMinutesDurationElement
```
public Appointment setMinutesDurationElement(PositiveIntType value)
```
    Parameters:
    
    value - minutesDuration (Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the value
  - getMinutesDuration
```
public int getMinutesDuration()
```
    Returns:
    
    Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
  - setMinutesDuration
```
public Appointment setMinutesDuration(int value)
```
    Parameters:
    
    value - Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
  - getSlot
```
public List<Reference> getSlot()
```
    Returns:
    
    slot (The slots from the participants' schedules that will be filled by the appointment.)
  - setSlot
```
public Appointment setSlot(List<Reference> theSlot)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSlot
```
public boolean hasSlot()
```
  - addSlot
```
public Reference addSlot()
```
  - addSlot
```
public Appointment addSlot(Reference t)
```
  - getSlotFirstRep
```
public Reference getSlotFirstRep()
```
    Returns:
    
    The first repetition of repeating field slot, creating it if it does not already exist
  - getSlotTarget
```
@Deprecated
public List<Slot> getSlotTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addSlotTarget
```
@Deprecated
public Slot addSlotTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getCreatedElement
```
public DateTimeType getCreatedElement()
```
    Returns:
    
    created (The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
  - hasCreatedElement
```
public boolean hasCreatedElement()
```
  - hasCreated
```
public boolean hasCreated()
```
  - setCreatedElement
```
public Appointment setCreatedElement(DateTimeType value)
```
    Parameters:
    
    value - created (The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
  - getCreated
```
public Date getCreated()
```
    Returns:
    
    The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
  - setCreated
```
public Appointment setCreated(Date value)
```
    Parameters:
    
    value - The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
  - getCommentElement
```
public StringType getCommentElement()
```
    Returns:
    
    comment (Additional comments about the appointment.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
  - hasCommentElement
```
public boolean hasCommentElement()
```
  - hasComment
```
public boolean hasComment()
```
  - setCommentElement
```
public Appointment setCommentElement(StringType value)
```
    Parameters:
    
    value - comment (Additional comments about the appointment.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
  - getComment
```
public String getComment()
```
    Returns:
    
    Additional comments about the appointment.
  - setComment
```
public Appointment setComment(String value)
```
    Parameters:
    
    value - Additional comments about the appointment.
  - getPatientInstructionElement
```
public StringType getPatientInstructionElement()
```
    Returns:
    
    patientInstruction (While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
  - hasPatientInstructionElement
```
public boolean hasPatientInstructionElement()
```
  - hasPatientInstruction
```
public boolean hasPatientInstruction()
```
  - setPatientInstructionElement
```
public Appointment setPatientInstructionElement(StringType value)
```
    Parameters:
    
    value - patientInstruction (While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
  - getPatientInstruction
```
public String getPatientInstruction()
```
    Returns:
    
    While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
  - setPatientInstruction
```
public Appointment setPatientInstruction(String value)
```
    Parameters:
    
    value - While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
  - getBasedOn
```
public List<Reference> getBasedOn()
```
    Returns:
    
    basedOn (The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).)
  - setBasedOn
```
public Appointment setBasedOn(List<Reference> theBasedOn)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasBasedOn
```
public boolean hasBasedOn()
```
  - addBasedOn
```
public Reference addBasedOn()
```
  - addBasedOn
```
public Appointment addBasedOn(Reference t)
```
  - getBasedOnFirstRep
```
public Reference getBasedOnFirstRep()
```
    Returns:
    
    The first repetition of repeating field basedOn, creating it if it does not already exist
  - getBasedOnTarget
```
@Deprecated
public List<ServiceRequest> getBasedOnTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addBasedOnTarget
```
@Deprecated
public ServiceRequest addBasedOnTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getParticipant
```
public List<Appointment.AppointmentParticipantComponent> getParticipant()
```
    Returns:
    
    participant (List of participants involved in the appointment.)
  - setParticipant
```
public Appointment setParticipant(List<Appointment.AppointmentParticipantComponent> theParticipant)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasParticipant
```
public boolean hasParticipant()
```
  - addParticipant
```
public Appointment.AppointmentParticipantComponent addParticipant()
```
  - addParticipant
```
public Appointment addParticipant(Appointment.AppointmentParticipantComponent t)
```
  - getParticipantFirstRep
```
public Appointment.AppointmentParticipantComponent getParticipantFirstRep()
```
    Returns:
    
    The first repetition of repeating field participant, creating it if it does not already exist
  - getRequestedPeriod
```
public List<Period> getRequestedPeriod()
```
    Returns:
    
    requestedPeriod (A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.)
  - setRequestedPeriod
```
public Appointment setRequestedPeriod(List<Period> theRequestedPeriod)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasRequestedPeriod
```
public boolean hasRequestedPeriod()
```
  - addRequestedPeriod
```
public Period addRequestedPeriod()
```
  - addRequestedPeriod
```
public Appointment addRequestedPeriod(Period t)
```
  - getRequestedPeriodFirstRep
```
public Period getRequestedPeriodFirstRep()
```
    Returns:
    
    The first repetition of repeating field requestedPeriod, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Appointment copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(Appointment dst)
```
  - typedCopy
```
protected Appointment typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Appointment

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

Fields inherited from class org.hl7.fhir.r4.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

Methods inherited from class org.hl7.fhir.r4.model.Resource

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

status

cancelationReason

serviceCategory

serviceType

specialty

appointmentType

reasonCode

reasonReference

reasonReferenceTarget

priority

description

supportingInformation

supportingInformationTarget

start

end

minutesDuration

slot

slotTarget

created

comment

patientInstruction

basedOn

basedOnTarget

participant

requestedPeriod

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_SPECIALTY

SPECIALTY

SP_SERVICE_CATEGORY

SERVICE_CATEGORY

SP_PRACTITIONER

PRACTITIONER

INCLUDE_PRACTITIONER

SP_PART_STATUS

PART_STATUS

SP_APPOINTMENT_TYPE

APPOINTMENT_TYPE

SP_SERVICE_TYPE

SERVICE_TYPE

SP_SLOT

SLOT

INCLUDE_SLOT

SP_REASON_CODE

REASON_CODE

SP_ACTOR

ACTOR

INCLUDE_ACTOR

SP_BASED_ON

BASED_ON

INCLUDE_BASED_ON

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_REASON_REFERENCE

REASON_REFERENCE

INCLUDE_REASON_REFERENCE

SP_SUPPORTING_INFO

SUPPORTING_INFO