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:
  • Field Details

    • 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

      Appointment that this response is replying to.
    • proposedNewTime

      Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.
    • 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

      Role of participant in the appointment.
    • actor

      protected Reference actor
      A Person, Location, HealthcareService, or Device that is participating in the appointment.
    • 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.
    • recurring

      Indicates that this AppointmentResponse applies to all occurrences in a recurring request.
    • occurrenceDate

      The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in `Appointment.occurrenceDate`).
    • recurrenceId

      The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.
    • 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:
    • 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_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:
    • 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".
    • SP_GROUP

      public static final String SP_GROUP
      Search parameter: group

      Description: This Response is for this Group
      Type: reference
      Path: AppointmentResponse.actor.where(resolve() is Group)

      See Also:
    • GROUP

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam GROUP
      Fluent Client search parameter constant for group

      Description: This Response is for this Group
      Type: reference
      Path: AppointmentResponse.actor.where(resolve() is Group)

    • INCLUDE_GROUP

      public static final ca.uhn.fhir.model.api.Include INCLUDE_GROUP
      Constant for fluent queries to be used to add include statements. Specifies the path value of "AppointmentResponse:group".
    • 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:
    • 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_LOCATION

      public static final String SP_LOCATION
      Search parameter: location

      Description: This Response is for this Location
      Type: reference
      Path: AppointmentResponse.actor.where(resolve() is Location)

      See Also:
    • 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.where(resolve() is Location)

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

      public static final String SP_PATIENT
      Search parameter: patient

      Description: This Response is for this Patient
      Type: reference
      Path: AppointmentResponse.actor.where(resolve() is Patient)

      See Also:
    • 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.where(resolve() is Patient)

    • 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.where(resolve() is Practitioner)

      See Also:
    • 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.where(resolve() is Practitioner)

    • 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".
  • Constructor Details

  • Method Details

    • 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

      Returns:
      Returns a reference to this for easy method chaining
    • hasIdentifier

      public boolean hasIdentifier()
    • addIdentifier

    • addIdentifier

    • getIdentifierFirstRep

      Returns:
      The first repetition of repeating field identifier, creating it if it does not already exist {3}
    • getAppointment

      Returns:
      appointment (Appointment that this response is replying to.)
    • hasAppointment

      public boolean hasAppointment()
    • setAppointment

      Parameters:
      value - appointment (Appointment that this response is replying to.)
    • getProposedNewTimeElement

      Returns:
      proposedNewTime (Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.). This is the underlying object with id, value and extensions. The accessor "getProposedNewTime" gives direct access to the value
    • hasProposedNewTimeElement

      public boolean hasProposedNewTimeElement()
    • hasProposedNewTime

      public boolean hasProposedNewTime()
    • setProposedNewTimeElement

      Parameters:
      value - proposedNewTime (Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.). This is the underlying object with id, value and extensions. The accessor "getProposedNewTime" gives direct access to the value
    • getProposedNewTime

      public boolean getProposedNewTime()
      Returns:
      Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.
    • setProposedNewTime

      public AppointmentResponse setProposedNewTime(boolean value)
      Parameters:
      value - Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.
    • 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

      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

      Parameters:
      value - Date/Time that the appointment is to take place, or requested new start time.
    • 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

      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

      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

      Returns:
      participantType (Role of participant in the appointment.)
    • setParticipantType

      Returns:
      Returns a reference to this for easy method chaining
    • hasParticipantType

      public boolean hasParticipantType()
    • addParticipantType

    • addParticipantType

    • getParticipantTypeFirstRep

      Returns:
      The first repetition of repeating field participantType, creating it if it does not already exist {3}
    • getActor

      public Reference getActor()
      Returns:
      actor (A Person, Location, HealthcareService, or Device that is participating in the appointment.)
    • hasActor

      public boolean hasActor()
    • setActor

      Parameters:
      value - actor (A Person, Location, HealthcareService, or Device that is participating in the appointment.)
    • 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

      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

      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

      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

      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

      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

      Parameters:
      value - Additional comments about the appointment.
    • getRecurringElement

      Returns:
      recurring (Indicates that this AppointmentResponse applies to all occurrences in a recurring request.). This is the underlying object with id, value and extensions. The accessor "getRecurring" gives direct access to the value
    • hasRecurringElement

      public boolean hasRecurringElement()
    • hasRecurring

      public boolean hasRecurring()
    • setRecurringElement

      Parameters:
      value - recurring (Indicates that this AppointmentResponse applies to all occurrences in a recurring request.). This is the underlying object with id, value and extensions. The accessor "getRecurring" gives direct access to the value
    • getRecurring

      public boolean getRecurring()
      Returns:
      Indicates that this AppointmentResponse applies to all occurrences in a recurring request.
    • setRecurring

      public AppointmentResponse setRecurring(boolean value)
      Parameters:
      value - Indicates that this AppointmentResponse applies to all occurrences in a recurring request.
    • getOccurrenceDateElement

      Returns:
      occurrenceDate (The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in `Appointment.occurrenceDate`).). This is the underlying object with id, value and extensions. The accessor "getOccurrenceDate" gives direct access to the value
    • hasOccurrenceDateElement

      public boolean hasOccurrenceDateElement()
    • hasOccurrenceDate

      public boolean hasOccurrenceDate()
    • setOccurrenceDateElement

      Parameters:
      value - occurrenceDate (The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in `Appointment.occurrenceDate`).). This is the underlying object with id, value and extensions. The accessor "getOccurrenceDate" gives direct access to the value
    • getOccurrenceDate

      Returns:
      The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in `Appointment.occurrenceDate`).
    • setOccurrenceDate

      Parameters:
      value - The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in `Appointment.occurrenceDate`).
    • getRecurrenceIdElement

      Returns:
      recurrenceId (The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.). This is the underlying object with id, value and extensions. The accessor "getRecurrenceId" gives direct access to the value
    • hasRecurrenceIdElement

      public boolean hasRecurrenceIdElement()
    • hasRecurrenceId

      public boolean hasRecurrenceId()
    • setRecurrenceIdElement

      Parameters:
      value - recurrenceId (The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.). This is the underlying object with id, value and extensions. The accessor "getRecurrenceId" gives direct access to the value
    • getRecurrenceId

      public int getRecurrenceId()
      Returns:
      The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.
    • setRecurrenceId

      Parameters:
      value - The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.
    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class DomainResource
    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • 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
    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty 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()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource
    • copy

      Specified by:
      copy in class DomainResource
    • copyValues

      public void copyValues(AppointmentResponse dst)
    • 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

      Specified by:
      getResourceType in class Resource