Package org.linuxforhealth.fhir.model.resource

Class Location.Builder

    • Method Detail

      • id

        public Location.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 Location.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 Location.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

      • language

        public Location.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public Location.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 Location.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 Location.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 Location.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 Location.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 Location.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 Location.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 Location.Builder identifier​(Identifier... identifier)
        Unique code or number identifying the location to its users.

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

        Parameters:
        identifier - Unique code or number identifying the location to its users
        Returns:
        A reference to this Builder instance

      • identifier

        public Location.Builder identifier​(java.util.Collection<Identifier> identifier)
        Unique code or number identifying the location to its users.

        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 - Unique code or number identifying the location to its users
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public Location.Builder status​(LocationStatus status)
        The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
        Parameters:
        status - active | suspended | inactive
        Returns:
        A reference to this Builder instance

      • operationalStatus

        public Location.Builder operationalStatus​(Coding operationalStatus)
        The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
        Parameters:
        operationalStatus - The operational status of the location (typically only for a bed/room)
        Returns:
        A reference to this Builder instance

      • name

        public Location.Builder name​(String name)
        Name of the location as used by humans. Does not need to be unique.
        Parameters:
        name - Name of the location as used by humans
        Returns:
        A reference to this Builder instance

      • alias

        public Location.Builder alias​(java.lang.String... alias)
        Convenience method for setting alias.

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

        Parameters:
        alias - A list of alternate names that the location is known as, or was known as, in the past
        Returns:
        A reference to this Builder instance
        See Also:
        #alias(org.linuxforhealth.fhir.model.type.String)

      • alias

        public Location.Builder alias​(String... alias)
        A list of alternate names that the location is known as, or was known as, in the past.

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

        Parameters:
        alias - A list of alternate names that the location is known as, or was known as, in the past
        Returns:
        A reference to this Builder instance

      • alias

        public Location.Builder alias​(java.util.Collection<String> alias)
        A list of alternate names that the location is known as, or was known as, in the past.

        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:
        alias - A list of alternate names that the location is known as, or was known as, in the past
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public Location.Builder description​(java.lang.String description)
        Convenience method for setting description.
        Parameters:
        description - Additional details about the location that could be displayed as further information to identify the location beyond its name
        Returns:
        A reference to this Builder instance
        See Also:
        description(org.linuxforhealth.fhir.model.type.String)

      • description

        public Location.Builder description​(String description)
        Description of the Location, which helps in finding or referencing the place.
        Parameters:
        description - Additional details about the location that could be displayed as further information to identify the location beyond its name
        Returns:
        A reference to this Builder instance

      • mode

        public Location.Builder mode​(LocationMode mode)
        Indicates whether a resource instance represents a specific location or a class of locations.
        Parameters:
        mode - instance | kind
        Returns:
        A reference to this Builder instance

      • type

        public Location.Builder type​(CodeableConcept... type)
        Indicates the type of function performed at the location.

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

        Parameters:
        type - Type of function performed
        Returns:
        A reference to this Builder instance

      • type

        public Location.Builder type​(java.util.Collection<CodeableConcept> type)
        Indicates the type of function performed at the location.

        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 function performed
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • telecom

        public Location.Builder telecom​(ContactPoint... telecom)
        The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

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

        Parameters:
        telecom - Contact details of the location
        Returns:
        A reference to this Builder instance

      • telecom

        public Location.Builder telecom​(java.util.Collection<ContactPoint> telecom)
        The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

        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 - Contact details of the location
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • address

        public Location.Builder address​(Address address)
        Physical location.
        Parameters:
        address - Physical location
        Returns:
        A reference to this Builder instance

      • physicalType

        public Location.Builder physicalType​(CodeableConcept physicalType)
        Physical form of the location, e.g. building, room, vehicle, road.
        Parameters:
        physicalType - Physical form of the location
        Returns:
        A reference to this Builder instance

      • position

        public Location.Builder position​(Location.Position position)
        The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
        Parameters:
        position - The absolute geographic location
        Returns:
        A reference to this Builder instance

      • managingOrganization

        public Location.Builder managingOrganization​(Reference managingOrganization)
        The organization responsible for the provisioning and upkeep of the location.

        Allowed resource types for this reference:

        Parameters:
        managingOrganization - Organization responsible for provisioning and upkeep
        Returns:
        A reference to this Builder instance

      • partOf

        public Location.Builder partOf​(Reference partOf)
        Another Location of which this Location is physically a part of.

        Allowed resource types for this reference:

        Parameters:
        partOf - Another Location this one is physically a part of
        Returns:
        A reference to this Builder instance

      • hoursOfOperation

        public Location.Builder hoursOfOperation​(Location.HoursOfOperation... hoursOfOperation)
        What days/times during a week is this location usually open.

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

        Parameters:
        hoursOfOperation - What days/times during a week is this location usually open
        Returns:
        A reference to this Builder instance

      • hoursOfOperation

        public Location.Builder hoursOfOperation​(java.util.Collection<Location.HoursOfOperation> hoursOfOperation)
        What days/times during a week is this location usually open.

        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:
        hoursOfOperation - What days/times during a week is this location usually open
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • availabilityExceptions

        public Location.Builder availabilityExceptions​(String availabilityExceptions)
        A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
        Parameters:
        availabilityExceptions - Description of availability exceptions
        Returns:
        A reference to this Builder instance

      • endpoint

        public Location.Builder endpoint​(Reference... endpoint)
        Technical endpoints providing access to services operated for the location.

        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 services operated for the location
        Returns:
        A reference to this Builder instance

      • endpoint

        public Location.Builder endpoint​(java.util.Collection<Reference> endpoint)
        Technical endpoints providing access to services operated for the location.

        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 services operated for the location
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validate

        protected void validate​(Location location)