Package com.babylonhealth.lit.hl7_java.builders

Class AppointmentBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.hl7.APPOINTMENTSTATUS status,
            java.util.Collection<com.babylonhealth.lit.hl7.model.Appointment.Participant> participant)
        Required fields for Appointment
        Parameters:
        status - - The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
        participant - - List of participants involved in the appointment.

    • Method Detail

      • withId

        public AppointmentBuilder.Impl withId​(@NonNull
                                      @NonNull java.lang.String id)
        Parameters:
        id - - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • withEnd

        public AppointmentBuilder.Impl withEnd​(@NonNull
                                       @NonNull java.time.ZonedDateTime end)
        Parameters:
        end - - Date/Time that the appointment is to conclude.

      • withMeta

        public AppointmentBuilder.Impl withMeta​(@NonNull
                                        @NonNull com.babylonhealth.lit.core.model.Meta meta)
        Parameters:
        meta - - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      • withMeta

        public AppointmentBuilder.Impl withMeta​(@NonNull
                                        @NonNull com.babylonhealth.lit.core_java.builders.MetaBuilder meta)

      • withText

        public AppointmentBuilder.Impl withText​(@NonNull
                                        @NonNull com.babylonhealth.lit.hl7.model.Narrative text)
        Parameters:
        text - - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      • withSlot

        public AppointmentBuilder.Impl withSlot​(@NonNull
                                        @NonNull com.babylonhealth.lit.core.model.Reference... slot)
        Parameters:
        slot - - The slots from the participants' schedules that will be filled by the appointment.

      • withSlot

        public AppointmentBuilder.Impl withSlot​(@NonNull
                                        @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> slot)
        Parameters:
        slot - - The slots from the participants' schedules that will be filled by the appointment.

      • withSlot

        public AppointmentBuilder.Impl withSlot​(@NonNull
                                        @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... slot)

      • withStart

        public AppointmentBuilder.Impl withStart​(@NonNull
                                         @NonNull java.time.ZonedDateTime start)
        Parameters:
        start - - Date/Time that the appointment is to take place.

      • withCreated

        public AppointmentBuilder.Impl withCreated​(@NonNull
                                           @NonNull com.babylonhealth.lit.core.FHIRDateTime created)
        Parameters:
        created - - The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

      • withComment

        public AppointmentBuilder.Impl withComment​(@NonNull
                                           @NonNull java.lang.String comment)
        Parameters:
        comment - - Additional comments about the appointment.

      • withBasedOn

        public AppointmentBuilder.Impl withBasedOn​(@NonNull
                                           @NonNull com.babylonhealth.lit.core.model.Reference... basedOn)
        Parameters:
        basedOn - - The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

      • withBasedOn

        public AppointmentBuilder.Impl withBasedOn​(@NonNull
                                           @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> basedOn)
        Parameters:
        basedOn - - The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

      • withBasedOn

        public AppointmentBuilder.Impl withBasedOn​(@NonNull
                                           @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... basedOn)

      • withLanguage

        public AppointmentBuilder.Impl withLanguage​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.LANGUAGES language)
        Parameters:
        language - - The base language in which the resource is written.

      • withPriority

        public AppointmentBuilder.Impl withPriority​(@NonNull
                                            @NonNull java.lang.Integer priority)
        Parameters:
        priority - - The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

      • withContained

        public AppointmentBuilder.Impl withContained​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Resource... contained)
        Parameters:
        contained - - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      • withContained

        public AppointmentBuilder.Impl withContained​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Resource> contained)
        Parameters:
        contained - - These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      • withContained

        public AppointmentBuilder.Impl withContained​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public AppointmentBuilder.Impl withExtension​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Extension... extension)
        Parameters:
        extension - - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • withExtension

        public AppointmentBuilder.Impl withExtension​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> extension)
        Parameters:
        extension - - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • withExtension

        public AppointmentBuilder.Impl withExtension​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withSpecialty

        public AppointmentBuilder.Impl withSpecialty​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.CodeableConcept... specialty)
        Parameters:
        specialty - - The specialty of a practitioner that would be required to perform the service requested in this appointment.

      • withSpecialty

        public AppointmentBuilder.Impl withSpecialty​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> specialty)
        Parameters:
        specialty - - The specialty of a practitioner that would be required to perform the service requested in this appointment.

      • withSpecialty

        public AppointmentBuilder.Impl withSpecialty​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... specialty)

      • withIdentifier

        public AppointmentBuilder.Impl withIdentifier​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.Identifier... identifier)
        Parameters:
        identifier - - This records identifiers associated with this appointment 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 (e.g. in CDA documents, or in written / printed documentation).

      • withIdentifier

        public AppointmentBuilder.Impl withIdentifier​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Identifier> identifier)
        Parameters:
        identifier - - This records identifiers associated with this appointment 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 (e.g. in CDA documents, or in written / printed documentation).

      • withIdentifier

        public AppointmentBuilder.Impl withIdentifier​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.IdentifierBuilder... identifier)

      • withReasonCode

        public AppointmentBuilder.Impl withReasonCode​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.CodeableConcept... reasonCode)
        Parameters:
        reasonCode - - The coded reason that this appointment is being scheduled. This is more clinical than administrative.

      • withReasonCode

        public AppointmentBuilder.Impl withReasonCode​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> reasonCode)
        Parameters:
        reasonCode - - The coded reason that this appointment is being scheduled. This is more clinical than administrative.

      • withReasonCode

        public AppointmentBuilder.Impl withReasonCode​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... reasonCode)

      • withServiceType

        public AppointmentBuilder.Impl withServiceType​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.CodeableConcept... serviceType)
        Parameters:
        serviceType - - The specific service that is to be performed during this appointment.

      • withServiceType

        public AppointmentBuilder.Impl withServiceType​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> serviceType)
        Parameters:
        serviceType - - The specific service that is to be performed during this appointment.

      • withServiceType

        public AppointmentBuilder.Impl withServiceType​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... serviceType)

      • withDescription

        public AppointmentBuilder.Impl withDescription​(@NonNull
                                               @NonNull java.lang.String description)
        Parameters:
        description - - The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

      • withImplicitRules

        public AppointmentBuilder.Impl withImplicitRules​(@NonNull
                                                 @NonNull java.lang.String implicitRules)
        Parameters:
        implicitRules - - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      • withServiceCategory

        public AppointmentBuilder.Impl withServiceCategory​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.CodeableConcept... serviceCategory)
        Parameters:
        serviceCategory - - A broad categorization of the service that is to be performed during this appointment.

      • withServiceCategory

        public AppointmentBuilder.Impl withServiceCategory​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> serviceCategory)
        Parameters:
        serviceCategory - - A broad categorization of the service that is to be performed during this appointment.

      • withServiceCategory

        public AppointmentBuilder.Impl withServiceCategory​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... serviceCategory)

      • withAppointmentType

        public AppointmentBuilder.Impl withAppointmentType​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.CodeableConcept appointmentType)
        Parameters:
        appointmentType - - The style of appointment or patient that has been booked in the slot (not service type).

      • withAppointmentType

        public AppointmentBuilder.Impl withAppointmentType​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder appointmentType)

      • withReasonReference

        public AppointmentBuilder.Impl withReasonReference​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Reference... reasonReference)
        Parameters:
        reasonReference - - Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

      • withReasonReference

        public AppointmentBuilder.Impl withReasonReference​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> reasonReference)
        Parameters:
        reasonReference - - Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

      • withReasonReference

        public AppointmentBuilder.Impl withReasonReference​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... reasonReference)

      • withMinutesDuration

        public AppointmentBuilder.Impl withMinutesDuration​(@NonNull
                                                   @NonNull java.lang.Integer minutesDuration)
        Parameters:
        minutesDuration - - Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

      • withRequestedPeriod

        public AppointmentBuilder.Impl withRequestedPeriod​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Period... requestedPeriod)
        Parameters:
        requestedPeriod - - A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

        The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

      • withRequestedPeriod

        public AppointmentBuilder.Impl withRequestedPeriod​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Period> requestedPeriod)
        Parameters:
        requestedPeriod - - A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

        The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

      • withRequestedPeriod

        public AppointmentBuilder.Impl withRequestedPeriod​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.PeriodBuilder... requestedPeriod)

      • withModifierExtension

        public AppointmentBuilder.Impl withModifierExtension​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core.model.Extension... modifierExtension)
        Parameters:
        modifierExtension - - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      • withModifierExtension

        public AppointmentBuilder.Impl withModifierExtension​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> modifierExtension)
        Parameters:
        modifierExtension - - May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      • withModifierExtension

        public AppointmentBuilder.Impl withModifierExtension​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withCancelationReason

        public AppointmentBuilder.Impl withCancelationReason​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core.model.CodeableConcept cancelationReason)
        Parameters:
        cancelationReason - - The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

      • withCancelationReason

        public AppointmentBuilder.Impl withCancelationReason​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder cancelationReason)

      • withPatientInstruction

        public AppointmentBuilder.Impl withPatientInstruction​(@NonNull
                                                      @NonNull java.lang.String patientInstruction)
        Parameters:
        patientInstruction - - While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

      • withSupportingInformation

        public AppointmentBuilder.Impl withSupportingInformation​(@NonNull
                                                         @NonNull com.babylonhealth.lit.core.model.Reference... supportingInformation)
        Parameters:
        supportingInformation - - Additional information to support the appointment provided when making the appointment.

      • withSupportingInformation

        public AppointmentBuilder.Impl withSupportingInformation​(@NonNull
                                                         @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> supportingInformation)
        Parameters:
        supportingInformation - - Additional information to support the appointment provided when making the appointment.

      • withSupportingInformation

        public AppointmentBuilder.Impl withSupportingInformation​(@NonNull
                                                         @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... supportingInformation)

      • build

        public com.babylonhealth.lit.hl7.model.Appointment build()
        Specified by:
        build in interface AppointmentBuilder
        Specified by:
        build in interface DomainResourceBuilder
        Specified by:
        build in interface com.babylonhealth.lit.core_java.builders.ResourceBuilder