AppointmentResponse (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.AppointmentResponse

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class AppointmentResponse
extends BaseResource
implements IResource
```
HAPI/FHIR AppointmentResponse Resource ()
Definition: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

Requirements:

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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`ACTOR` Fluent Client search parameter constant for actor
`static ReferenceClientParam`	`APPOINTMENT` Fluent Client search parameter constant for appointment
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_ACTOR` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_APPOINTMENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_LOCATION` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PRACTITIONER` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`LOCATION` Fluent Client search parameter constant for location
`static TokenClientParam`	`PART_STATUS` Fluent Client search parameter constant for part-status
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static ReferenceClientParam`	`PRACTITIONER` Fluent Client search parameter constant for practitioner
`static String`	`SP_ACTOR` Search parameter constant for actor
`static String`	`SP_APPOINTMENT` Search parameter constant for appointment
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_LOCATION` Search parameter constant for location
`static String`	`SP_PART_STATUS` Search parameter constant for part-status
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_PRACTITIONER` Search parameter constant for practitioner

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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

AppointmentResponse()

Constructors
Constructor and Description
`AppointmentResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`AppointmentResponse`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`BoundCodeableConceptDt<ParticipantTypeEnum>`	`addParticipantType()` Add a value for participantType ()
`BoundCodeableConceptDt<ParticipantTypeEnum>`	`addParticipantType(ParticipantTypeEnum theValue)` Add a value for participantType () using an enumerated type.
`ResourceReferenceDt`	`getActor()` Gets the value(s) for actor ().
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ResourceReferenceDt`	`getAppointment()` Gets the value(s) for appointment ().
`String`	`getComment()` Gets the value(s) for comment ().
`StringDt`	`getCommentElement()` Gets the value(s) for comment ().
`Date`	`getEnd()` Gets the value(s) for end ().
`InstantDt`	`getEndElement()` Gets the value(s) for end ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier ().
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (), creating it if it does not already exist.
`String`	`getParticipantStatus()` Gets the value(s) for participantStatus ().
`BoundCodeDt<ParticipantStatusEnum>`	`getParticipantStatusElement()` Gets the value(s) for participantStatus ().
`List<BoundCodeableConceptDt<ParticipantTypeEnum>>`	`getParticipantType()` Gets the value(s) for participantType ().
`BoundCodeableConceptDt<ParticipantTypeEnum>`	`getParticipantTypeFirstRep()` Gets the first repetition for participantType (), creating it if it does not already exist.
`String`	`getResourceName()`
`Date`	`getStart()` Gets the value(s) for start ().
`InstantDt`	`getStartElement()` Gets the value(s) for start ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`boolean`	`isEmpty()`
`AppointmentResponse`	`setActor(ResourceReferenceDt theValue)` Sets the value(s) for actor ()
`AppointmentResponse`	`setAppointment(ResourceReferenceDt theValue)` Sets the value(s) for appointment ()
`AppointmentResponse`	`setComment(String theString)` Sets the value for comment ()
`AppointmentResponse`	`setComment(StringDt theValue)` Sets the value(s) for comment ()
`AppointmentResponse`	`setEnd(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for end ()
`AppointmentResponse`	`setEnd(InstantDt theValue)` Sets the value(s) for end ()
`AppointmentResponse`	`setEndWithMillisPrecision(Date theDate)` Sets the value for end ()
`AppointmentResponse`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`AppointmentResponse`	`setParticipantStatus(BoundCodeDt<ParticipantStatusEnum> theValue)` Sets the value(s) for participantStatus ()
`AppointmentResponse`	`setParticipantStatus(ParticipantStatusEnum theValue)` Sets the value(s) for participantStatus ()
`AppointmentResponse`	`setParticipantType(List<BoundCodeableConceptDt<ParticipantTypeEnum>> theValue)` Sets the value(s) for participantType ()
`AppointmentResponse`	`setParticipantType(ParticipantTypeEnum theValue)` Sets the value(s), and clears any existing value(s) for participantType ()
`AppointmentResponse`	`setStart(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for start ()
`AppointmentResponse`	`setStart(InstantDt theValue)` Sets the value(s) for start ()
`AppointmentResponse`	`setStartWithMillisPrecision(Date theDate)` Sets the value for start ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, 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

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

- Field Detail
  - 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
  - SP_PART_STATUS
```
public static final String SP_PART_STATUS
```
    Search parameter constant for part-status
    Description: The participants acceptance status for this appointment
    Type: token
    Path: AppointmentResponse.participantStatus
    
    See Also:
    
    Constant Field Values
  - PART_STATUS
```
public static final TokenClientParam PART_STATUS
```
    Fluent Client search parameter constant for part-status
    Description: The participants acceptance status for this appointment
    Type: token
    Path: AppointmentResponse.participantStatus
  - SP_ACTOR
```
public static final String SP_ACTOR
```
    Search parameter constant for actor
    Description: The Person, Location/HealthcareService or Device that this appointment response replies for
    Type: reference
    Path: AppointmentResponse.actor
    
    See Also:
    
    Constant Field Values
  - ACTOR
```
public static final ReferenceClientParam ACTOR
```
    Fluent Client search parameter constant for actor
    Description: The Person, Location/HealthcareService or Device that this appointment response replies for
    Type: reference
    Path: AppointmentResponse.actor
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: This Response is for this Patient
    Type: reference
    Path: AppointmentResponse.actor
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: This Response is for this Patient
    Type: reference
    Path: AppointmentResponse.actor
  - SP_PRACTITIONER
```
public static final String SP_PRACTITIONER
```
    Search parameter constant for practitioner
    Description: This Response is for this Practitioner
    Type: reference
    Path: AppointmentResponse.actor
    
    See Also:
    
    Constant Field Values
  - PRACTITIONER
```
public static final ReferenceClientParam PRACTITIONER
```
    Fluent Client search parameter constant for practitioner
    Description: This Response is for this Practitioner
    Type: reference
    Path: AppointmentResponse.actor
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    Search parameter constant for location
    Description: This Response is for this Location
    Type: reference
    Path: AppointmentResponse.actor
    
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final ReferenceClientParam LOCATION
```
    Fluent Client search parameter constant for location
    Description: This Response is for this Location
    Type: reference
    Path: AppointmentResponse.actor
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: An Identifier in this appointment response
    Type: token
    Path: AppointmentResponse.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: An Identifier in this appointment response
    Type: token
    Path: AppointmentResponse.identifier
  - INCLUDE_ACTOR
```
public static final Include INCLUDE_ACTOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:actor".
  - 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".
  - INCLUDE_LOCATION
```
public static final Include INCLUDE_LOCATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:location".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:patient".
  - INCLUDE_PRACTITIONER
```
public static final Include INCLUDE_PRACTITIONER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:practitioner".
- Constructor Detail
  - AppointmentResponse
```
public AppointmentResponse()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: This records identifiers associated with this appointment response 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
  - setIdentifier
```
public AppointmentResponse setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier ()
    Definition: This records identifiers associated with this appointment response 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
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier ()
    Definition: This records identifiers associated with this appointment response 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
  - addIdentifier
```
public AppointmentResponse addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier ()
    Definition: This records identifiers associated with this appointment response 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
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (), creating it if it does not already exist.
    Definition: This records identifiers associated with this appointment response 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
  - getAppointment
```
public ResourceReferenceDt getAppointment()
```
    Gets the value(s) for appointment (). creating it if it does not exist. Will not return null.
    Definition:
  - setAppointment
```
public AppointmentResponse setAppointment(ResourceReferenceDt theValue)
```
    Sets the value(s) for appointment ()
    Definition:
  - getStartElement
```
public InstantDt getStartElement()
```
    Gets the value(s) for start (). creating it if it does not exist. Will not return null.
    Definition: Date/Time that the appointment is to take place, or requested new start time
  - getStart
```
public Date getStart()
```
    Gets the value(s) for start (). creating it if it does not exist. Will not return null.
    Definition: Date/Time that the appointment is to take place, or requested new start time
  - setStart
```
public AppointmentResponse setStart(InstantDt theValue)
```
    Sets the value(s) for start ()
    Definition: Date/Time that the appointment is to take place, or requested new start time
  - setStartWithMillisPrecision
```
public AppointmentResponse setStartWithMillisPrecision(Date theDate)
```
    Sets the value for start ()
    Definition: Date/Time that the appointment is to take place, or requested new start time
  - setStart
```
public AppointmentResponse setStart(Date theDate,
                                    TemporalPrecisionEnum thePrecision)
```
    Sets the value for start ()
    Definition: Date/Time that the appointment is to take place, or requested new start time
  - getEndElement
```
public InstantDt getEndElement()
```
    Gets the value(s) for end (). creating it if it does not exist. Will not return null.
    Definition: This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
  - getEnd
```
public Date getEnd()
```
    Gets the value(s) for end (). creating it if it does not exist. Will not return null.
    Definition: This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
  - setEnd
```
public AppointmentResponse setEnd(InstantDt theValue)
```
    Sets the value(s) for end ()
    Definition: This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
  - setEndWithMillisPrecision
```
public AppointmentResponse setEndWithMillisPrecision(Date theDate)
```
    Sets the value for end ()
    Definition: This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
  - setEnd
```
public AppointmentResponse setEnd(Date theDate,
                                  TemporalPrecisionEnum thePrecision)
```
    Sets the value for end ()
    Definition: This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
  - getParticipantType
```
public List<BoundCodeableConceptDt<ParticipantTypeEnum>> getParticipantType()
```
    Gets the value(s) for participantType (). creating it if it does not exist. Will not return null.
    Definition: Role of participant in the appointment
  - setParticipantType
```
public AppointmentResponse setParticipantType(List<BoundCodeableConceptDt<ParticipantTypeEnum>> theValue)
```
    Sets the value(s) for participantType ()
    Definition: Role of participant in the appointment
  - addParticipantType
```
public BoundCodeableConceptDt<ParticipantTypeEnum> addParticipantType(ParticipantTypeEnum theValue)
```
    Add a value for participantType () 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 addParticipantType() method.
    Definition: Role of participant in the appointment
  - getParticipantTypeFirstRep
```
public BoundCodeableConceptDt<ParticipantTypeEnum> getParticipantTypeFirstRep()
```
    Gets the first repetition for participantType (), creating it if it does not already exist.
    Definition: Role of participant in the appointment
  - addParticipantType
```
public BoundCodeableConceptDt<ParticipantTypeEnum> addParticipantType()
```
    Add a value for participantType ()
    Definition: Role of participant in the appointment
  - setParticipantType
```
public AppointmentResponse setParticipantType(ParticipantTypeEnum theValue)
```
    Sets the value(s), and clears any existing value(s) for participantType ()
    Definition: Role of participant in the appointment
  - getActor
```
public ResourceReferenceDt getActor()
```
    Gets the value(s) for actor (). creating it if it does not exist. Will not return null.
    Definition: A Person, Location/HealthcareService or Device that is participating in the appointment
  - setActor
```
public AppointmentResponse setActor(ResourceReferenceDt theValue)
```
    Sets the value(s) for actor ()
    Definition: A Person, Location/HealthcareService or Device that is participating in the appointment
  - getParticipantStatusElement
```
public BoundCodeDt<ParticipantStatusEnum> getParticipantStatusElement()
```
    Gets the value(s) for participantStatus (). creating it if it does not exist. Will not return null.
    Definition: Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
  - getParticipantStatus
```
public String getParticipantStatus()
```
    Gets the value(s) for participantStatus (). creating it if it does not exist. Will not return null.
    Definition: Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
  - setParticipantStatus
```
public AppointmentResponse setParticipantStatus(BoundCodeDt<ParticipantStatusEnum> theValue)
```
    Sets the value(s) for participantStatus ()
    Definition: Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
  - setParticipantStatus
```
public AppointmentResponse setParticipantStatus(ParticipantStatusEnum theValue)
```
    Sets the value(s) for participantStatus ()
    Definition: Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
  - getCommentElement
```
public StringDt getCommentElement()
```
    Gets the value(s) for comment (). creating it if it does not exist. Will not return null.
    Definition: Additional comments about the appointment
  - getComment
```
public String getComment()
```
    Gets the value(s) for comment (). creating it if it does not exist. Will not return null.
    Definition: Additional comments about the appointment
  - setComment
```
public AppointmentResponse setComment(StringDt theValue)
```
    Sets the value(s) for comment ()
    Definition: Additional comments about the appointment
  - setComment
```
public AppointmentResponse setComment(String theString)
```
    Sets the value for comment ()
    Definition: Additional comments about the appointment
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class AppointmentResponse

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.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

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

Field Detail

SP_APPOINTMENT

APPOINTMENT

SP_PART_STATUS

PART_STATUS

SP_ACTOR

ACTOR

SP_PATIENT

PATIENT

SP_PRACTITIONER

PRACTITIONER

SP_LOCATION

LOCATION

SP_IDENTIFIER

IDENTIFIER

INCLUDE_ACTOR

INCLUDE_APPOINTMENT

INCLUDE_LOCATION

INCLUDE_PATIENT

INCLUDE_PRACTITIONER

Constructor Detail

AppointmentResponse

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getAppointment

setAppointment

getStartElement

getStart

setStart

setStartWithMillisPrecision

setStart

getEndElement

getEnd

setEnd

setEndWithMillisPrecision

setEnd

getParticipantType

setParticipantType

addParticipantType

getParticipantTypeFirstRep

addParticipantType

setParticipantType

getActor

setActor

getParticipantStatusElement

getParticipantStatus

setParticipantStatus

setParticipantStatus

getCommentElement

getComment

setComment

setComment

getResourceName

getStructureFhirVersionEnum