Class 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
    • 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.
      • 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.
      • 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 CodeType 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.
      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: 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 patient

        Description: 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_PRACTITIONER

        public static final String SP_PRACTITIONER
        Search parameter: practitioner

        Description: 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 practitioner

        Description: 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_LOCATION

        public static final String SP_LOCATION
        Search parameter: location

        Description: 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 location

        Description: 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".
      • SP_PART_STATUS

        public static final String SP_PART_STATUS
        Search parameter: 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 ca.uhn.fhir.rest.gclient.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: 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 ca.uhn.fhir.rest.gclient.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

      • 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: identifier

        Description: 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 identifier

        Description: An Identifier in this appointment response
        Type: token
        Path: AppointmentResponse.identifier

      • SP_APPOINTMENT

        public static final String SP_APPOINTMENT
        Search parameter: appointment

        Description: 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 appointment

        Description: 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".
    • Method Detail

      • getIdentifier

        public List<IdentifiergetIdentifier()
        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 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.)
      • 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
      • 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
      • 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.
      • getActor

        public Reference getActor()
        Returns:
        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 CodeType 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
      • setParticipantStatusElement

        public AppointmentResponse setParticipantStatusElement​(CodeType 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 String 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​(String 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
      • 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.
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource