Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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

4.3.16.389 Code System http://hl7.org/fhir/data-types

FHIR Infrastructure Work Group Maturity Level: NNormative (from v4.0.0) Use Context: Any
This page has been approved as part of an ANSI standard. See the Conformance Package for further details.

This is a code system defined by the FHIR project.

Summary

Defining URL:http://hl7.org/fhir/data-types
Version:4.6.0
Name:DataType
Title:DataType
Definition:

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).

Committee:FHIR Infrastructure Work Group
OID: (for OID based terminology systems)
Source ResourceXML / JSON

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

This Code system is used in the following value sets:

  • ValueSet: DataType (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).)
  • ValueSet: FHIRDefinedType (A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.)
  • ValueSet: FHIRAllTypes (A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.)

This code system http://hl7.org/fhir/data-types defines the following codes:

CodeDisplayDefinitionComments
Address AddressAn 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 AgeA duration of time during which an organism (or a process) has existed.
Annotation AnnotationA text note which also contains information about who made the statement and when.
Attachment AttachmentFor referring to data content defined in other formats.
BackboneElement BackboneElementBase definition for all elements that are defined inside a resource - but not those in a data type.
BackboneType BackboneTypeBase definition for the few data types that are allowed to carry modifier extensions.
Base BaseBase definition for all types defined in FHIR type system.
CodeableConcept CodeableConceptA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
CodeableReference CodeableReferenceA reference to a resource (by instance), or instead, a reference to a cencept defined in a terminology or ontology (by class).
Coding CodingA reference to a code defined by a terminology system.
ContactDetail ContactDetailSpecifies contact information for a person or organization.
ContactPoint ContactPointDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
Contributor ContributorA contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
Count CountA 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 DataRequirementDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
DataType DataTypeThe base class for all re-useable types defined as part of the FHIR Specification.
Distance DistanceA length - a value with a unit that is a physical distance.
Dosage DosageIndicates how the medication is/was taken or should be taken by the patient.
Duration DurationA length of time.
Element ElementBase definition for all elements in a resource.
ElementDefinition ElementDefinitionCaptures constraints on each element within the resource, profile, or extension.
Expression ExpressionA 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.
Extension ExtensionOptional Extension Element - found in all resources.
HumanName HumanNameA human's name with the ability to identify parts and usage.
Identifier IdentifierAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
MarketingStatus MarketingStatusThe 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 MetaThe 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.
Money MoneyAn amount of economic utility in some recognized currency.
MoneyQuantity MoneyQuantity
Narrative NarrativeA human-readable summary of the resource conveying the essential clinical and business information for the resource.
OrderedDistribution OrderedDistributionAn ordered list (distribution) of statistics.
ParameterDefinition ParameterDefinitionThe 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 PeriodA time period defined by a start and end date and optionally time.
Population PopulationA populatioof people with some set of grouping criteria.
PrimitiveType PrimitiveTypeThe base type for all re-useable types defined that have a simple property.
ProdCharacteristic ProdCharacteristicThe 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 ProductShelfLifeThe shelf-life and storage information for a medicinal product item or container can be described using this class.
Quantity QuantityA 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 RangeA set of ordered Quantities defined by a low and high limit.
Ratio RatioA relationship of two Quantity values - expressed as a numerator and a denominator.
RatioRange RatioRangeA range of ratios expressed as a low and high numerator and a denominator.
Reference ReferenceA reference from one resource to another.
RelatedArtifact RelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.
SampledData SampledDataA series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
Signature SignatureA 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.
SimpleQuantity SimpleQuantity
Statistic StatisticA 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.
Timing TimingSpecifies 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 TriggerDefinitionA description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
UsageContext UsageContextSpecifies 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 base64BinaryA stream of bytes
boolean booleanValue of "true" or "false"
canonical canonicalA URI that is a reference to a canonical URL on a FHIR resource
code codeA 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 dateA date or partial date (e.g. just year or year + month). There is no UTC offset. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
dateTime dateTimeA date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset 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 decimalA rational number with implicit precision
id idAny 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 instantAn instant in time - known at least to the second
integer integerA whole number
integer64 integer64A very large whole number
markdown markdownA string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
oid oidAn OID represented as a URI
positiveInt positiveIntAn integer with a value that is positive (e.g. >0)
string stringA sequence of Unicode characters
time timeA time during the day, with no date specified
unsignedInt unsignedIntAn integer with a value that is not negative (e.g. >= 0)
uri uriString of characters used to identify a name or a resource
url urlA URI that is a literal reference
uuid uuidA UUID, represented as a URI
xhtml XHTMLXHTML format, as defined by W3C, but restricted usage (mainly, no active content)Special case: xhtml can only be used in the narrative Data Type

 

See the full registry of code systems defined as part of FHIR.


Explanation of the columns that may appear on this page:

LevelA few code lists that FHIR defines are hierarchical - each code is assigned a level. See Code System for further information.
SourceThe source of the definition of the code (when the value set draws in codes defined elsewhere)
CodeThe code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
DisplayThe display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
DefinitionAn explanation of the meaning of the concept
CommentsAdditional notes about how to use the code