Package com.ibm.fhir.model.resource

Class NamingSystem.Builder

    • Method Detail

      • id

        public NamingSystem.Builder id​(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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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

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

      • contained

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

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

      • extension

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

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

      • extension

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

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

      • modifierExtension

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

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

      • modifierExtension

        public NamingSystem.Builder modifierExtension​(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

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

      • name

        public NamingSystem.Builder name​(String name)
        A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

        This element is required.

        Parameters:
        name - Name for this naming system (computer friendly)
        Returns:
        A reference to this Builder instance

      • status

        public NamingSystem.Builder status​(PublicationStatus status)
        The status of this naming system. Enables tracking the life-cycle of the content.

        This element is required.

        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • kind

        public NamingSystem.Builder kind​(NamingSystemType kind)
        Indicates the purpose for the naming system - what kinds of things does it make unique?

        This element is required.

        Parameters:
        kind - codesystem | identifier | root
        Returns:
        A reference to this Builder instance

      • date

        public NamingSystem.Builder date​(DateTime date)
        The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.

        This element is required.

        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

        public NamingSystem.Builder publisher​(String publisher)
        The name of the organization or individual that published the naming system.
        Parameters:
        publisher - Name of the publisher (organization or individual)
        Returns:
        A reference to this Builder instance

      • contact

        public NamingSystem.Builder contact​(ContactDetail... contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Adds new element(s) to the existing list

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance

      • contact

        public NamingSystem.Builder contact​(Collection<ContactDetail> contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance

      • responsible

        public NamingSystem.Builder responsible​(String responsible)
        The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
        Parameters:
        responsible - Who maintains system namespace?
        Returns:
        A reference to this Builder instance

      • type

        public NamingSystem.Builder type​(CodeableConcept type)
        Categorizes a naming system for easier search by grouping related naming systems.
        Parameters:
        type - e.g. driver, provider, patient, bank etc.
        Returns:
        A reference to this Builder instance

      • description

        public NamingSystem.Builder description​(Markdown description)
        A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
        Parameters:
        description - Natural language description of the naming system
        Returns:
        A reference to this Builder instance

      • useContext

        public NamingSystem.Builder useContext​(UsageContext... useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.

        Adds new element(s) to the existing list

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance

      • useContext

        public NamingSystem.Builder useContext​(Collection<UsageContext> useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public NamingSystem.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the naming system is intended to be used.

        Adds new element(s) to the existing list

        Parameters:
        jurisdiction - Intended jurisdiction for naming system (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public NamingSystem.Builder jurisdiction​(Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the naming system is intended to be used.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        jurisdiction - Intended jurisdiction for naming system (if applicable)
        Returns:
        A reference to this Builder instance

      • usage

        public NamingSystem.Builder usage​(String usage)
        Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
        Parameters:
        usage - How/where is it used
        Returns:
        A reference to this Builder instance

      • uniqueId

        public NamingSystem.Builder uniqueId​(NamingSystem.UniqueId... uniqueId)
        Indicates how the system may be identified when referenced in electronic exchange.

        Adds new element(s) to the existing list

        This element is required.

        Parameters:
        uniqueId - Unique identifiers used for system
        Returns:
        A reference to this Builder instance

      • uniqueId

        public NamingSystem.Builder uniqueId​(Collection<NamingSystem.UniqueId> uniqueId)
        Indicates how the system may be identified when referenced in electronic exchange.

        Replaces the existing list with a new one containing elements from the Collection

        This element is required.

        Parameters:
        uniqueId - Unique identifiers used for system
        Returns:
        A reference to this Builder instance