Release 5 Preview #3

Codesystem-data-types.json

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Code System DataType

{
  "resourceType" : "CodeSystem",
  "id" : "data-types",
  "meta" : {
    "lastUpdated" : "2020-09-21T18:14:19.896+00:00"
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-special-status",
    "valueString" : "This Code System is normative - it is generated based on the information defined in this specification. The definition will remain fixed  across versions, but the actual contents will change from version to version"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  }],
  "url" : "http://hl7.org/fhir/data-types",
  "version" : "4.5.0",
  "name" : "DataType",
  "title" : "DataType",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-09-21T18:14:19+00:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "A version specific list of the data types defined by the FHIR specification for use as an element  type (any of the FHIR defined data types).",
  "caseSensitive" : true,
  "content" : "complete",
  "concept" : [{
    "code" : "Address",
    "display" : "Address",
    "definition" : "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."
  },
  {
    "code" : "Age",
    "display" : "Age",
    "definition" : "A duration of time during which an organism (or a process) has existed."
  },
  {
    "code" : "Annotation",
    "display" : "Annotation",
    "definition" : "A  text note which also  contains information about who made the statement and when."
  },
  {
    "code" : "Attachment",
    "display" : "Attachment",
    "definition" : "For referring to data content defined in other formats."
  },
  {
    "code" : "BackboneElement",
    "display" : "BackboneElement",
    "definition" : "Base definition for all elements that are defined inside a resource - but not those in a data type."
  },
  {
    "code" : "BackboneType",
    "display" : "BackboneType",
    "definition" : "Base definition for the few data types that are allowed to carry modifier extensions."
  },
  {
    "code" : "Base",
    "display" : "Base",
    "definition" : "Base definition for all types defined in FHIR type system."
  },
  {
    "code" : "CodeableConcept",
    "display" : "CodeableConcept",
    "definition" : "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text."
  },
  {
    "code" : "CodeableReference",
    "display" : "CodeableReference",
    "definition" : "A reference to a resource (by instance), or instead, a reference to a cencept defined in a terminology or ontology (by class)."
  },
  {
    "code" : "Coding",
    "display" : "Coding",
    "definition" : "A reference to a code defined by a terminology system."
  },
  {
    "code" : "ContactDetail",
    "display" : "ContactDetail",
    "definition" : "Specifies contact information for a person or organization."
  },
  {
    "code" : "ContactPoint",
    "display" : "ContactPoint",
    "definition" : "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc."
  },
  {
    "code" : "Contributor",
    "display" : "Contributor",
    "definition" : "A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers."
  },
  {
    "code" : "Count",
    "display" : "Count",
    "definition" : "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."
  },
  {
    "code" : "DataRequirement",
    "display" : "DataRequirement",
    "definition" : "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data."
  },
  {
    "code" : "DataType",
    "display" : "DataType",
    "definition" : "The base class for all re-useable types defined as part of the FHIR Specification."
  },
  {
    "code" : "Distance",
    "display" : "Distance",
    "definition" : "A length - a value with a unit that is a physical distance."
  },
  {
    "code" : "Dosage",
    "display" : "Dosage",
    "definition" : "Indicates how the medication is/was taken or should be taken by the patient."
  },
  {
    "code" : "Duration",
    "display" : "Duration",
    "definition" : "A length of time."
  },
  {
    "code" : "Element",
    "display" : "Element",
    "definition" : "Base definition for all elements in a resource."
  },
  {
    "code" : "ElementDefinition",
    "display" : "ElementDefinition",
    "definition" : "Captures constraints on each element within the resource, profile, or extension."
  },
  {
    "code" : "Expression",
    "display" : "Expression",
    "definition" : "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."
  },
  {
    "code" : "Extension",
    "display" : "Extension",
    "definition" : "Optional Extension Element - found in all resources."
  },
  {
    "code" : "HumanName",
    "display" : "HumanName",
    "definition" : "A human's name with the ability to identify parts and usage."
  },
  {
    "code" : "Identifier",
    "display" : "Identifier",
    "definition" : "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers."
  },
  {
    "code" : "MarketingStatus",
    "display" : "MarketingStatus",
    "definition" : "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."
  },
  {
    "code" : "Meta",
    "display" : "Meta",
    "definition" : "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."
  },
  {
    "code" : "Money",
    "display" : "Money",
    "definition" : "An amount of economic utility in some recognized currency."
  },
  {
    "code" : "MoneyQuantity",
    "display" : "MoneyQuantity"
  },
  {
    "code" : "Narrative",
    "display" : "Narrative",
    "definition" : "A human-readable summary of the resource conveying the essential clinical and business information for the resource."
  },
  {
    "code" : "OrderedDistribution",
    "display" : "OrderedDistribution",
    "definition" : "An ordered list (distribution) of statistics."
  },
  {
    "code" : "ParameterDefinition",
    "display" : "ParameterDefinition",
    "definition" : "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."
  },
  {
    "code" : "Period",
    "display" : "Period",
    "definition" : "A time period defined by a start and end date and optionally time."
  },
  {
    "code" : "Population",
    "display" : "Population",
    "definition" : "A populatioof people with some set of grouping criteria."
  },
  {
    "code" : "PrimitiveType",
    "display" : "PrimitiveType",
    "definition" : "The base type for all re-useable types defined that have a simple property."
  },
  {
    "code" : "ProdCharacteristic",
    "display" : "ProdCharacteristic",
    "definition" : "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."
  },
  {
    "code" : "ProductShelfLife",
    "display" : "ProductShelfLife",
    "definition" : "The shelf-life and storage information for a medicinal product item or container can be described using this class."
  },
  {
    "code" : "Quantity",
    "display" : "Quantity",
    "definition" : "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."
  },
  {
    "code" : "Range",
    "display" : "Range",
    "definition" : "A set of ordered Quantities defined by a low and high limit."
  },
  {
    "code" : "Ratio",
    "display" : "Ratio",
    "definition" : "A relationship of two Quantity values - expressed as a numerator and a denominator."
  },
  {
    "code" : "Reference",
    "display" : "Reference",
    "definition" : "A reference from one resource to another."
  },
  {
    "code" : "RelatedArtifact",
    "display" : "RelatedArtifact",
    "definition" : "Related artifacts such as additional documentation, justification, or bibliographic references."
  },
  {
    "code" : "SampledData",
    "display" : "SampledData",
    "definition" : "A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data."
  },
  {
    "code" : "Signature",
    "display" : "Signature",
    "definition" : "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."
  },
  {
    "code" : "SimpleQuantity",
    "display" : "SimpleQuantity"
  },
  {
    "code" : "Statistic",
    "display" : "Statistic",
    "definition" : "A fact or piece of data from a  study of a large quantity of numerical data.  A mathematical or quantified characteristic of a group of observations."
  },
  {
    "code" : "Timing",
    "display" : "Timing",
    "definition" : "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."
  },
  {
    "code" : "TriggerDefinition",
    "display" : "TriggerDefinition",
    "definition" : "A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element."
  },
  {
    "code" : "UsageContext",
    "display" : "UsageContext",
    "definition" : "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" : "base64Binary",
    "display" : "base64Binary",
    "definition" : "A stream of bytes"
  },
  {
    "code" : "boolean",
    "display" : "boolean",
    "definition" : "Value of \"true\" or \"false\""
  },
  {
    "code" : "canonical",
    "display" : "canonical",
    "definition" : "A URI that is a reference to a canonical URL on a FHIR resource"
  },
  {
    "code" : "code",
    "display" : "code",
    "definition" : "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"
  },
  {
    "code" : "date",
    "display" : "date",
    "definition" : "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."
  },
  {
    "code" : "dateTime",
    "display" : "dateTime",
    "definition" : "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."
  },
  {
    "code" : "decimal",
    "display" : "decimal",
    "definition" : "A rational number with implicit precision"
  },
  {
    "code" : "id",
    "display" : "id",
    "definition" : "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."
  },
  {
    "code" : "instant",
    "display" : "instant",
    "definition" : "An instant in time - known at least to the second"
  },
  {
    "code" : "integer",
    "display" : "integer",
    "definition" : "A whole number"
  },
  {
    "code" : "integer64",
    "display" : "integer64",
    "definition" : "A very large whole number"
  },
  {
    "code" : "markdown",
    "display" : "markdown",
    "definition" : "A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine"
  },
  {
    "code" : "oid",
    "display" : "oid",
    "definition" : "An OID represented as a URI"
  },
  {
    "code" : "positiveInt",
    "display" : "positiveInt",
    "definition" : "An integer with a value that is positive (e.g. >0)"
  },
  {
    "code" : "string",
    "display" : "string",
    "definition" : "A sequence of Unicode characters"
  },
  {
    "code" : "time",
    "display" : "time",
    "definition" : "A time during the day, with no date specified"
  },
  {
    "code" : "unsignedInt",
    "display" : "unsignedInt",
    "definition" : "An integer with a value that is not negative (e.g. >= 0)"
  },
  {
    "code" : "uri",
    "display" : "uri",
    "definition" : "String of characters used to identify a name or a resource"
  },
  {
    "code" : "url",
    "display" : "url",
    "definition" : "A URI that is a literal reference"
  },
  {
    "code" : "uuid",
    "display" : "uuid",
    "definition" : "A UUID, represented as a URI"
  },
  {
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
      "valueString" : "Special case: xhtml can only be used in the narrative Data Type"
    }],
    "code" : "xhtml",
    "display" : "XHTML",
    "definition" : "XHTML format, as defined by W3C, but restricted usage (mainly, no active content)"
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.