Package com.ibm.fhir.model.resource

Class ImplementationGuide.Definition.Resource.Builder

    • Method Detail

      • id

        public ImplementationGuide.Definition.Resource.Builder id​(java.lang.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 BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

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

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

      • extension

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

        Overrides:
        extension in class BackboneElement.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.Definition.Resource.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public ImplementationGuide.Definition.Resource.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • fhirVersion

        public ImplementationGuide.Definition.Resource.Builder fhirVersion​(FHIRVersion... fhirVersion)
        Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.

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

        Parameters:
        fhirVersion - Versions this applies to (if different to IG)
        Returns:
        A reference to this Builder instance

      • fhirVersion

        public ImplementationGuide.Definition.Resource.Builder fhirVersion​(java.util.Collection<FHIRVersion> fhirVersion)
        Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.

        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:
        fhirVersion - Versions this applies to (if different to IG)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • name

        public ImplementationGuide.Definition.Resource.Builder name​(String name)
        A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).
        Parameters:
        name - Human Name for the resource
        Returns:
        A reference to this Builder instance

      • description

        public ImplementationGuide.Definition.Resource.Builder description​(String description)
        A description of the reason that a resource has been included in the implementation guide.
        Parameters:
        description - Reason why included in guide
        Returns:
        A reference to this Builder instance

      • example

        public ImplementationGuide.Definition.Resource.Builder example​(Element example)
        If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

        This is a choice element with the following allowed types:

        Parameters:
        example - Is an example/What is this an example of?
        Returns:
        A reference to this Builder instance

      • groupingId

        public ImplementationGuide.Definition.Resource.Builder groupingId​(Id groupingId)
        Reference to the id of the grouping this resource appears in.
        Parameters:
        groupingId - Grouping this is part of
        Returns:
        A reference to this Builder instance