Package com.ibm.fhir.model.type

Class Identifier.Builder

    • Method Detail

      • id

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

      • use

        public Identifier.Builder use​(IdentifierUse use)
        The purpose of this identifier.
        Parameters:
        use - usual | official | temp | secondary | old (If known)
        Returns:
        A reference to this Builder instance

      • type

        public Identifier.Builder type​(CodeableConcept type)
        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
        Parameters:
        type - Description of identifier
        Returns:
        A reference to this Builder instance

      • system

        public Identifier.Builder system​(Uri system)
        Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
        Parameters:
        system - The namespace for the identifier value
        Returns:
        A reference to this Builder instance

      • value

        public Identifier.Builder value​(String value)
        The portion of the identifier typically relevant to the user and which is unique within the context of the system.
        Parameters:
        value - The value that is unique
        Returns:
        A reference to this Builder instance

      • period

        public Identifier.Builder period​(Period period)
        Time period during which identifier is/was valid for use.
        Parameters:
        period - Time period when id is/was valid for use
        Returns:
        A reference to this Builder instance

      • assigner

        public Identifier.Builder assigner​(Reference assigner)
        Organization that issued/manages the identifier.

        Allowed resource types for this reference:

        • Organization
        Parameters:
        assigner - Organization that issued id (may be just text)
        Returns:
        A reference to this Builder instance