Release 4 R5 Final QA

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-draft-final: Final QA Preview for R5 - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). 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: R5 R4B R4 R3

Using Codes Code Systems Value Sets Concept Maps Identifier Systems 4.3.14.157 Code System http://hl7.org/fhir/data-types

Example ValueSet/code-search-support (JSON)

Committee:
FHIR Terminology Infrastructure Work Group   Maturity Level : N N/A Normative (from v4.0.0) Use Context Standards Status : 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.0.1 Name: DataType Title: DataType Definition: Informative 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).

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

A version specific list of the data types defined by the FHIR specification Definition for use as an element type (any of the FHIR defined data types). Value SetCode Search Support

{
  "resourceType" : "ValueSet",
  "id" : "code-search-support",
  "meta" : {
    "lastUpdated" : "2023-03-01T23:03:57.298+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>Include all codes defined in <a href=\"codesystem-code-search-support.html\"><code>http://hl7.org/fhir/code-search-support</code></a></li></ul></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "vocab"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 1
  }],
  "url" : "http://hl7.org/fhir/ValueSet/code-search-support",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.860"
  }],
  "version" : "5.0.0-draft-final",
  "name" : "CodeSearchSupport",
  "title" : "Code Search Support",
  "status" : "draft",
  "experimental" : true,
  "date" : "2020-12-28T16:55:11+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "The degree to which the server supports the code search parameter on ValueSet, if it is supported.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "immutable" : true,
  "compose" : {
    "include" : [{
      "system" : "http://hl7.org/fhir/code-search-support"
    }]
  }
}

This code system http://hl7.org/fhir/data-types defines the following codes: Code Display Definition Comments Address 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 Age A duration of time during which an organism (or a process) Usage note: every effort has existed. Annotation Annotation A text note which also contains information about who been made the statement and when. Attachment Attachment For referring to data content defined in other formats. BackboneElement BackboneElement Base definition for all elements that are defined inside a resource - but not those in a data type. CodeableConcept CodeableConcept A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Coding Coding A reference to a code defined by a terminology system. ContactDetail ContactDetail Specifies contact information for a person or organization. ContactPoint ContactPoint Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Contributor Contributor A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers. Count 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 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 Distance A length - a value with a unit that is a physical distance. Dosage Dosage Indicates how the medication is/was taken or should be taken by the patient. Duration Duration A length of time. Element Element Base definition for all elements in a resource. ElementDefinition ElementDefinition Captures constraints on each element within the resource, profile, or extension. Expression 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. Extension Extension Optional Extension Element - found in all resources. HumanName HumanName A human's name with the ability to identify parts and usage. Identifier Identifier An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. MarketingStatus 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 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. Money Money An amount of economic utility in some recognized currency. MoneyQuantity MoneyQuantity Narrative Narrative A human-readable summary of the resource conveying the essential clinical and business information for the resource. ParameterDefinition 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 Period A time period defined by a start and end date and optionally time. Population Population A populatioof people with some set of grouping criteria. ProdCharacteristic 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 ProductShelfLife The shelf-life and storage information for a medicinal product item or container can be described using this class. Quantity 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 Range A set of ordered Quantities defined by a low and high limit. Ratio Ratio A relationship of two Quantity values - expressed as a numerator and a denominator. Reference Reference A reference from one resource to another. RelatedArtifact RelatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. SampledData 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 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. SimpleQuantity SimpleQuantity SubstanceAmount 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 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 TriggerDefinition A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element. UsageContext UsageContext Specifies clinical/business/etc. metadata ensure 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 base64Binary A stream of bytes boolean boolean Value of "true" or "false" canonical canonical A URI that is a reference to a canonical URL on a FHIR resource code 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 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 dateTime A date, date-time or partial date (e.g. just year or year + month). If hours and minutes examples are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date correct and dateTime. Seconds must be provided due to schema type constraints useful, but may be zero-filled and may be ignored. Dates SHALL be valid dates. decimal decimal A rational number with implicit precision id 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 they are case-insensitive. instant instant An instant in time - known at least to the second integer integer A whole number markdown markdown A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine oid oid An OID represented as a URI positiveInt positiveInt An integer with a value that is positive (e.g. >0) string string A sequence of Unicode characters time time A time during the day, with no date specified unsignedInt unsignedInt An integer with a value that is not negative (e.g. >= 0) uri uri String of characters used to identify a name or a resource url url A URI that is a literal reference uuid uuid A UUID, represented as a URI xhtml XHTML XHTML 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 normative part of FHIR. Explanation of the columns that may appear on this page: specification.

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. See Code System for further information. Source The source of the definition of the code (when the value set draws in codes defined elsewhere) Code The code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract') Display The 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 Definition An explanation of the meaning of the concept Comments Additional notes about how to use the code