Package org.linuxforhealth.fhir.model.resource

Class ImplementationGuide.Builder

    • Method Detail

      • id

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

      • text

        public ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.Builder url​(Uri url)
        An absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.

        This element is required.

        Parameters:
        url - Canonical identifier for this implementation guide, represented as a URI (globally unique)
        Returns:
        A reference to this Builder instance

      • version

        public ImplementationGuide.Builder version​(String version)
        The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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.
        Parameters:
        version - Business version of the implementation guide
        Returns:
        A reference to this Builder instance

      • name

        public ImplementationGuide.Builder name​(String name)
        A natural language name identifying the implementation guide. 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 implementation guide (computer friendly)
        Returns:
        A reference to this Builder instance

      • title

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

      • status

        public ImplementationGuide.Builder status​(PublicationStatus status)
        The status of this implementation guide. 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

      • experimental

        public ImplementationGuide.Builder experimental​(Boolean experimental)
        A Boolean value to indicate that this implementation guide 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 ImplementationGuide.Builder date​(DateTime date)
        The date (and optionally time) when the implementation guide 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 implementation guide changes.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

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

      • contact

        public ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.Builder description​(Markdown description)
        A free text natural language description of the implementation guide from a consumer's perspective.
        Parameters:
        description - Natural language description of the implementation guide
        Returns:
        A reference to this Builder instance

      • useContext

        public ImplementationGuide.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 implementation guide 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 ImplementationGuide.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 implementation guide 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 ImplementationGuide.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the implementation guide 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 implementation guide (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

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

      • copyright

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

      • packageId

        public ImplementationGuide.Builder packageId​(Id packageId)
        The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.

        This element is required.

        Parameters:
        packageId - NPM Package name for IG
        Returns:
        A reference to this Builder instance

      • license

        public ImplementationGuide.Builder license​(SPDXLicense license)
        The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
        Parameters:
        license - SPDX license code for this IG (or not-open-source)
        Returns:
        A reference to this Builder instance

      • fhirVersion

        public ImplementationGuide.Builder fhirVersion​(FHIRVersion... fhirVersion)
        The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major]. [minor], which is 4.3.0-cibuild. for this version.

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

        This element is required.

        Parameters:
        fhirVersion - FHIR Version(s) this Implementation Guide targets
        Returns:
        A reference to this Builder instance

      • fhirVersion

        public ImplementationGuide.Builder fhirVersion​(java.util.Collection<FHIRVersion> fhirVersion)
        The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major]. [minor], which is 4.3.0-cibuild. for this version.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        This element is required.

        Parameters:
        fhirVersion - FHIR Version(s) this Implementation Guide targets
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • dependsOn

        public ImplementationGuide.Builder dependsOn​(ImplementationGuide.DependsOn... dependsOn)
        Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

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

        Parameters:
        dependsOn - Another Implementation guide this depends on
        Returns:
        A reference to this Builder instance

      • dependsOn

        public ImplementationGuide.Builder dependsOn​(java.util.Collection<ImplementationGuide.DependsOn> dependsOn)
        Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

        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:
        dependsOn - Another Implementation guide this depends on
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • global

        public ImplementationGuide.Builder global​(ImplementationGuide.Global... global)
        A set of profiles that all resources covered by this implementation guide must conform to.

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

        Parameters:
        global - Profiles that apply globally
        Returns:
        A reference to this Builder instance

      • global

        public ImplementationGuide.Builder global​(java.util.Collection<ImplementationGuide.Global> global)
        A set of profiles that all resources covered by this implementation guide must conform to.

        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:
        global - Profiles that apply globally
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • definition

        public ImplementationGuide.Builder definition​(ImplementationGuide.Definition definition)
        The information needed by an IG publisher tool to publish the whole implementation guide.
        Parameters:
        definition - Information needed to build the IG
        Returns:
        A reference to this Builder instance

      • manifest

        public ImplementationGuide.Builder manifest​(ImplementationGuide.Manifest manifest)
        Information about an assembled implementation guide, created by the publication tooling.
        Parameters:
        manifest - Information about an assembled IG
        Returns:
        A reference to this Builder instance