AppointmentResponse (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.AppointmentResponse

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 AppointmentResponse
extends DomainResource
```
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AppointmentResponse.ParticipantStatus

static class AppointmentResponse.ParticipantStatusEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`AppointmentResponse.ParticipantStatus`
`static class`	`AppointmentResponse.ParticipantStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Reference`	`actor` A Person, Location/HealthcareService or Device that is participating in the appointment.
`protected Resource`	`actorTarget` The actual object that is the target of the reference (A Person, Location/HealthcareService or Device that is participating in the appointment.)
`protected Reference`	`appointment` Appointment that this response is replying to.
`protected Appointment`	`appointmentTarget` The actual object that is the target of the reference (Appointment that this response is replying to.)
`protected StringType`	`comment` Additional comments about the appointment.
`protected InstantType`	`end` 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.
`protected List<Identifier>`	`identifier` 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.
`protected Enumeration<AppointmentResponse.ParticipantStatus>`	`participantStatus` Participation status of the participant.
`protected List<CodeableConcept>`	`participantType` Role of participant in the appointment.
`static String`	`SP_ACTOR`
`static String`	`SP_APPOINTMENT`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_LOCATION`
`static String`	`SP_PARTSTATUS`
`static String`	`SP_PATIENT`
`static String`	`SP_PRACTITIONER`
`protected InstantType`	`start` Date/Time that the appointment is to take place, or requested new start time.

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

Fields inherited from class org.hl7.fhir.instance.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
`AppointmentResponse()`
`AppointmentResponse(Reference appointment, Enumeration<AppointmentResponse.ParticipantStatus> participantStatus)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`AppointmentResponse`	`addIdentifier(Identifier t)`
`CodeableConcept`	`addParticipantType()`
`AppointmentResponse`	`addParticipantType(CodeableConcept t)`
`AppointmentResponse`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Reference`	`getActor()`
`Resource`	`getActorTarget()`
`Reference`	`getAppointment()`
`Appointment`	`getAppointmentTarget()`
`String`	`getComment()`
`StringType`	`getCommentElement()`
`Date`	`getEnd()`
`InstantType`	`getEndElement()`
`List<Identifier>`	`getIdentifier()`
`AppointmentResponse.ParticipantStatus`	`getParticipantStatus()`
`Enumeration<AppointmentResponse.ParticipantStatus>`	`getParticipantStatusElement()`
`List<CodeableConcept>`	`getParticipantType()`
`ResourceType`	`getResourceType()`
`Date`	`getStart()`
`InstantType`	`getStartElement()`
`boolean`	`hasActor()`
`boolean`	`hasAppointment()`
`boolean`	`hasComment()`
`boolean`	`hasCommentElement()`
`boolean`	`hasEnd()`
`boolean`	`hasEndElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasParticipantStatus()`
`boolean`	`hasParticipantStatusElement()`
`boolean`	`hasParticipantType()`
`boolean`	`hasStart()`
`boolean`	`hasStartElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`AppointmentResponse`	`setActor(Reference value)`
`AppointmentResponse`	`setActorTarget(Resource value)`
`AppointmentResponse`	`setAppointment(Reference value)`
`AppointmentResponse`	`setAppointmentTarget(Appointment value)`
`AppointmentResponse`	`setComment(String value)`
`AppointmentResponse`	`setCommentElement(StringType value)`
`AppointmentResponse`	`setEnd(Date value)`
`AppointmentResponse`	`setEndElement(InstantType value)`
`AppointmentResponse`	`setParticipantStatus(AppointmentResponse.ParticipantStatus value)`
`AppointmentResponse`	`setParticipantStatusElement(Enumeration<AppointmentResponse.ParticipantStatus> value)`
`void`	`setProperty(String name, Base value)`
`AppointmentResponse`	`setStart(Date value)`
`AppointmentResponse`	`setStartElement(InstantType value)`
`protected AppointmentResponse`	`typedCopy()`

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

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

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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 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.
  - appointment
```
protected Reference appointment
```
    Appointment that this response is replying to.
  - appointmentTarget
```
protected Appointment appointmentTarget
```
    The actual object that is the target of the reference (Appointment that this response is replying to.)
  - start
```
protected InstantType start
```
    Date/Time that the appointment is to take place, or requested new start time.
  - end
```
protected InstantType end
```
    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.
  - participantType
```
protected List<CodeableConcept> participantType
```
    Role of participant in the appointment.
  - actor
```
protected Reference actor
```
    A Person, Location/HealthcareService or Device that is participating in the appointment.
  - actorTarget
```
protected Resource actorTarget
```
    The actual object that is the target of the reference (A Person, Location/HealthcareService or Device that is participating in the appointment.)
  - participantStatus
```
protected Enumeration<AppointmentResponse.ParticipantStatus> participantStatus
```
    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.
  - comment
```
protected StringType comment
```
    Additional comments about the appointment.
  - SP_ACTOR
```
public static final String SP_ACTOR
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_PRACTITIONER
```
public static final String SP_PRACTITIONER
```
    See Also:
    
    Constant Field Values
  - SP_PARTSTATUS
```
public static final String SP_PARTSTATUS
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_APPOINTMENT
```
public static final String SP_APPOINTMENT
```
    See Also:
    
    Constant Field Values
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AppointmentResponse
```
public AppointmentResponse()
```
  - AppointmentResponse
```
public AppointmentResponse(Reference appointment,
                           Enumeration<AppointmentResponse.ParticipantStatus> participantStatus)
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (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.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (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(Identifier t)
```
  - getAppointment
```
public Reference getAppointment()
```
    Returns:
    
    appointment (Appointment that this response is replying to.)
  - hasAppointment
```
public boolean hasAppointment()
```
  - setAppointment
```
public AppointmentResponse setAppointment(Reference value)
```
    Parameters:
    
    value - appointment (Appointment that this response is replying to.)
  - getAppointmentTarget
```
public Appointment getAppointmentTarget()
```
    Returns:
    
    appointment The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Appointment that this response is replying to.)
  - setAppointmentTarget
```
public AppointmentResponse setAppointmentTarget(Appointment value)
```
    Parameters:
    
    value - appointment The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Appointment that this response is replying to.)
  - getStartElement
```
public InstantType getStartElement()
```
    Returns:
    
    start (Date/Time that the appointment is to take place, or requested new start time.). 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 AppointmentResponse setStartElement(InstantType value)
```
    Parameters:
    
    value - start (Date/Time that the appointment is to take place, or requested new start time.). 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, or requested new start time.
  - setStart
```
public AppointmentResponse setStart(Date value)
```
    Parameters:
    
    value - Date/Time that the appointment is to take place, or requested new start time.
  - getEndElement
```
public InstantType getEndElement()
```
    Returns:
    
    end (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.). 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 AppointmentResponse setEndElement(InstantType value)
```
    Parameters:
    
    value - end (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.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value
  - getEnd
```
public Date getEnd()
```
    Returns:
    
    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 value)
```
    Parameters:
    
    value - 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<CodeableConcept> getParticipantType()
```
    Returns:
    
    participantType (Role of participant in the appointment.)
  - hasParticipantType
```
public boolean hasParticipantType()
```
  - addParticipantType
```
public CodeableConcept addParticipantType()
```
    Returns:
    
    participantType (Role of participant in the appointment.)
  - addParticipantType
```
public AppointmentResponse addParticipantType(CodeableConcept t)
```
  - getActor
```
public Reference getActor()
```
    Returns:
    
    actor (A Person, Location/HealthcareService or Device that is participating in the appointment.)
  - hasActor
```
public boolean hasActor()
```
  - setActor
```
public AppointmentResponse setActor(Reference value)
```
    Parameters:
    
    value - actor (A Person, Location/HealthcareService or Device that is participating in the appointment.)
  - getActorTarget
```
public Resource getActorTarget()
```
    Returns:
    
    actor The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A Person, Location/HealthcareService or Device that is participating in the appointment.)
  - setActorTarget
```
public AppointmentResponse setActorTarget(Resource value)
```
    Parameters:
    
    value - actor The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A Person, Location/HealthcareService or Device that is participating in the appointment.)
  - getParticipantStatusElement
```
public Enumeration<AppointmentResponse.ParticipantStatus> getParticipantStatusElement()
```
    Returns:
    
    participantStatus (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.). This is the underlying object with id, value and extensions. The accessor "getParticipantStatus" gives direct access to the value
  - hasParticipantStatusElement
```
public boolean hasParticipantStatusElement()
```
  - hasParticipantStatus
```
public boolean hasParticipantStatus()
```
  - setParticipantStatusElement
```
public AppointmentResponse setParticipantStatusElement(Enumeration<AppointmentResponse.ParticipantStatus> value)
```
    Parameters:
    
    value - participantStatus (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.). This is the underlying object with id, value and extensions. The accessor "getParticipantStatus" gives direct access to the value
  - getParticipantStatus
```
public AppointmentResponse.ParticipantStatus getParticipantStatus()
```
    Returns:
    
    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(AppointmentResponse.ParticipantStatus value)
```
    Parameters:
    
    value - 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 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 AppointmentResponse 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 AppointmentResponse setComment(String value)
```
    Parameters:
    
    value - Additional comments about the appointment.
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - 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
  - 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 AppointmentResponse copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected AppointmentResponse 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 AppointmentResponse

Nested Class Summary

Field Summary

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

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

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

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

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

appointment

appointmentTarget

start

end

participantType

actor

actorTarget

participantStatus

comment

SP_ACTOR

SP_IDENTIFIER

SP_PRACTITIONER

SP_PARTSTATUS

SP_PATIENT

SP_APPOINTMENT

SP_LOCATION

Constructor Detail

AppointmentResponse

AppointmentResponse

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getAppointment

hasAppointment

setAppointment

getAppointmentTarget

setAppointmentTarget

getStartElement

hasStartElement

hasStart

setStartElement

getStart

setStart

getEndElement

hasEndElement

hasEnd

setEndElement

getEnd

setEnd

getParticipantType

hasParticipantType

addParticipantType

addParticipantType

getActor

hasActor

setActor

getActorTarget

setActorTarget

getParticipantStatusElement

hasParticipantStatusElement

hasParticipantStatus

setParticipantStatusElement

getParticipantStatus

setParticipantStatus

getCommentElement

hasCommentElement

hasComment

setCommentElement

getComment