Class AppointmentResponse
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.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 Description static classAppointmentResponse.ParticipantStatusstatic classAppointmentResponse.ParticipantStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected ReferenceactorA Person, Location, HealthcareService, or Device that is participating in the appointment.static ca.uhn.fhir.rest.gclient.ReferenceClientParamACTORFluent Client search parameter constant for actorprotected ResourceactorTargetThe actual object that is the target of the reference (A Person, Location, HealthcareService, or Device that is participating in the appointment.)protected ReferenceappointmentAppointment that this response is replying to.static ca.uhn.fhir.rest.gclient.ReferenceClientParamAPPOINTMENTFluent Client search parameter constant for appointmentprotected AppointmentappointmentTargetThe actual object that is the target of the reference (Appointment that this response is replying to.)protected StringTypecommentAdditional comments about the appointment.protected InstantTypeendThis 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>identifierThis 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.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_ACTORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_APPOINTMENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_LOCATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PRACTITIONERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParamLOCATIONFluent Client search parameter constant for locationstatic ca.uhn.fhir.rest.gclient.TokenClientParamPART_STATUSFluent Client search parameter constant for part-statusprotected Enumeration<AppointmentResponse.ParticipantStatus>participantStatusParticipation status of the participant.protected List<CodeableConcept>participantTypeRole of participant in the appointment.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamPRACTITIONERFluent Client search parameter constant for practitionerstatic StringSP_ACTORSearch parameter: actorstatic StringSP_APPOINTMENTSearch parameter: appointmentstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_PART_STATUSSearch parameter: part-statusstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PRACTITIONERSearch parameter: practitionerprotected InstantTypestartDate/Time that the appointment is to take place, or requested new start time.-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description AppointmentResponse()ConstructorAppointmentResponse(Reference appointment, Enumeration<AppointmentResponse.ParticipantStatus> participantStatus)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
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
Search parameter: actorDescription: 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam ACTOR
Fluent Client search parameter constant for actorDescription: The Person, Location/HealthcareService or Device that this appointment response replies for
Type: reference
Path: AppointmentResponse.actor
-
INCLUDE_ACTOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:actor".
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: An Identifier in this appointment response
Type: token
Path: AppointmentResponse.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: An Identifier in this appointment response
Type: token
Path: AppointmentResponse.identifier
-
SP_PRACTITIONER
public static final String SP_PRACTITIONER
Search parameter: practitionerDescription: This Response is for this Practitioner
Type: reference
Path: AppointmentResponse.actor
- See Also:
- Constant Field Values
-
PRACTITIONER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
Fluent Client search parameter constant for practitionerDescription: This Response is for this Practitioner
Type: reference
Path: AppointmentResponse.actor
-
INCLUDE_PRACTITIONER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:practitioner".
-
SP_PART_STATUS
public static final String SP_PART_STATUS
Search parameter: part-statusDescription: The participants acceptance status for this appointment
Type: token
Path: AppointmentResponse.participantStatus
- See Also:
- Constant Field Values
-
PART_STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PART_STATUS
Fluent Client search parameter constant for part-statusDescription: The participants acceptance status for this appointment
Type: token
Path: AppointmentResponse.participantStatus
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: This Response is for this Patient
Type: reference
Path: AppointmentResponse.actor
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: This Response is for this Patient
Type: reference
Path: AppointmentResponse.actor
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:patient".
-
SP_APPOINTMENT
public static final String SP_APPOINTMENT
Search parameter: appointmentDescription: The appointment that the response is attached to
Type: reference
Path: AppointmentResponse.appointment
- See Also:
- Constant Field Values
-
APPOINTMENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam APPOINTMENT
Fluent Client search parameter constant for appointmentDescription: The appointment that the response is attached to
Type: reference
Path: AppointmentResponse.appointment
-
INCLUDE_APPOINTMENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_APPOINTMENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:appointment".
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: This Response is for this Location
Type: reference
Path: AppointmentResponse.actor
- See Also:
- Constant Field Values
-
LOCATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
Fluent Client search parameter constant for locationDescription: This Response is for this Location
Type: reference
Path: AppointmentResponse.actor
-
INCLUDE_LOCATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:location".
-
-
Constructor Detail
-
AppointmentResponse
public AppointmentResponse()
Constructor
-
AppointmentResponse
public AppointmentResponse(Reference appointment, Enumeration<AppointmentResponse.ParticipantStatus> participantStatus)
Constructor
-
-
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.)
-
setIdentifier
public AppointmentResponse setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public AppointmentResponse addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
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:
appointmentThe 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-appointmentThe 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.)
-
setParticipantType
public AppointmentResponse setParticipantType(List<CodeableConcept> theParticipantType)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasParticipantType
public boolean hasParticipantType()
-
addParticipantType
public CodeableConcept addParticipantType()
-
addParticipantType
public AppointmentResponse addParticipantType(CodeableConcept t)
-
getParticipantTypeFirstRep
public CodeableConcept getParticipantTypeFirstRep()
- Returns:
- The first repetition of repeating field
participantType, creating it if it does not already exist
-
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:
actorThe 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-actorThe 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> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public AppointmentResponse copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(AppointmentResponse dst)
-
typedCopy
protected AppointmentResponse typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-