Package ca.uhn.fhir.model.api.annotation

Annotation Type DatatypeDef

@Retention(RUNTIME) @Target(TYPE) public @interface DatatypeDef
Class annotation to note a class which defines a datatype

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The defined name of this datatype

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    isSpecialization
    Set this to true (default is false) for any types that are really only a specialization of another type.
    Class<? extends IBaseDatatype>
    profileOf
    Indicates that this datatype is a profile of the given datatype, which implies certain parsing/encoding rules (e.g.

  • Element Details

    • name

      String name
      The defined name of this datatype

    • isSpecialization

      boolean isSpecialization
      Set this to true (default is false) for any types that are really only a specialization of another type. For example, BoundCodeDt is really just a specific type of CodeDt and not a separate datatype, so it should have this set to true.
      Default:
      false

    • profileOf

      Class<? extends IBaseDatatype> profileOf
      Indicates that this datatype is a profile of the given datatype, which implies certain parsing/encoding rules (e.g. a choice element named foo[x] which allows a Markdown value will still be encoded as fooString because Markdown is a profile of string.
      Default:
      org.hl7.fhir.instance.model.api.IBaseDatatype.class