Package com.ibm.fhir.model.resource

Class HealthcareService.Builder

    • Method Detail

      • id

        public HealthcareService.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public HealthcareService.Builder meta​(Meta 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.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public HealthcareService.Builder implicitRules​(Uri 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.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public HealthcareService.Builder text​(Narrative 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.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public HealthcareService.Builder contained​(Resource... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public HealthcareService.Builder contained​(java.util.Collection<Resource> 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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public HealthcareService.Builder extension​(Extension... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public HealthcareService.Builder extension​(java.util.Collection<Extension> 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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public HealthcareService.Builder modifierExtension​(Extension... 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).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public HealthcareService.Builder modifierExtension​(java.util.Collection<Extension> 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).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • identifier

        public HealthcareService.Builder identifier​(Identifier... identifier)
        External identifiers for this item.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - External identifiers for this item
        Returns:
        A reference to this Builder instance

      • identifier

        public HealthcareService.Builder identifier​(java.util.Collection<Identifier> identifier)
        External identifiers for this item.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - External identifiers for this item
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • active

        public HealthcareService.Builder active​(Boolean active)
        This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.
        Parameters:
        active - Whether this HealthcareService record is in active use
        Returns:
        A reference to this Builder instance

      • providedBy

        public HealthcareService.Builder providedBy​(Reference providedBy)
        The organization that provides this healthcare service.

        Allowed resource types for this reference:

        Parameters:
        providedBy - Organization that provides this service
        Returns:
        A reference to this Builder instance

      • category

        public HealthcareService.Builder category​(CodeableConcept... category)
        Identifies the broad category of service being performed or delivered.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        category - Broad category of service being performed or delivered
        Returns:
        A reference to this Builder instance

      • category

        public HealthcareService.Builder category​(java.util.Collection<CodeableConcept> category)
        Identifies the broad category of service being performed or delivered.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        category - Broad category of service being performed or delivered
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • type

        public HealthcareService.Builder type​(CodeableConcept... type)
        The specific type of service that may be delivered or performed.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        type - Type of service that may be delivered or performed
        Returns:
        A reference to this Builder instance

      • type

        public HealthcareService.Builder type​(java.util.Collection<CodeableConcept> type)
        The specific type of service that may be delivered or performed.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        type - Type of service that may be delivered or performed
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • specialty

        public HealthcareService.Builder specialty​(CodeableConcept... specialty)
        Collection of specialties handled by the service site. This is more of a medical term.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        specialty - Specialties handled by the HealthcareService
        Returns:
        A reference to this Builder instance

      • specialty

        public HealthcareService.Builder specialty​(java.util.Collection<CodeableConcept> specialty)
        Collection of specialties handled by the service site. This is more of a medical term.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        specialty - Specialties handled by the HealthcareService
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • location

        public HealthcareService.Builder location​(Reference... location)
        The location(s) where this healthcare service may be provided.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        location - Location(s) where service may be provided
        Returns:
        A reference to this Builder instance

      • location

        public HealthcareService.Builder location​(java.util.Collection<Reference> location)
        The location(s) where this healthcare service may be provided.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        location - Location(s) where service may be provided
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • name

        public HealthcareService.Builder name​(String name)
        Further description of the service as it would be presented to a consumer while searching.
        Parameters:
        name - Description of service as presented to a consumer while searching
        Returns:
        A reference to this Builder instance

      • comment

        public HealthcareService.Builder comment​(String comment)
        Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
        Parameters:
        comment - Additional description and/or any specific issues not covered elsewhere
        Returns:
        A reference to this Builder instance

      • extraDetails

        public HealthcareService.Builder extraDetails​(Markdown extraDetails)
        Extra details about the service that can't be placed in the other fields.
        Parameters:
        extraDetails - Extra details about the service that can't be placed in the other fields
        Returns:
        A reference to this Builder instance

      • photo

        public HealthcareService.Builder photo​(Attachment photo)
        If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
        Parameters:
        photo - Facilitates quick identification of the service
        Returns:
        A reference to this Builder instance

      • telecom

        public HealthcareService.Builder telecom​(ContactPoint... telecom)
        List of contacts related to this specific healthcare service.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        telecom - Contacts related to the healthcare service
        Returns:
        A reference to this Builder instance

      • telecom

        public HealthcareService.Builder telecom​(java.util.Collection<ContactPoint> telecom)
        List of contacts related to this specific healthcare service.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        telecom - Contacts related to the healthcare service
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • coverageArea

        public HealthcareService.Builder coverageArea​(Reference... coverageArea)
        The location(s) that this service is available to (not where the service is provided).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        coverageArea - Location(s) service is intended for/available to
        Returns:
        A reference to this Builder instance

      • coverageArea

        public HealthcareService.Builder coverageArea​(java.util.Collection<Reference> coverageArea)
        The location(s) that this service is available to (not where the service is provided).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        coverageArea - Location(s) service is intended for/available to
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • serviceProvisionCode

        public HealthcareService.Builder serviceProvisionCode​(CodeableConcept... serviceProvisionCode)
        The code(s) that detail the conditions under which the healthcare service is available/offered.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        serviceProvisionCode - Conditions under which service is available/offered
        Returns:
        A reference to this Builder instance

      • serviceProvisionCode

        public HealthcareService.Builder serviceProvisionCode​(java.util.Collection<CodeableConcept> serviceProvisionCode)
        The code(s) that detail the conditions under which the healthcare service is available/offered.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        serviceProvisionCode - Conditions under which service is available/offered
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • eligibility

        public HealthcareService.Builder eligibility​(HealthcareService.Eligibility... eligibility)
        Does this service have specific eligibility requirements that need to be met in order to use the service?

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        eligibility - Specific eligibility requirements required to use the service
        Returns:
        A reference to this Builder instance

      • eligibility

        public HealthcareService.Builder eligibility​(java.util.Collection<HealthcareService.Eligibility> eligibility)
        Does this service have specific eligibility requirements that need to be met in order to use the service?

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        eligibility - Specific eligibility requirements required to use the service
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • program

        public HealthcareService.Builder program​(CodeableConcept... program)
        Programs that this service is applicable to.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        program - Programs that this service is applicable to
        Returns:
        A reference to this Builder instance

      • program

        public HealthcareService.Builder program​(java.util.Collection<CodeableConcept> program)
        Programs that this service is applicable to.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        program - Programs that this service is applicable to
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • characteristic

        public HealthcareService.Builder characteristic​(CodeableConcept... characteristic)
        Collection of characteristics (attributes).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        characteristic - Collection of characteristics (attributes)
        Returns:
        A reference to this Builder instance

      • characteristic

        public HealthcareService.Builder characteristic​(java.util.Collection<CodeableConcept> characteristic)
        Collection of characteristics (attributes).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        characteristic - Collection of characteristics (attributes)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • communication

        public HealthcareService.Builder communication​(CodeableConcept... communication)
        Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        communication - The language that this service is offered in
        Returns:
        A reference to this Builder instance

      • communication

        public HealthcareService.Builder communication​(java.util.Collection<CodeableConcept> communication)
        Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        communication - The language that this service is offered in
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • referralMethod

        public HealthcareService.Builder referralMethod​(CodeableConcept... referralMethod)
        Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        referralMethod - Ways that the service accepts referrals
        Returns:
        A reference to this Builder instance

      • referralMethod

        public HealthcareService.Builder referralMethod​(java.util.Collection<CodeableConcept> referralMethod)
        Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        referralMethod - Ways that the service accepts referrals
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • appointmentRequired

        public HealthcareService.Builder appointmentRequired​(Boolean appointmentRequired)
        Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
        Parameters:
        appointmentRequired - If an appointment is required for access to this service
        Returns:
        A reference to this Builder instance

      • availableTime

        public HealthcareService.Builder availableTime​(HealthcareService.AvailableTime... availableTime)
        A collection of times that the Service Site is available.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        availableTime - Times the Service Site is available
        Returns:
        A reference to this Builder instance

      • availableTime

        public HealthcareService.Builder availableTime​(java.util.Collection<HealthcareService.AvailableTime> availableTime)
        A collection of times that the Service Site is available.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        availableTime - Times the Service Site is available
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • notAvailable

        public HealthcareService.Builder notAvailable​(HealthcareService.NotAvailable... notAvailable)
        The HealthcareService is not available during this period of time due to the provided reason.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        notAvailable - Not available during this time due to provided reason
        Returns:
        A reference to this Builder instance

      • notAvailable

        public HealthcareService.Builder notAvailable​(java.util.Collection<HealthcareService.NotAvailable> notAvailable)
        The HealthcareService is not available during this period of time due to the provided reason.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        notAvailable - Not available during this time due to provided reason
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • availabilityExceptions

        public HealthcareService.Builder availabilityExceptions​(String availabilityExceptions)
        A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
        Parameters:
        availabilityExceptions - Description of availability exceptions
        Returns:
        A reference to this Builder instance

      • endpoint

        public HealthcareService.Builder endpoint​(Reference... endpoint)
        Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        endpoint - Technical endpoints providing access to electronic services operated for the healthcare service
        Returns:
        A reference to this Builder instance

      • endpoint

        public HealthcareService.Builder endpoint​(java.util.Collection<Reference> endpoint)
        Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        endpoint - Technical endpoints providing access to electronic services operated for the healthcare service
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null