Package org.linuxforhealth.fhir.model.resource

Class CodeSystem.Builder

    • Method Detail

      • id

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

      • url

        public CodeSystem.Builder url​(Uri url)
        An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.
        Parameters:
        url - Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
        Returns:
        A reference to this Builder instance

      • identifier

        public CodeSystem.Builder identifier​(Identifier... identifier)
        A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

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

        Parameters:
        identifier - Additional identifier for the code system (business identifier)
        Returns:
        A reference to this Builder instance

      • identifier

        public CodeSystem.Builder identifier​(java.util.Collection<Identifier> identifier)
        A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

        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 - Additional identifier for the code system (business identifier)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • version

        public CodeSystem.Builder version​(String version)
        The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes. html#Coding).version.
        Parameters:
        version - Business version of the code system (Coding.version)
        Returns:
        A reference to this Builder instance

      • name

        public CodeSystem.Builder name​(String name)
        A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        Parameters:
        name - Name for this code system (computer friendly)
        Returns:
        A reference to this Builder instance

      • title

        public CodeSystem.Builder title​(String title)
        A short, descriptive, user-friendly title for the code system.
        Parameters:
        title - Name for this code system (human friendly)
        Returns:
        A reference to this Builder instance

      • status

        public CodeSystem.Builder status​(PublicationStatus status)
        The date (and optionally time) when the code system resource was created or revised.

        This element is required.

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

      • experimental

        public CodeSystem.Builder experimental​(Boolean experimental)
        A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Parameters:
        experimental - For testing purposes, not real usage
        Returns:
        A reference to this Builder instance

      • date

        public CodeSystem.Builder date​(DateTime date)
        The date (and optionally time) when the code 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 code system changes.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

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

      • contact

        public CodeSystem.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. If any of the elements are null, calling build() will fail.

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

      • contact

        public CodeSystem.Builder contact​(java.util.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. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public CodeSystem.Builder description​(Markdown description)
        A free text natural language description of the code system from a consumer's perspective.
        Parameters:
        description - Natural language description of the code system
        Returns:
        A reference to this Builder instance

      • useContext

        public CodeSystem.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 code system instances.

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

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

      • useContext

        public CodeSystem.Builder useContext​(java.util.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 code system instances.

        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:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • jurisdiction

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

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

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

      • jurisdiction

        public CodeSystem.Builder jurisdiction​(java.util.Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the code system is intended to be 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:
        jurisdiction - Intended jurisdiction for code system (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • purpose

        public CodeSystem.Builder purpose​(Markdown purpose)
        Explanation of why this code system is needed and why it has been designed as it has.
        Parameters:
        purpose - Why this code system is defined
        Returns:
        A reference to this Builder instance

      • copyright

        public CodeSystem.Builder copyright​(Markdown copyright)
        A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
        Parameters:
        copyright - Use and/or publishing restrictions
        Returns:
        A reference to this Builder instance

      • caseSensitive

        public CodeSystem.Builder caseSensitive​(Boolean caseSensitive)
        If code comparison is case sensitive when codes within this system are compared to each other.
        Parameters:
        caseSensitive - If code comparison is case sensitive
        Returns:
        A reference to this Builder instance

      • valueSet

        public CodeSystem.Builder valueSet​(Canonical valueSet)
        Canonical reference to the value set that contains the entire code system.
        Parameters:
        valueSet - Canonical reference to the value set with entire code system
        Returns:
        A reference to this Builder instance

      • hierarchyMeaning

        public CodeSystem.Builder hierarchyMeaning​(CodeSystemHierarchyMeaning hierarchyMeaning)
        The meaning of the hierarchy of concepts as represented in this resource.
        Parameters:
        hierarchyMeaning - grouped-by | is-a | part-of | classified-with
        Returns:
        A reference to this Builder instance

      • compositional

        public CodeSystem.Builder compositional​(Boolean compositional)
        The code system defines a compositional (post-coordination) grammar.
        Parameters:
        compositional - If code system defines a compositional grammar
        Returns:
        A reference to this Builder instance

      • versionNeeded

        public CodeSystem.Builder versionNeeded​(Boolean versionNeeded)
        This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.
        Parameters:
        versionNeeded - If definitions are not stable
        Returns:
        A reference to this Builder instance

      • content

        public CodeSystem.Builder content​(CodeSystemContentMode content)
        The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

        This element is required.

        Parameters:
        content - not-present | example | fragment | complete | supplement
        Returns:
        A reference to this Builder instance

      • supplements

        public CodeSystem.Builder supplements​(Canonical supplements)
        The canonical URL of the code system that this code system supplement is adding designations and properties to.
        Parameters:
        supplements - Canonical URL of Code System this adds designations and properties to
        Returns:
        A reference to this Builder instance

      • count

        public CodeSystem.Builder count​(UnsignedInt count)
        The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.
        Parameters:
        count - Total concepts in the code system
        Returns:
        A reference to this Builder instance

      • filter

        public CodeSystem.Builder filter​(CodeSystem.Filter... filter)
        A filter that can be used in a value set compose statement when selecting concepts using a filter.

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

        Parameters:
        filter - Filter that can be used in a value set
        Returns:
        A reference to this Builder instance

      • filter

        public CodeSystem.Builder filter​(java.util.Collection<CodeSystem.Filter> filter)
        A filter that can be used in a value set compose statement when selecting concepts using a filter.

        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:
        filter - Filter that can be used in a value set
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • property

        public CodeSystem.Builder property​(CodeSystem.Property... property)
        A property defines an additional slot through which additional information can be provided about a concept.

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

        Parameters:
        property - Additional information supplied about each concept
        Returns:
        A reference to this Builder instance

      • property

        public CodeSystem.Builder property​(java.util.Collection<CodeSystem.Property> property)
        A property defines an additional slot through which additional information can be provided about a concept.

        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:
        property - Additional information supplied about each concept
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • concept

        public CodeSystem.Builder concept​(CodeSystem.Concept... concept)
        Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

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

        Parameters:
        concept - Concepts in the code system
        Returns:
        A reference to this Builder instance

      • concept

        public CodeSystem.Builder concept​(java.util.Collection<CodeSystem.Concept> concept)
        Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

        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:
        concept - Concepts in the code system
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validate

        protected void validate​(CodeSystem codeSystem)