Package org.hl7.fhir.dstu3.model.codesystems

Enum DataTypes

java.lang.Object
java.lang.Enum<DataTypes>
org.hl7.fhir.dstu3.model.codesystems.DataTypes
All Implemented Interfaces:
Serializable, Comparable<DataTypes>
public enum DataTypes extends Enum<DataTypes>

  • 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"
    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.
    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
    A technical 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 markdown syntax for optional processing by a mark down presentation engine
    META
    The metadata about a resource.
    MONEY
    An amount of economic utility in some recognized currency.
    NARRATIVE
    A human-readable formatted text, including images.
    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.
    POSITIVEINT
    An integer with a value that is positive (e.g.
    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 digital signature along with supporting context.
    SIMPLEQUANTITY
    null
    STRING
    A sequence of Unicode characters
    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
    USAGECONTEXT
    Specifies clinical/business/etc metadata that can be used to retrieve, index and/or categorize an artifact.
    UUID
    A UUID, represented as a URI
    XHTML
    XHTML format, as defined by W3C, but restricted usage (mainly, no active content)

  • Method Summary

    Modifier and Type
    Method
    Description
    static DataTypes
    fromCode(String codeString)
     
    String
    getDefinition()
     
    String
    getDisplay()
     
    String
    getSystem()
     
    String
    toCode()
     
    static DataTypes
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static DataTypes[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ADDRESS

      public static final DataTypes 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 DataTypes AGE
      A duration of time during which an organism (or a process) has existed.

    • ANNOTATION

      public static final DataTypes ANNOTATION
      A text note which also contains information about who made the statement and when.

    • ATTACHMENT

      public static final DataTypes ATTACHMENT
      For referring to data content defined in other formats.

    • BACKBONEELEMENT

      public static final DataTypes BACKBONEELEMENT
      Base definition for all elements that are defined inside a resource - but not those in a data type.

    • CODEABLECONCEPT

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

    • CODING

      public static final DataTypes CODING
      A reference to a code defined by a terminology system.

    • CONTACTDETAIL

      public static final DataTypes CONTACTDETAIL
      Specifies contact information for a person or organization.

    • CONTACTPOINT

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

    • CONTRIBUTOR

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

    • COUNT

      public static final DataTypes 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 DataTypes 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.

    • DISTANCE

      public static final DataTypes DISTANCE
      A length - a value with a unit that is a physical distance.

    • DOSAGE

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

    • DURATION

      public static final DataTypes DURATION
      A length of time.

    • ELEMENT

      public static final DataTypes ELEMENT
      Base definition for all elements in a resource.

    • ELEMENTDEFINITION

      public static final DataTypes ELEMENTDEFINITION
      Captures constraints on each element within the resource, profile, or extension.

    • EXTENSION

      public static final DataTypes EXTENSION
      Optional Extension Element - found in all resources.

    • HUMANNAME

      public static final DataTypes HUMANNAME
      A human's name with the ability to identify parts and usage.

    • IDENTIFIER

      public static final DataTypes IDENTIFIER
      A technical identifier - identifies some entity uniquely and unambiguously.

    • META

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

    • MONEY

      public static final DataTypes MONEY
      An amount of economic utility in some recognized currency.

    • NARRATIVE

      public static final DataTypes NARRATIVE
      A human-readable formatted text, including images.

    • PARAMETERDEFINITION

      public static final DataTypes 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.

    • PERIOD

      public static final DataTypes PERIOD
      A time period defined by a start and end date and optionally time.

    • QUANTITY

      public static final DataTypes 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.

    • RANGE

      public static final DataTypes RANGE
      A set of ordered Quantities defined by a low and high limit.

    • RATIO

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

    • REFERENCE

      public static final DataTypes REFERENCE
      A reference from one resource to another.

    • RELATEDARTIFACT

      public static final DataTypes RELATEDARTIFACT
      Related artifacts such as additional documentation, justification, or bibliographic references.

    • SAMPLEDDATA

      public static final DataTypes 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 DataTypes SIGNATURE
      A digital signature along with supporting context. The signature may be electronic/cryptographic in nature, or a graphical image representing a hand-written signature, or a signature process. Different signature approaches have different utilities.

    • SIMPLEQUANTITY

      public static final DataTypes SIMPLEQUANTITY
      null

    • TIMING

      public static final DataTypes 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 DataTypes TRIGGERDEFINITION
      A description of a triggering event.

    • USAGECONTEXT

      public static final DataTypes 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).

    • BASE64BINARY

      public static final DataTypes BASE64BINARY
      A stream of bytes

    • BOOLEAN

      public static final DataTypes BOOLEAN
      Value of "true" or "false"

    • CODE

      public static final DataTypes 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 DataTypes 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 DataTypes 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.

    • DECIMAL

      public static final DataTypes DECIMAL
      A rational number with implicit precision

    • ID

      public static final DataTypes 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.

    • INSTANT

      public static final DataTypes INSTANT
      An instant in time - known at least to the second

    • INTEGER

      public static final DataTypes INTEGER
      A whole number

    • MARKDOWN

      public static final DataTypes MARKDOWN
      A string that may contain markdown syntax for optional processing by a mark down presentation engine

    • OID

      public static final DataTypes OID
      An OID represented as a URI

    • POSITIVEINT

      public static final DataTypes POSITIVEINT
      An integer with a value that is positive (e.g. >0)

    • STRING

      public static final DataTypes STRING
      A sequence of Unicode characters

    • TIME

      public static final DataTypes TIME
      A time during the day, with no date specified

    • UNSIGNEDINT

      public static final DataTypes UNSIGNEDINT
      An integer with a value that is not negative (e.g. >= 0)

    • URI

      public static final DataTypes URI
      String of characters used to identify a name or a resource

    • UUID

      public static final DataTypes UUID
      A UUID, represented as a URI

    • XHTML

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

    • NULL

      public static final DataTypes NULL
      added to help the parsers

  • Method Details

    • values

      public static DataTypes[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static DataTypes 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

    • fromCode

      public static DataTypes fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • toCode

      public String toCode()

    • getSystem

      public String getSystem()

    • getDefinition

      public String getDefinition()

    • getDisplay

      public String getDisplay()