Package org.hl7.fhir.r4.model

Enum Enumerations.DataType

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADDRESS
      An address expressed using postal conventions (as opposed to GPS or other location definition formats).
      AGE
      A duration of time during which an organism (or a process) has existed.
      ANNOTATION
      A text note which also contains information about who made the statement and when.
      ATTACHMENT
      For referring to data content defined in other formats.
      BACKBONEELEMENT
      Base definition for all elements that are defined inside a resource - but not those in a data type.
      BASE64BINARY
      A stream of bytes
      BOOLEAN
      Value of "true" or "false"
      CANONICAL
      A URI that is a reference to a canonical URL on a FHIR resource
      CODE
      A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
      CODEABLECONCEPT
      A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
      CODING
      A reference to a code defined by a terminology system.
      CONTACTDETAIL
      Specifies contact information for a person or organization.
      CONTACTPOINT
      Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
      CONTRIBUTOR
      A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
      COUNT
      A measured amount (or an amount that can potentially be measured).
      DATAREQUIREMENT
      Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
      DATE
      A date or partial date (e.g.
      DATETIME
      A date, date-time or partial date (e.g.
      DECIMAL
      A rational number with implicit precision
      DISTANCE
      A length - a value with a unit that is a physical distance.
      DOSAGE
      Indicates how the medication is/was taken or should be taken by the patient.
      DURATION
      A length of time.
      ELEMENT
      Base definition for all elements in a resource.
      ELEMENTDEFINITION
      Captures constraints on each element within the resource, profile, or extension.
      EXPRESSION
      A expression that is evaluated in a specified context and returns a value.
      EXTENSION
      Optional Extension Element - found in all resources.
      HUMANNAME
      A human's name with the ability to identify parts and usage.
      ID
      Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.
      IDENTIFIER
      An identifier - identifies some entity uniquely and unambiguously.
      INSTANT
      An instant in time - known at least to the second
      INTEGER
      A whole number
      MARKDOWN
      A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
      MARKETINGSTATUS
      The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
      META
      The metadata about a resource.
      MONEY
      An amount of economic utility in some recognized currency.
      MONEYQUANTITY
      null
      NARRATIVE
      A human-readable summary of the resource conveying the essential clinical and business information for the resource.
      NULL
      added to help the parsers
      OID
      An OID represented as a URI
      PARAMETERDEFINITION
      The parameters to the module.
      PERIOD
      A time period defined by a start and end date and optionally time.
      POPULATION
      A populatioof people with some set of grouping criteria.
      POSITIVEINT
      An integer with a value that is positive (e.g.
      PRODCHARACTERISTIC
      The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
      PRODUCTSHELFLIFE
      The shelf-life and storage information for a medicinal product item or container can be described using this class.
      QUANTITY
      A measured amount (or an amount that can potentially be measured).
      RANGE
      A set of ordered Quantities defined by a low and high limit.
      RATIO
      A relationship of two Quantity values - expressed as a numerator and a denominator.
      REFERENCE
      A reference from one resource to another.
      RELATEDARTIFACT
      Related artifacts such as additional documentation, justification, or bibliographic references.
      SAMPLEDDATA
      A series of measurements taken by a device, with upper and lower limits.
      SIGNATURE
      A signature along with supporting context.
      SIMPLEQUANTITY
      null
      STRING
      A sequence of Unicode characters
      SUBSTANCEAMOUNT
      Chemical substances are a single substance type whose primary defining element is the molecular structure.
      TIME
      A time during the day, with no date specified
      TIMING
      Specifies an event that may occur multiple times.
      TRIGGERDEFINITION
      A description of a triggering event.
      UNSIGNEDINT
      An integer with a value that is not negative (e.g.
      URI
      String of characters used to identify a name or a resource
      URL
      A URI that is a literal reference
      USAGECONTEXT
      Specifies clinical/business/etc.
      UUID
      A UUID, represented as a URI
      XHTML
      XHTML format, as defined by W3C, but restricted usage (mainly, no active content)

    • Enum Constant Detail

      • ADDRESS

        public static final Enumerations.DataType ADDRESS
        An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

      • AGE

        public static final Enumerations.DataType AGE
        A duration of time during which an organism (or a process) has existed.

      • CODEABLECONCEPT

        public static final Enumerations.DataType CODEABLECONCEPT
        A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

      • CONTACTPOINT

        public static final Enumerations.DataType CONTACTPOINT
        Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

      • CONTRIBUTOR

        public static final Enumerations.DataType CONTRIBUTOR
        A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.

      • COUNT

        public static final Enumerations.DataType COUNT
        A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

      • DATAREQUIREMENT

        public static final Enumerations.DataType DATAREQUIREMENT
        Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

      • DOSAGE

        public static final Enumerations.DataType DOSAGE
        Indicates how the medication is/was taken or should be taken by the patient.

      • EXPRESSION

        public static final Enumerations.DataType EXPRESSION
        A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.

      • IDENTIFIER

        public static final Enumerations.DataType IDENTIFIER
        An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

      • MARKETINGSTATUS

        public static final Enumerations.DataType MARKETINGSTATUS
        The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.

      • META

        public static final Enumerations.DataType META
        The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      • NARRATIVE

        public static final Enumerations.DataType NARRATIVE
        A human-readable summary of the resource conveying the essential clinical and business information for the resource.

      • PARAMETERDEFINITION

        public static final Enumerations.DataType PARAMETERDEFINITION
        The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

      • PRODCHARACTERISTIC

        public static final Enumerations.DataType PRODCHARACTERISTIC
        The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.

      • PRODUCTSHELFLIFE

        public static final Enumerations.DataType PRODUCTSHELFLIFE
        The shelf-life and storage information for a medicinal product item or container can be described using this class.

      • QUANTITY

        public static final Enumerations.DataType QUANTITY
        A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

      • RATIO

        public static final Enumerations.DataType RATIO
        A relationship of two Quantity values - expressed as a numerator and a denominator.

      • SAMPLEDDATA

        public static final Enumerations.DataType SAMPLEDDATA
        A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

      • SIGNATURE

        public static final Enumerations.DataType SIGNATURE
        A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

      • SUBSTANCEAMOUNT

        public static final Enumerations.DataType SUBSTANCEAMOUNT
        Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.

      • TIMING

        public static final Enumerations.DataType TIMING
        Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

      • TRIGGERDEFINITION

        public static final Enumerations.DataType TRIGGERDEFINITION
        A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

      • USAGECONTEXT

        public static final Enumerations.DataType USAGECONTEXT
        Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).

      • CODE

        public static final Enumerations.DataType CODE
        A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

      • DATE

        public static final Enumerations.DataType DATE
        A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.

      • DATETIME

        public static final Enumerations.DataType DATETIME
        A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

      • ID

        public static final Enumerations.DataType ID
        Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

      • MARKDOWN

        public static final Enumerations.DataType MARKDOWN
        A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine

      • XHTML

        public static final Enumerations.DataType XHTML
        XHTML format, as defined by W3C, but restricted usage (mainly, no active content)

    • Method Detail

      • values

        public static Enumerations.DataType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Enumerations.DataType c : Enumerations.DataType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Enumerations.DataType valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null