Class AppointmentResponse

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class AppointmentResponse
    extends BaseResource
    implements ca.uhn.fhir.model.api.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 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 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

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

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

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

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

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

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

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        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:

      • getStartElement

        public ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: Date/Time that the appointment is to take place, or requested new start time

      • setStart

        public AppointmentResponse setStart​(ca.uhn.fhir.model.primitive.InstantDt theValue)
        Sets the value(s) for start ()

        Definition: Date/Time that the appointment is to take place, or requested new start time

      • setStart

        public AppointmentResponse setStart​(Date theDate,
                                            ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for start ()

        Definition: Date/Time that the appointment is to take place, or requested new start time

      • getEndElement

        public ca.uhn.fhir.model.primitive.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. This method may 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​(ca.uhn.fhir.model.primitive.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,
                                          ca.uhn.fhir.model.api.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.

      • 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

      • getParticipantStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ParticipantStatusEnumgetParticipantStatusElement()
        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. This method may 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​(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: Additional comments about the appointment

      • setComment

        public AppointmentResponse setComment​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for comment ()

        Definition: Additional comments about the appointment

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource