Package com.ibm.fhir.model.type

Class ContactPoint.Builder

    • Method Detail

      • id

        public ContactPoint.Builder id​(String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class Element.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public ContactPoint.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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

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

      • extension

        public ContactPoint.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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

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

      • system

        public ContactPoint.Builder system​(ContactPointSystem system)
        Telecommunications form for contact point - what communications system is required to make use of the contact.
        Parameters:
        system - phone | fax | email | pager | url | sms | other
        Returns:
        A reference to this Builder instance

      • value

        public ContactPoint.Builder value​(String value)
        The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
        Parameters:
        value - The actual contact point details
        Returns:
        A reference to this Builder instance

      • use

        public ContactPoint.Builder use​(ContactPointUse use)
        Identifies the purpose for the contact point.
        Parameters:
        use - home | work | temp | old | mobile - purpose of this contact point
        Returns:
        A reference to this Builder instance

      • rank

        public ContactPoint.Builder rank​(PositiveInt rank)
        Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
        Parameters:
        rank - Specify preferred order of use (1 = highest)
        Returns:
        A reference to this Builder instance

      • period

        public ContactPoint.Builder period​(Period period)
        Time period when the contact point was/is in use.
        Parameters:
        period - Time period when the contact point was/is in use
        Returns:
        A reference to this Builder instance