Appointment (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.Appointment

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Appointment
extends BaseResource
implements IResource
```
HAPI/FHIR Appointment Resource ((informative) A scheduled appointment for a patient and/or practitioner(s) where a service may take place)
Definition: A scheduled appointment for a patient and/or practitioner(s) where a service may take place.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Appointment

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Appointment.Participant` Block class for child element: Appointment.participant (List of participants involved in the appointment)

Field Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static Include`	`INCLUDE_PARTICIPANT_INDIVIDUAL` Constant for fluent queries to be used to add include statements.
`static TokenClientParam`	`PARTSTATUS` Fluent Client search parameter constant for partstatus
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_PARTSTATUS` Search parameter constant for partstatus
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static StringClientParam`	`STATUS` Fluent Client search parameter constant for status
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Appointment()

Constructors
Constructor and Description
`Appointment()`

Method Summary

Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (External Ids for this item)
`Appointment`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (External Ids for this item)
`Appointment`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (External Ids for this item)
`Appointment.Participant`	`addParticipant()` Adds and returns a new value for participant (List of participants involved in the appointment)
`ResourceReferenceDt`	`addSlot()` Adds and returns a new value for slot (The slot that this appointment is filling.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`StringDt`	`getComment()` Gets the value(s) for comment (Additional comments about the appointment).
`StringDt`	`getDescription()` Gets the value(s) for description (The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list.
`InstantDt`	`getEnd()` Gets the value(s) for end (Date/Time that the appointment is to conclude).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (External Ids for this item).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (External Ids for this item), creating it if it does not already exist.
`ResourceReferenceDt`	`getLocation()` Gets the value(s) for location (The primary location that this appointment is to take place).
`ResourceReferenceDt`	`getOrder()` Gets the value(s) for order (An Order that lead to the creation of this appointment).
`List<Appointment.Participant>`	`getParticipant()` Gets the value(s) for participant (List of participants involved in the appointment).
`Appointment.Participant`	`getParticipantFirstRep()` Gets the first repetition for participant (List of participants involved in the appointment), creating it if it does not already exist.
`IntegerDt`	`getPriority()` Gets the value(s) for priority (The priority of the appointment.
`DateTimeDt`	`getRecordedDate()` Gets the value(s) for recordedDate (Date when the sensitivity was recorded).
`ResourceReferenceDt`	`getRecorder()` Gets the value(s) for recorder (Who recorded the appointment).
`ScheduleDt`	`getSchedule()` Gets the value(s) for schedule (The recurrence schedule for the appointment.
`List<ResourceReferenceDt>`	`getSlot()` Gets the value(s) for slot (The slot that this appointment is filling.
`InstantDt`	`getStart()` Gets the value(s) for start (Date/Time that the appointment is to take place).
`CodeDt`	`getStatus()` Gets the value(s) for status (The overall status of the Appointment).
`StringDt`	`getTimezone()` Gets the value(s) for timezone (The timezone that the times are to be converted to.
`boolean`	`isEmpty()`
`Appointment`	`setComment(String theString)` Sets the value for comment (Additional comments about the appointment)
`Appointment`	`setComment(StringDt theValue)` Sets the value(s) for comment (Additional comments about the appointment)
`Appointment`	`setDescription(String theString)` Sets the value for description (The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list.
`Appointment`	`setDescription(StringDt theValue)` Sets the value(s) for description (The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list.
`Appointment`	`setEnd(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for end (Date/Time that the appointment is to conclude)
`Appointment`	`setEnd(InstantDt theValue)` Sets the value(s) for end (Date/Time that the appointment is to conclude)
`Appointment`	`setEndWithMillisPrecision(Date theDate)` Sets the value for end (Date/Time that the appointment is to conclude)
`Appointment`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (External Ids for this item)
`Appointment`	`setLocation(ResourceReferenceDt theValue)` Sets the value(s) for location (The primary location that this appointment is to take place)
`Appointment`	`setOrder(ResourceReferenceDt theValue)` Sets the value(s) for order (An Order that lead to the creation of this appointment)
`Appointment`	`setParticipant(List<Appointment.Participant> theValue)` Sets the value(s) for participant (List of participants involved in the appointment)
`Appointment`	`setPriority(int theInteger)` Sets the value for priority (The priority of the appointment.
`Appointment`	`setPriority(IntegerDt theValue)` Sets the value(s) for priority (The priority of the appointment.
`Appointment`	`setRecordedDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for recordedDate (Date when the sensitivity was recorded)
`Appointment`	`setRecordedDate(DateTimeDt theValue)` Sets the value(s) for recordedDate (Date when the sensitivity was recorded)
`Appointment`	`setRecordedDateWithSecondsPrecision(Date theDate)` Sets the value for recordedDate (Date when the sensitivity was recorded)
`Appointment`	`setRecorder(ResourceReferenceDt theValue)` Sets the value(s) for recorder (Who recorded the appointment)
`Appointment`	`setSchedule(ScheduleDt theValue)` Sets the value(s) for schedule (The recurrence schedule for the appointment.
`Appointment`	`setSlot(List<ResourceReferenceDt> theValue)` Sets the value(s) for slot (The slot that this appointment is filling.
`Appointment`	`setStart(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for start (Date/Time that the appointment is to take place)
`Appointment`	`setStart(InstantDt theValue)` Sets the value(s) for start (Date/Time that the appointment is to take place)
`Appointment`	`setStartWithMillisPrecision(Date theDate)` Sets the value for start (Date/Time that the appointment is to take place)
`Appointment`	`setStatus(CodeDt theValue)` Sets the value(s) for status (The overall status of the Appointment)
`Appointment`	`setStatus(String theCode)` Sets the value for status (The overall status of the Appointment)
`Appointment`	`setTimezone(String theString)` Sets the value for timezone (The timezone that the times are to be converted to.
`Appointment`	`setTimezone(StringDt theValue)` Sets the value(s) for timezone (The timezone that the times are to be converted to.

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description: Appointment date/time.
    Type: date
    Path: Appointment.start
    
    See Also:
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Appointment date/time.
    Type: date
    Path: Appointment.start
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description: The overall status of the appointment
    Type: string
    Path: Appointment.status
    
    See Also:
    Constant Field Values
  - STATUS
```
public static final StringClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: The overall status of the appointment
    Type: string
    Path: Appointment.status
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: The subject that the sensitivity is about
    Type: reference
    Path: Appointment.participant.individual
    
    See Also:
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The subject that the sensitivity is about
    Type: reference
    Path: Appointment.participant.individual
  - INCLUDE_PARTICIPANT_INDIVIDUAL
```
public static final Include INCLUDE_PARTICIPANT_INDIVIDUAL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment.participant.individual".
  - SP_PARTSTATUS
```
public static final String SP_PARTSTATUS
```
    Search parameter constant for partstatus
    Description: The Participation status of the subject, or other participant on the appointment
    Type: token
    Path: Appointment.participant.status
    
    See Also:
    Constant Field Values
  - PARTSTATUS
```
public static final TokenClientParam PARTSTATUS
```
    Fluent Client search parameter constant for partstatus
    Description: The Participation status of the subject, or other participant on the appointment
    Type: token
    Path: Appointment.participant.status
- Constructor Detail
  - Appointment
```
public Appointment()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (External Ids for this item). creating it if it does not exist. Will not return null.
    Definition: This records identifiers associated with this appointment concern that are defined by business processed 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<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (External Ids for this item)
    Definition: This records identifiers associated with this appointment concern that are defined by business processed 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 IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (External Ids for this item)
    Definition: This records identifiers associated with this appointment concern that are defined by business processed 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)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (External Ids for this item), creating it if it does not already exist.
    Definition: This records identifiers associated with this appointment concern that are defined by business processed 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(IdentifierUseEnum theUse,
                        String theSystem,
                        String theValue,
                        String theLabel)
```
    Adds a new value for identifier (External Ids for this item)
    Definition: This records identifiers associated with this appointment concern that are defined by business processed 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)
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public Appointment addIdentifier(String theSystem,
                        String theValue)
```
    Adds a new value for identifier (External Ids for this item)
    Definition: This records identifiers associated with this appointment concern that are defined by business processed 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)
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getPriority
```
public IntegerDt getPriority()
```
    Gets the value(s) for 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) (Need to change back to CodeableConcept)). creating it if it does not exist. Will not return null.
    Definition:
  - setPriority
```
public Appointment setPriority(IntegerDt theValue)
```
    Sets the value(s) for 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) (Need to change back to CodeableConcept))
    Definition:
  - setPriority
```
public Appointment setPriority(int theInteger)
```
    Sets the value for 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) (Need to change back to CodeableConcept))
    Definition:
  - getStatus
```
public CodeDt getStatus()
```
    Gets the value(s) for status (The overall status of the Appointment). creating it if it does not exist. Will not return null.
    Definition: 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(CodeDt theValue)
```
    Sets the value(s) for status (The overall status of the Appointment)
    Definition: 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(String theCode)
```
    Sets the value for status (The overall status of the Appointment)
    Definition: Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status
  - getDescription
```
public StringDt getDescription()
```
    Gets the value(s) for 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). creating it if it does not exist. Will not return null.
    Definition:
  - setDescription
```
public Appointment setDescription(StringDt theValue)
```
    Sets the value(s) for 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)
    Definition:
  - setDescription
```
public Appointment setDescription(String theString)
```
    Sets the value for 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)
    Definition:
  - getStart
```
public InstantDt getStart()
```
    Gets the value(s) for start (Date/Time that the appointment is to take place). creating it if it does not exist. Will not return null.
    Definition:
  - setStart
```
public Appointment setStart(InstantDt theValue)
```
    Sets the value(s) for start (Date/Time that the appointment is to take place)
    Definition:
  - setStart
```
public Appointment setStart(Date theDate,
                   TemporalPrecisionEnum thePrecision)
```
    Sets the value for start (Date/Time that the appointment is to take place)
    Definition:
  - setStartWithMillisPrecision
```
public Appointment setStartWithMillisPrecision(Date theDate)
```
    Sets the value for start (Date/Time that the appointment is to take place)
    Definition:
  - getEnd
```
public InstantDt getEnd()
```
    Gets the value(s) for end (Date/Time that the appointment is to conclude). creating it if it does not exist. Will not return null.
    Definition:
  - setEnd
```
public Appointment setEnd(InstantDt theValue)
```
    Sets the value(s) for end (Date/Time that the appointment is to conclude)
    Definition:
  - setEnd
```
public Appointment setEnd(Date theDate,
                 TemporalPrecisionEnum thePrecision)
```
    Sets the value for end (Date/Time that the appointment is to conclude)
    Definition:
  - setEndWithMillisPrecision
```
public Appointment setEndWithMillisPrecision(Date theDate)
```
    Sets the value for end (Date/Time that the appointment is to conclude)
    Definition:
  - getSchedule
```
public ScheduleDt getSchedule()
```
    Gets the value(s) for schedule (The recurrence schedule for the appointment. The end date in the schedule marks the end of the recurrence(s), not the end of an individual appointment). creating it if it does not exist. Will not return null.
    Definition:
  - setSchedule
```
public Appointment setSchedule(ScheduleDt theValue)
```
    Sets the value(s) for schedule (The recurrence schedule for the appointment. The end date in the schedule marks the end of the recurrence(s), not the end of an individual appointment)
    Definition:
  - getTimezone
```
public StringDt getTimezone()
```
    Gets the value(s) for timezone (The timezone that the times are to be converted to. Required for recurring appointments to remain accurate where the schedule makes the appointment cross a daylight saving boundry). creating it if it does not exist. Will not return null.
    Definition: The timezone should be a value referenced from a timezone database
  - setTimezone
```
public Appointment setTimezone(StringDt theValue)
```
    Sets the value(s) for timezone (The timezone that the times are to be converted to. Required for recurring appointments to remain accurate where the schedule makes the appointment cross a daylight saving boundry)
    Definition: The timezone should be a value referenced from a timezone database
  - setTimezone
```
public Appointment setTimezone(String theString)
```
    Sets the value for timezone (The timezone that the times are to be converted to. Required for recurring appointments to remain accurate where the schedule makes the appointment cross a daylight saving boundry)
    Definition: The timezone should be a value referenced from a timezone database
  - getSlot
```
public List<ResourceReferenceDt> getSlot()
```
    Gets the value(s) for 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). creating it if it does not exist. Will not return null.
    Definition:
  - setSlot
```
public Appointment setSlot(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for 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)
    Definition:
  - addSlot
```
public ResourceReferenceDt addSlot()
```
    Adds and returns a new value for 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)
    Definition:
  - getLocation
```
public ResourceReferenceDt getLocation()
```
    Gets the value(s) for location (The primary location that this appointment is to take place). creating it if it does not exist. Will not return null.
    Definition:
  - setLocation
```
public Appointment setLocation(ResourceReferenceDt theValue)
```
    Sets the value(s) for location (The primary location that this appointment is to take place)
    Definition:
  - getComment
```
public StringDt getComment()
```
    Gets the value(s) for comment (Additional comments about the appointment). creating it if it does not exist. Will not return null.
    Definition:
  - setComment
```
public Appointment setComment(StringDt theValue)
```
    Sets the value(s) for comment (Additional comments about the appointment)
    Definition:
  - setComment
```
public Appointment setComment(String theString)
```
    Sets the value for comment (Additional comments about the appointment)
    Definition:
  - getOrder
```
public ResourceReferenceDt getOrder()
```
    Gets the value(s) for order (An Order that lead to the creation of this appointment). creating it if it does not exist. Will not return null.
    Definition:
  - setOrder
```
public Appointment setOrder(ResourceReferenceDt theValue)
```
    Sets the value(s) for order (An Order that lead to the creation of this appointment)
    Definition:
  - getParticipant
```
public List<Appointment.Participant> getParticipant()
```
    Gets the value(s) for participant (List of participants involved in the appointment). creating it if it does not exist. Will not return null.
    Definition:
  - setParticipant
```
public Appointment setParticipant(List<Appointment.Participant> theValue)
```
    Sets the value(s) for participant (List of participants involved in the appointment)
    Definition:
  - addParticipant
```
public Appointment.Participant addParticipant()
```
    Adds and returns a new value for participant (List of participants involved in the appointment)
    Definition:
  - getParticipantFirstRep
```
public Appointment.Participant getParticipantFirstRep()
```
    Gets the first repetition for participant (List of participants involved in the appointment), creating it if it does not already exist.
    Definition:
  - getRecorder
```
public ResourceReferenceDt getRecorder()
```
    Gets the value(s) for recorder (Who recorded the appointment). creating it if it does not exist. Will not return null.
    Definition:
  - setRecorder
```
public Appointment setRecorder(ResourceReferenceDt theValue)
```
    Sets the value(s) for recorder (Who recorded the appointment)
    Definition:
  - getRecordedDate
```
public DateTimeDt getRecordedDate()
```
    Gets the value(s) for recordedDate (Date when the sensitivity was recorded). creating it if it does not exist. Will not return null.
    Definition:
  - setRecordedDate
```
public Appointment setRecordedDate(DateTimeDt theValue)
```
    Sets the value(s) for recordedDate (Date when the sensitivity was recorded)
    Definition:
  - setRecordedDateWithSecondsPrecision
```
public Appointment setRecordedDateWithSecondsPrecision(Date theDate)
```
    Sets the value for recordedDate (Date when the sensitivity was recorded)
    Definition:
  - setRecordedDate
```
public Appointment setRecordedDate(Date theDate,
                          TemporalPrecisionEnum thePrecision)
```
    Sets the value for recordedDate (Date when the sensitivity was recorded)
    Definition:

Class Appointment

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_DATE

DATE

SP_STATUS

STATUS

SP_SUBJECT

SUBJECT

INCLUDE_PARTICIPANT_INDIVIDUAL

SP_PARTSTATUS

PARTSTATUS

Constructor Detail

Appointment

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getPriority

setPriority

setPriority

getStatus

setStatus

setStatus

getDescription

setDescription

setDescription

getStart

setStart

setStart

setStartWithMillisPrecision

getEnd

setEnd

setEnd

setEndWithMillisPrecision

getSchedule

setSchedule

getTimezone

setTimezone

setTimezone

getSlot

setSlot

addSlot

getLocation

setLocation

getComment

setComment

setComment

getOrder

setOrder

getParticipant

setParticipant

addParticipant

getParticipantFirstRep

getRecorder

setRecorder

getRecordedDate

setRecordedDate

setRecordedDateWithSecondsPrecision

setRecordedDate