AppointmentResponse (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.AppointmentResponse

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class AppointmentResponse
extends BaseResource
implements IResource
```
HAPI/FHIR AppointmentResponse Resource ((informative) A response to a scheduled appointment for a patient and/or practitioner(s))
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/AppointmentResponse

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`APPOINTMENT` Fluent Client search parameter constant for appointment
`static Include`	`INCLUDE_APPOINTMENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_INDIVIDUAL` Constant for fluent queries to be used to add include statements.
`static StringClientParam`	`PARTSTATUS` Fluent Client search parameter constant for partstatus
`static String`	`SP_APPOINTMENT` Search parameter constant for appointment
`static String`	`SP_PARTSTATUS` Search parameter constant for partstatus
`static String`	`SP_SUBJECT` Search parameter constant for subject
`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

AppointmentResponse()

Constructors
Constructor and Description
`AppointmentResponse()`

Method Summary

Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (External Ids for this item)
`AppointmentResponse`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (External Ids for this item)
`AppointmentResponse`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (External Ids for this item)
`ResourceReferenceDt`	`addIndividual()` Adds and returns a new value for individual (A Person of device that is participating in the appointment)
`BoundCodeableConceptDt<ParticipantTypeEnum>`	`addParticipantType()` Add a value for participantType (Role of participant in the appointment)
`BoundCodeableConceptDt<ParticipantTypeEnum>`	`addParticipantType(ParticipantTypeEnum theValue)` Add a value for participantType (Role of participant in the appointment) using an enumerated type.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`ResourceReferenceDt`	`getAppointment()` Gets the value(s) for appointment (Parent appointment that this response is replying to).
`StringDt`	`getComment()` Gets the value(s) for comment (Additional comments about the appointment).
`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.
`List<ResourceReferenceDt>`	`getIndividual()` Gets the value(s) for individual (A Person of device that is participating in the appointment).
`CodeDt`	`getParticipantStatus()` Gets the value(s) for participantStatus (accepted \| declined \| tentative \| in-process \| completed \| needs-action).
`List<BoundCodeableConceptDt<ParticipantTypeEnum>>`	`getParticipantType()` Gets the value(s) for participantType (Role of participant in the appointment).
`BoundCodeableConceptDt<ParticipantTypeEnum>`	`getParticipantTypeFirstRep()` Gets the first repetition for participantType (Role of participant in the appointment), creating it if it does not already exist.
`DateTimeDt`	`getRecordedDate()` Gets the value(s) for recordedDate (Date when the response was recorded or last updated).
`ResourceReferenceDt`	`getRecorder()` Gets the value(s) for recorder (Who recorded the appointment response).
`ScheduleDt`	`getSchedule()` Gets the value(s) for schedule (The recurrence schedule for the appointment.
`InstantDt`	`getStart()` Gets the value(s) for start (Date/Time that the appointment is to take place).
`StringDt`	`getTimezone()` Gets the value(s) for timezone (The timezone that the times are to be converted to.
`boolean`	`isEmpty()`
`AppointmentResponse`	`setAppointment(ResourceReferenceDt theValue)` Sets the value(s) for appointment (Parent appointment that this response is replying to)
`AppointmentResponse`	`setComment(String theString)` Sets the value for comment (Additional comments about the appointment)
`AppointmentResponse`	`setComment(StringDt theValue)` Sets the value(s) for comment (Additional comments about the appointment)
`AppointmentResponse`	`setEnd(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for end (Date/Time that the appointment is to conclude)
`AppointmentResponse`	`setEnd(InstantDt theValue)` Sets the value(s) for end (Date/Time that the appointment is to conclude)
`AppointmentResponse`	`setEndWithMillisPrecision(Date theDate)` Sets the value for end (Date/Time that the appointment is to conclude)
`AppointmentResponse`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (External Ids for this item)
`AppointmentResponse`	`setIndividual(List<ResourceReferenceDt> theValue)` Sets the value(s) for individual (A Person of device that is participating in the appointment)
`AppointmentResponse`	`setParticipantStatus(CodeDt theValue)` Sets the value(s) for participantStatus (accepted \| declined \| tentative \| in-process \| completed \| needs-action)
`AppointmentResponse`	`setParticipantStatus(String theCode)` Sets the value for participantStatus (accepted \| declined \| tentative \| in-process \| completed \| needs-action)
`AppointmentResponse`	`setParticipantType(List<BoundCodeableConceptDt<ParticipantTypeEnum>> theValue)` Sets the value(s) for participantType (Role of participant in the appointment)
`AppointmentResponse`	`setParticipantType(ParticipantTypeEnum theValue)` Sets the value(s), and clears any existing value(s) for participantType (Role of participant in the appointment)
`AppointmentResponse`	`setRecordedDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for recordedDate (Date when the response was recorded or last updated)
`AppointmentResponse`	`setRecordedDate(DateTimeDt theValue)` Sets the value(s) for recordedDate (Date when the response was recorded or last updated)
`AppointmentResponse`	`setRecordedDateWithSecondsPrecision(Date theDate)` Sets the value for recordedDate (Date when the response was recorded or last updated)
`AppointmentResponse`	`setRecorder(ResourceReferenceDt theValue)` Sets the value(s) for recorder (Who recorded the appointment response)
`AppointmentResponse`	`setSchedule(ScheduleDt theValue)` Sets the value(s) for schedule (The recurrence schedule for the appointment.
`AppointmentResponse`	`setStart(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for start (Date/Time that the appointment is to take place)
`AppointmentResponse`	`setStart(InstantDt theValue)` Sets the value(s) for start (Date/Time that the appointment is to take place)
`AppointmentResponse`	`setStartWithMillisPrecision(Date theDate)` Sets the value for start (Date/Time that the appointment is to take place)
`AppointmentResponse`	`setTimezone(String theString)` Sets the value for timezone (The timezone that the times are to be converted to.
`AppointmentResponse`	`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_PARTSTATUS
```
public static final String SP_PARTSTATUS
```
    Search parameter constant for partstatus
    Description: The overall status of the appointment
    Type: string
    Path: AppointmentResponse.participantStatus
    
    See Also:
    Constant Field Values
  - PARTSTATUS
```
public static final StringClientParam PARTSTATUS
```
    Fluent Client search parameter constant for partstatus
    Description: The overall status of the appointment
    Type: string
    Path: AppointmentResponse.participantStatus
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: The subject that the appointment response replies for
    Type: reference
    Path: AppointmentResponse.individual
    
    See Also:
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The subject that the appointment response replies for
    Type: reference
    Path: AppointmentResponse.individual
  - INCLUDE_INDIVIDUAL
```
public static final Include INCLUDE_INDIVIDUAL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse.individual".
  - SP_APPOINTMENT
```
public static final String SP_APPOINTMENT
```
    Search parameter constant for appointment
    Description: The appointment that the response is attached to
    Type: reference
    Path: AppointmentResponse.appointment
    
    See Also:
    Constant Field Values
  - APPOINTMENT
```
public static final ReferenceClientParam APPOINTMENT
```
    Fluent Client search parameter constant for appointment
    Description: The appointment that the response is attached to
    Type: reference
    Path: AppointmentResponse.appointment
  - INCLUDE_APPOINTMENT
```
public static final Include INCLUDE_APPOINTMENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse.appointment".
- Constructor Detail
  - AppointmentResponse
```
public AppointmentResponse()
```
- 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 AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse 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.
  - getAppointment
```
public ResourceReferenceDt getAppointment()
```
    Gets the value(s) for appointment (Parent appointment that this response is replying to). creating it if it does not exist. Will not return null.
    Definition:
  - setAppointment
```
public AppointmentResponse setAppointment(ResourceReferenceDt theValue)
```
    Sets the value(s) for appointment (Parent appointment that this response is replying to)
    Definition:
  - getParticipantType
```
public List<BoundCodeableConceptDt<ParticipantTypeEnum>> getParticipantType()
```
    Gets the value(s) for participantType (Role of participant in the appointment). creating it if it does not exist. Will not return null.
    Definition:
  - setParticipantType
```
public AppointmentResponse setParticipantType(List<BoundCodeableConceptDt<ParticipantTypeEnum>> theValue)
```
    Sets the value(s) for participantType (Role of participant in the appointment)
    Definition:
  - addParticipantType
```
public BoundCodeableConceptDt<ParticipantTypeEnum> addParticipantType(ParticipantTypeEnum theValue)
```
    Add a value for participantType (Role of participant in the appointment) using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the #addType() method.
    Definition:
  - getParticipantTypeFirstRep
```
public BoundCodeableConceptDt<ParticipantTypeEnum> getParticipantTypeFirstRep()
```
    Gets the first repetition for participantType (Role of participant in the appointment), creating it if it does not already exist.
    Definition:
  - addParticipantType
```
public BoundCodeableConceptDt<ParticipantTypeEnum> addParticipantType()
```
    Add a value for participantType (Role of participant in the appointment)
    Definition:
  - setParticipantType
```
public AppointmentResponse setParticipantType(ParticipantTypeEnum theValue)
```
    Sets the value(s), and clears any existing value(s) for participantType (Role of participant in the appointment)
    Definition:
  - getIndividual
```
public List<ResourceReferenceDt> getIndividual()
```
    Gets the value(s) for individual (A Person of device that is participating in the appointment). creating it if it does not exist. Will not return null.
    Definition:
  - setIndividual
```
public AppointmentResponse setIndividual(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for individual (A Person of device that is participating in the appointment)
    Definition:
  - addIndividual
```
public ResourceReferenceDt addIndividual()
```
    Adds and returns a new value for individual (A Person of device that is participating in the appointment)
    Definition:
  - getParticipantStatus
```
public CodeDt getParticipantStatus()
```
    Gets the value(s) for participantStatus (accepted | declined | tentative | in-process | completed | needs-action). creating it if it does not exist. Will not return null.
    Definition: Participation status of the Patient
  - setParticipantStatus
```
public AppointmentResponse setParticipantStatus(CodeDt theValue)
```
    Sets the value(s) for participantStatus (accepted | declined | tentative | in-process | completed | needs-action)
    Definition: Participation status of the Patient
  - setParticipantStatus
```
public AppointmentResponse setParticipantStatus(String theCode)
```
    Sets the value for participantStatus (accepted | declined | tentative | in-process | completed | needs-action)
    Definition: Participation status of the Patient
  - 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 AppointmentResponse setComment(StringDt theValue)
```
    Sets the value(s) for comment (Additional comments about the appointment)
    Definition:
  - setComment
```
public AppointmentResponse setComment(String theString)
```
    Sets the value for comment (Additional comments about the appointment)
    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 AppointmentResponse setStart(InstantDt theValue)
```
    Sets the value(s) for start (Date/Time that the appointment is to take place)
    Definition:
  - setStart
```
public AppointmentResponse setStart(Date theDate,
                           TemporalPrecisionEnum thePrecision)
```
    Sets the value for start (Date/Time that the appointment is to take place)
    Definition:
  - setStartWithMillisPrecision
```
public AppointmentResponse 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 AppointmentResponse setEnd(InstantDt theValue)
```
    Sets the value(s) for end (Date/Time that the appointment is to conclude)
    Definition:
  - setEnd
```
public AppointmentResponse setEnd(Date theDate,
                         TemporalPrecisionEnum thePrecision)
```
    Sets the value for end (Date/Time that the appointment is to conclude)
    Definition:
  - setEndWithMillisPrecision
```
public AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse 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
  - getRecorder
```
public ResourceReferenceDt getRecorder()
```
    Gets the value(s) for recorder (Who recorded the appointment response). creating it if it does not exist. Will not return null.
    Definition:
  - setRecorder
```
public AppointmentResponse setRecorder(ResourceReferenceDt theValue)
```
    Sets the value(s) for recorder (Who recorded the appointment response)
    Definition:
  - getRecordedDate
```
public DateTimeDt getRecordedDate()
```
    Gets the value(s) for recordedDate (Date when the response was recorded or last updated). creating it if it does not exist. Will not return null.
    Definition:
  - setRecordedDate
```
public AppointmentResponse setRecordedDate(DateTimeDt theValue)
```
    Sets the value(s) for recordedDate (Date when the response was recorded or last updated)
    Definition:
  - setRecordedDateWithSecondsPrecision
```
public AppointmentResponse setRecordedDateWithSecondsPrecision(Date theDate)
```
    Sets the value for recordedDate (Date when the response was recorded or last updated)
    Definition:
  - setRecordedDate
```
public AppointmentResponse setRecordedDate(Date theDate,
                                  TemporalPrecisionEnum thePrecision)
```
    Sets the value for recordedDate (Date when the response was recorded or last updated)
    Definition:

Class AppointmentResponse

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_PARTSTATUS

PARTSTATUS

SP_SUBJECT

SUBJECT

INCLUDE_INDIVIDUAL

SP_APPOINTMENT

APPOINTMENT

INCLUDE_APPOINTMENT

Constructor Detail

AppointmentResponse

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getAppointment

setAppointment

getParticipantType

setParticipantType

addParticipantType

getParticipantTypeFirstRep

addParticipantType

setParticipantType

getIndividual

setIndividual

addIndividual

getParticipantStatus

setParticipantStatus

setParticipantStatus

getComment

setComment

setComment

getStart

setStart

setStart

setStartWithMillisPrecision

getEnd

setEnd

setEnd

setEndWithMillisPrecision

getSchedule

setSchedule

getTimezone

setTimezone

setTimezone

getRecorder

setRecorder

getRecordedDate

setRecordedDate

setRecordedDateWithSecondsPrecision

setRecordedDate