Package com.ibm.fhir.model.type

Class ElementDefinition.Type.Builder

    • Method Detail

      • id

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

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

      • extension

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

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

      • modifierExtension

        public ElementDefinition.Type.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.\n\nModifier 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public ElementDefinition.Type.Builder modifierExtension​(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.\n\nModifier 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • code

        public ElementDefinition.Type.Builder code​(Uri code)
        URL of Data type or Resource that is a(or the) type used for this element. 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:
        code - Data type or Resource (reference to definition)
        Returns:
        A reference to this Builder instance

      • profile

        public ElementDefinition.Type.Builder profile​(Canonical... profile)
        Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.

        Adds new element(s) to the existing list

        Parameters:
        profile - Profiles (StructureDefinition or IG) - one must apply
        Returns:
        A reference to this Builder instance

      • profile

        public ElementDefinition.Type.Builder profile​(Collection<Canonical> profile)
        Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.

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

        Parameters:
        profile - Profiles (StructureDefinition or IG) - one must apply
        Returns:
        A reference to this Builder instance

      • targetProfile

        public ElementDefinition.Type.Builder targetProfile​(Canonical... targetProfile)
        Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

        Adds new element(s) to the existing list

        Parameters:
        targetProfile - Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply
        Returns:
        A reference to this Builder instance

      • targetProfile

        public ElementDefinition.Type.Builder targetProfile​(Collection<Canonical> targetProfile)
        Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

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

        Parameters:
        targetProfile - Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply
        Returns:
        A reference to this Builder instance

      • aggregation

        public ElementDefinition.Type.Builder aggregation​(AggregationMode... aggregation)
        If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.

        Adds new element(s) to the existing list

        Parameters:
        aggregation - contained | referenced | bundled - how aggregated
        Returns:
        A reference to this Builder instance

      • aggregation

        public ElementDefinition.Type.Builder aggregation​(Collection<AggregationMode> aggregation)
        If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.

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

        Parameters:
        aggregation - contained | referenced | bundled - how aggregated
        Returns:
        A reference to this Builder instance

      • versioning

        public ElementDefinition.Type.Builder versioning​(ReferenceVersionRules versioning)
        Whether this reference needs to be version specific or version independent, or whether either can be used.
        Parameters:
        versioning - either | independent | specific
        Returns:
        A reference to this Builder instance