Package com.ibm.fhir.model.resource

Class StructureDefinition.Builder

    • Method Detail

      • id

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

        This element is required.

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

      • identifier

        public StructureDefinition.Builder identifier​(Identifier... identifier)
        A formal identifier that is used to identify this structure definition 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 structure definition
        Returns:
        A reference to this Builder instance

      • identifier

        public StructureDefinition.Builder identifier​(java.util.Collection<Identifier> identifier)
        A formal identifier that is used to identify this structure definition 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 structure definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • version

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

      • name

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

      • title

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

      • status

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

      • publisher

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

      • contact

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

      • useContext

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

      • jurisdiction

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

      • purpose

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

      • copyright

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

      • keyword

        public StructureDefinition.Builder keyword​(Coding... keyword)
        A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.

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

        Parameters:
        keyword - Assist with indexing and finding
        Returns:
        A reference to this Builder instance

      • keyword

        public StructureDefinition.Builder keyword​(java.util.Collection<Coding> keyword)
        A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.

        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:
        keyword - Assist with indexing and finding
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • fhirVersion

        public StructureDefinition.Builder fhirVersion​(FHIRVersion fhirVersion)
        The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.
        Parameters:
        fhirVersion - FHIR Version this StructureDefinition targets
        Returns:
        A reference to this Builder instance

      • mapping

        public StructureDefinition.Builder mapping​(StructureDefinition.Mapping... mapping)
        An external specification that the content is mapped to.

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

        Parameters:
        mapping - External specification that the content is mapped to
        Returns:
        A reference to this Builder instance

      • mapping

        public StructureDefinition.Builder mapping​(java.util.Collection<StructureDefinition.Mapping> mapping)
        An external specification that the content is mapped 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:
        mapping - External specification that the content is mapped to
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • kind

        public StructureDefinition.Builder kind​(StructureDefinitionKind kind)
        Defines the kind of structure that this definition is describing.

        This element is required.

        Parameters:
        kind - primitive-type | complex-type | resource | logical
        Returns:
        A reference to this Builder instance

      • _abstract

        public StructureDefinition.Builder _abstract​(Boolean _abstract)
        Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.

        This element is required.

        Parameters:
        _abstract - Whether the structure is abstract
        Returns:
        A reference to this Builder instance

      • context

        public StructureDefinition.Builder context​(StructureDefinition.Context... context)
        Identifies the types of resource or data type elements to which the extension can be applied.

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

        Parameters:
        context - If an extension, where it can be used in instances
        Returns:
        A reference to this Builder instance

      • context

        public StructureDefinition.Builder context​(java.util.Collection<StructureDefinition.Context> context)
        Identifies the types of resource or data type elements to which the extension can be applied.

        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:
        context - If an extension, where it can be used in instances
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • contextInvariant

        public StructureDefinition.Builder contextInvariant​(java.lang.String... contextInvariant)
        Convenience method for setting contextInvariant.

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

        Parameters:
        contextInvariant - FHIRPath invariants - when the extension can be used
        Returns:
        A reference to this Builder instance
        See Also:
        #contextInvariant(com.ibm.fhir.model.type.String)

      • contextInvariant

        public StructureDefinition.Builder contextInvariant​(String... contextInvariant)
        A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.

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

        Parameters:
        contextInvariant - FHIRPath invariants - when the extension can be used
        Returns:
        A reference to this Builder instance

      • contextInvariant

        public StructureDefinition.Builder contextInvariant​(java.util.Collection<String> contextInvariant)
        A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.

        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:
        contextInvariant - FHIRPath invariants - when the extension can be used
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • type

        public StructureDefinition.Builder type​(Uri type)
        The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http: //hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.

        This element is required.

        Parameters:
        type - Type defined or constrained by this structure
        Returns:
        A reference to this Builder instance

      • baseDefinition

        public StructureDefinition.Builder baseDefinition​(Canonical baseDefinition)
        An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
        Parameters:
        baseDefinition - Definition that this type is constrained/specialized from
        Returns:
        A reference to this Builder instance

      • derivation

        public StructureDefinition.Builder derivation​(TypeDerivationRule derivation)
        How the type relates to the baseDefinition.
        Parameters:
        derivation - specialization | constraint - How relates to base definition
        Returns:
        A reference to this Builder instance

      • snapshot

        public StructureDefinition.Builder snapshot​(StructureDefinition.Snapshot snapshot)
        A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.
        Parameters:
        snapshot - Snapshot view of the structure
        Returns:
        A reference to this Builder instance

      • differential

        public StructureDefinition.Builder differential​(StructureDefinition.Differential differential)
        A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
        Parameters:
        differential - Differential view of the structure
        Returns:
        A reference to this Builder instance