STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Codesystem-data-types.json

Raw JSON (canonical form)

Definition for Code System DataType

{
  "resourceType": "CodeSystem",
  "id": "data-types",
  "meta": {
    "lastUpdated": "2016-03-31T08:01:25.570+11:00"
  },
  "text": {
    "status": "extensions",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/data-types",
  "version": "1.4.0",
  "name": "DataType",
  "status": "draft",
  "experimental": false,
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "date": "2016-03-31T08:01:25+11:00",
  "description": "The type of an element - one of the FHIR data types.",
  "caseSensitive": true,
  "valueSet": "http://hl7.org/fhir/ValueSet/data-types",
  "content": "complete",
  "concept": [
    {
      "code": "ActionDefinition",
      "display": "ActionDefinition",
      "definition": "The definition of an action to be performed. Some aspects of the definition are specified statically, and some aspects can be specified dynamically by referencing logic defined in a library."
    },
    {
      "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 and which might not be valid for mail delivery.  There are a variety of postal address formats defined around the world."
    },
    {
      "code": "Age",
      "display": "Age"
    },
    {
      "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": "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": "Coding",
      "display": "Coding",
      "definition": "A reference to a code defined by a terminology system."
    },
    {
      "code": "ContactPoint",
      "display": "ContactPoint",
      "definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc."
    },
    {
      "code": "Count",
      "display": "Count"
    },
    {
      "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": "Distance",
      "display": "Distance"
    },
    {
      "code": "Duration",
      "display": "Duration"
    },
    {
      "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": "Extension",
      "display": "Extension",
      "definition": "Optional Extensions 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": "A technical identifier - identifies some entity uniquely and unambiguously."
    },
    {
      "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 may not always be associated with version changes to the resource."
    },
    {
      "code": "ModuleMetadata",
      "display": "ModuleMetadata",
      "definition": "The ModuleMetadata structure defines the common metadata elements used by quality improvement artifacts. This information includes descriptive and topical metadata to enable repository searches, as well as governance and evidentiary support information."
    },
    {
      "code": "Money",
      "display": "Money"
    },
    {
      "code": "Narrative",
      "display": "Narrative",
      "definition": "A human-readable formatted text, including images."
    },
    {
      "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": "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": "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 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."
    },
    {
      "code": "SimpleQuantity",
      "display": "SimpleQuantity"
    },
    {
      "code": "Timing",
      "display": "Timing",
      "definition": "Specifies an event that may occur multiple times. Timing schedules are used to record when things are 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."
    },
    {
      "code": "TriggerDefinition",
      "display": "TriggerDefinition",
      "definition": "A description of a triggering event."
    },
    {
      "code": "base64Binary",
      "display": "base64Binary",
      "definition": "A stream of bytes"
    },
    {
      "code": "boolean",
      "display": "boolean",
      "definition": "Value of \"true\" or \"false\""
    },
    {
      "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": "markdown",
      "display": "markdown",
      "definition": "A string that may contain 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": "uuid",
      "display": "uuid",
      "definition": "A UUID, represented as a URI"
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/valueset-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.