Package org.linuxforhealth.fhir.model.annotation

Annotation Type Binding

  • @Target({FIELD,TYPE})
@Retention(RUNTIME)
public @interface Binding
    Used to annotate coded elements that are bound to a value set.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      BindingStrength.Value strength
      Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String bindingName
      A name that can be used for code generation when generating named enumerations for the binding.
      java.lang.String description
      Describes the intended use of this particular set of codes.
      java.lang.String inheritedExtensibleValueSet
      A reference to an extensible value set specified in a parent profile in order to allow a conformance checking tool to validate that a code not in the extensible value set of the profile is not violating rules defined by parent profile bindings.
      java.lang.String maxValueSet
      The maximum allowable value set, for use when the binding strength is 'extensible' or 'preferred'.
      java.lang.String minValueSet
      The minimum allowable value set, for use when the binding strength is 'required' or 'extensible'.
      java.lang.String valueSet
      Refers to the value set that identifies the set of codes the binding refers to.

    • Element Detail

      • strength

        BindingStrength.Value strength
        Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
        Returns:
        the binding strength

      • bindingName

        java.lang.String bindingName
        A name that can be used for code generation when generating named enumerations for the binding.
        Returns:
        the binding name
        Default:
        ""

      • description

        java.lang.String description
        Describes the intended use of this particular set of codes.
        Returns:
        the description
        Default:
        ""

      • valueSet

        java.lang.String valueSet
        Refers to the value set that identifies the set of codes the binding refers to.
        Returns:
        the value set
        Default:
        ""

      • inheritedExtensibleValueSet

        java.lang.String inheritedExtensibleValueSet
        A reference to an extensible value set specified in a parent profile in order to allow a conformance checking tool to validate that a code not in the extensible value set of the profile is not violating rules defined by parent profile bindings.
        Returns:
        the inherited extensible value set
        Default:
        ""

      • minValueSet

        java.lang.String minValueSet
        The minimum allowable value set, for use when the binding strength is 'required' or 'extensible'. This value set is the minimum value set that any conformant system SHALL support.
        Returns:
        the minimum allowable value set
        Default:
        ""

      • maxValueSet

        java.lang.String maxValueSet
        The maximum allowable value set, for use when the binding strength is 'extensible' or 'preferred'. This value set is the value set from which additional codes can be taken from. This defines a 'required' binding over the top of the extensible binding.
        Returns:
        the maximum allowable value set
        Default:
        ""