Appointment (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.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).
`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_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.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
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PRACTITIONER` Fluent Client search parameter constant for practitioner
`protected UnsignedIntType`	`priority` The priority of the appointment.
`protected CodeableConcept`	`reason` The reason that this appointment is being scheduled.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SERVICE_TYPE` Fluent Client search parameter constant for service-type
`protected CodeableConcept`	`serviceCategory` A broad categorisation 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 slot that this appointment is filling.
`protected List<Slot>`	`slotTarget` The actual objects that are the target of the reference (The slot that this appointment is filling.
`static String`	`SP_ACTOR` Search parameter: actor
`static String`	`SP_APPOINTMENT_TYPE` Search parameter: appointment-type
`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_SERVICE_TYPE` Search parameter: service-type
`static String`	`SP_STATUS` Search parameter: status
`protected List<CodeableConcept>`	`specialty` The specialty of a practitioner that would be required to perform the service requested in this appointment.
`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

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

Fields inherited from class org.hl7.fhir.dstu2016may.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
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Appointment`	`addIdentifier(Identifier t)`
`Appointment.AppointmentParticipantComponent`	`addParticipant()`
`Appointment`	`addParticipant(Appointment.AppointmentParticipantComponent t)`
`CodeableConcept`	`addServiceType()`
`Appointment`	`addServiceType(CodeableConcept t)`
`Reference`	`addSlot()`
`Appointment`	`addSlot(Reference t)`
`Slot`	`addSlotTarget()`
`CodeableConcept`	`addSpecialty()`
`Appointment`	`addSpecialty(CodeableConcept t)`
`Appointment`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`CodeableConcept`	`getAppointmentType()`
`String`	`getComment()`
`StringType`	`getCommentElement()`
`Date`	`getCreated()`
`DateTimeType`	`getCreatedElement()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`Date`	`getEnd()`
`InstantType`	`getEndElement()`
`List<Identifier>`	`getIdentifier()`
`int`	`getMinutesDuration()`
`PositiveIntType`	`getMinutesDurationElement()`
`List<Appointment.AppointmentParticipantComponent>`	`getParticipant()`
`int`	`getPriority()`
`UnsignedIntType`	`getPriorityElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`CodeableConcept`	`getReason()`
`ResourceType`	`getResourceType()`
`CodeableConcept`	`getServiceCategory()`
`List<CodeableConcept>`	`getServiceType()`
`List<Reference>`	`getSlot()`
`List<Slot>`	`getSlotTarget()`
`List<CodeableConcept>`	`getSpecialty()`
`Date`	`getStart()`
`InstantType`	`getStartElement()`
`Appointment.AppointmentStatus`	`getStatus()`
`Enumeration<Appointment.AppointmentStatus>`	`getStatusElement()`
`boolean`	`hasAppointmentType()`
`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`	`hasPriority()`
`boolean`	`hasPriorityElement()`
`boolean`	`hasReason()`
`boolean`	`hasServiceCategory()`
`boolean`	`hasServiceType()`
`boolean`	`hasSlot()`
`boolean`	`hasSpecialty()`
`boolean`	`hasStart()`
`boolean`	`hasStartElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Appointment`	`setAppointmentType(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`	`setMinutesDuration(int value)`
`Appointment`	`setMinutesDurationElement(PositiveIntType value)`
`Appointment`	`setPriority(int value)`
`Appointment`	`setPriorityElement(UnsignedIntType value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`Appointment`	`setReason(CodeableConcept value)`
`Appointment`	`setServiceCategory(CodeableConcept value)`
`Appointment`	`setStart(Date value)`
`Appointment`	`setStartElement(InstantType value)`
`Appointment`	`setStatus(Appointment.AppointmentStatus value)`
`Appointment`	`setStatusElement(Enumeration<Appointment.AppointmentStatus> value)`
`protected Appointment`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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.
  - serviceCategory
```
protected CodeableConcept serviceCategory
```
    A broad categorisation 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).
  - reason
```
protected CodeableConcept reason
```
    The reason that this appointment is being scheduled. This is more clinical than administrative.
  - 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.
  - 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 (where actual time of appointment is only an estimate or is a planned appointment request).
  - slot
```
protected List<Reference> 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.
  - slotTarget
```
protected List<Slot> slotTarget
```
    The actual objects that are the target of the reference (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.)
  - 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.
  - participant
```
protected List<Appointment.AppointmentParticipantComponent> participant
```
    List of participants involved in the appointment.
  - 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_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_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_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
  - 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_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_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_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
- 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).)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    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).)
  - addIdentifier
```
public Appointment addIdentifier(Identifier t)
```
  - 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.
  - getServiceCategory
```
public CodeableConcept getServiceCategory()
```
    Returns:
    
    serviceCategory (A broad categorisation of the service that is to be performed during this appointment.)
  - hasServiceCategory
```
public boolean hasServiceCategory()
```
  - setServiceCategory
```
public Appointment setServiceCategory(CodeableConcept value)
```
    Parameters:
    
    value - serviceCategory (A broad categorisation of the service that is to be performed during this appointment.)
  - getServiceType
```
public List<CodeableConcept> getServiceType()
```
    Returns:
    
    serviceType (The specific service that is to be performed during this appointment.)
  - hasServiceType
```
public boolean hasServiceType()
```
  - addServiceType
```
public CodeableConcept addServiceType()
```
    Returns:
    
    serviceType (The specific service that is to be performed during this appointment.)
  - addServiceType
```
public Appointment addServiceType(CodeableConcept t)
```
  - getSpecialty
```
public List<CodeableConcept> getSpecialty()
```
    Returns:
    
    specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)
  - hasSpecialty
```
public boolean hasSpecialty()
```
  - addSpecialty
```
public CodeableConcept addSpecialty()
```
    Returns:
    
    specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)
  - addSpecialty
```
public Appointment addSpecialty(CodeableConcept t)
```
  - 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).)
  - getReason
```
public CodeableConcept getReason()
```
    Returns:
    
    reason (The reason that this appointment is being scheduled. This is more clinical than administrative.)
  - hasReason
```
public boolean hasReason()
```
  - setReason
```
public Appointment setReason(CodeableConcept value)
```
    Parameters:
    
    value - reason (The reason that this appointment is being scheduled. This is more clinical than administrative.)
  - 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.
  - 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 (where actual time of appointment is only an estimate or is a planned appointment request).). 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 (where actual time of appointment is only an estimate or is a planned appointment request).). 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 (where actual time of appointment is only an estimate or is a planned appointment request).
  - 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 (where actual time of appointment is only an estimate or is a planned appointment request).
  - getSlot
```
public List<Reference> getSlot()
```
    Returns:
    
    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.)
  - hasSlot
```
public boolean hasSlot()
```
  - addSlot
```
public Reference addSlot()
```
    Returns:
    
    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.)
  - addSlot
```
public Appointment addSlot(Reference t)
```
  - getSlotTarget
```
public List<Slot> getSlotTarget()
```
    Returns:
    
    slot (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.)
  - addSlotTarget
```
public Slot addSlotTarget()
```
    Returns:
    
    slot (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. 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.)
  - 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.
  - getParticipant
```
public List<Appointment.AppointmentParticipantComponent> getParticipant()
```
    Returns:
    
    participant (List of participants involved in the appointment.)
  - hasParticipant
```
public boolean hasParticipant()
```
  - addParticipant
```
public Appointment.AppointmentParticipantComponent addParticipant()
```
    Returns:
    
    participant (List of participants involved in the appointment.)
  - addParticipant
```
public Appointment addParticipant(Appointment.AppointmentParticipantComponent t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - 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 void 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 void 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
  - 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()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Appointment copy()
```
    Specified by:
    
    copy in class DomainResource
  - 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.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.DomainResource

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.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

serviceCategory

serviceType

specialty

appointmentType

reason

priority

description

start

end

minutesDuration

slot

slotTarget

created

comment

participant

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_SERVICE_TYPE

SERVICE_TYPE

SP_PRACTITIONER

PRACTITIONER

INCLUDE_PRACTITIONER

SP_LOCATION

LOCATION

INCLUDE_LOCATION

SP_STATUS

STATUS

SP_APPOINTMENT_TYPE

APPOINTMENT_TYPE

SP_PART_STATUS

PART_STATUS

SP_ACTOR

ACTOR

INCLUDE_ACTOR

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

Constructor Detail

Appointment

Appointment

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getServiceCategory

hasServiceCategory

setServiceCategory

getServiceType

hasServiceType

addServiceType

addServiceType