This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

1.14.2.1.5 Value Set for codes in http://hl7.org/fhir/defined-types

This is a value set defined by the FHIR project.

Summary

Code System URL:http://hl7.org/fhir/defined-types
Value Set URL:http://hl7.org/fhir/vs/defined-types
Definition:Either a resource or a data type

Formal value Set definition : XML or JSON.

This value set defines its own codes:

1.14.2.1.5.1 FHIRDefinedType

Either a resource or a data type

This value set defines its own terms in the system http://hl7.org/fhir/defined-types

CodeDisplayDefinition
Address There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world.
Age There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. If value is present, it SHALL be positive.
Attachment For referring to data content defined in other formats.
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.
Contact All kinds of technology mediated contact details for a person or organization, including telephone, email, etc.
Count There SHALL be a code with a value of "1" if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM. If present, the value SHALL a whole number.
Distance There SHALL be a code if there is a value and it SHALL be an expression of length. If system is present, it SHALL be UCUM.
Duration There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
Extension Optional Extensions Element - found in all resources.
HumanName A human's name with the ability to identify parts and usage.
Identifier A technical identifier - identifies some entity uniquely and unambiguously.
Money There SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:std:iso:4217" - currency).
Narrative A human-readable formatted text, including images.
Period A time period defined by a start and end date and optionally time.
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 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.
ResourceReference A reference from one resource to another.
SampledData A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
Schedule Specifies an event that may occur multiple times. Schedules are used for to reord when things are expected or requested to occur.
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
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 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 may be provided but may also be ignored. Dates SHALL be valid dates.
decimal A rational number with implicit precision
id A whole number in the range 0 to 2^64-1, optionally represented in hex, a uuid, an oid or any other combination of lower-case letters a-z, numerals, "-" and ".", with a length limit of 36 characters
instant An instant in time - known at least to the second
integer A whole number
oid An oid represented as a URI
string A sequence of Unicode characters
uri String of characters used to identify a name or a resource
uuid A UUID, represented as a URI
AdverseReaction Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance.
Alert Prospective warnings of potential issues when providing care to the patient.
AllergyIntolerance Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance.
CarePlan Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.
Composition A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.
ConceptMap A statement of relationships from one set of concepts to one or more other concept systems.
Condition Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary.
Conformance A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation.
Device This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.
DeviceObservationReport Describes the data produced by a device at a point in time.
DiagnosticOrder A request for a diagnostic investigation service to be performed.
DiagnosticReport The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports.
DocumentManifest A manifest that defines a set of documents.
DocumentReference A reference to a document.
Encounter An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
FamilyHistory Significant health events and conditions for people related to the subject relevant in the context of care for the subject.
Group Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization.
ImagingStudy Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images.
Immunization Immunization event information.
ImmunizationRecommendation A patient's point-of-time immunization status and recommendation with optional supporting justification.
List A set of information summarized from a list of other resources.
Location Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
Medication Primarily used for identification and definition of Medication, but also covers ingredients and packaging.
MedicationAdministration Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
MedicationDispense Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.
MedicationPrescription An order for both supply of the medication and the instructions for administration of the medicine to a patient.
MedicationStatement A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician.
MessageHeader The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
Observation Measurements and simple assertions made about a patient, device or other subject.
OperationOutcome A collection of error, warning or information messages that result from a system action.
Order A request to perform an action.
OrderResponse A response to an order.
Organization A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
Other Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.
Patient Demographics and other administrative information about a person or animal receiving care or other health-related services.
Practitioner A person who is directly or indirectly involved in the provisioning of healthcare.
Procedure An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.
Profile A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions.
Provenance Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance.
Query A description of a query with a set of parameters.
Questionnaire A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.
RelatedPerson Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
SecurityEvent A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
Specimen Sample for analysis.
Substance A homogeneous material with a definite composition.
Supply A supply - a request for something, and provision of what is supplied.
ValueSet A value set specifies a set of codes drawn from one or more code systems.

These codes are used in the following places:

OIDs

Code System URL:5
Value Set URL:2.16.840.1.113883.4.642.2.5
Note: these OIDs are not used in FHIR, but may be used in v3, or OID based terminology systems

See the full registry of value sets 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. In this scheme, some codes are under other codes, and imply that the code they are under also applies
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)
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

In addition, this page will include mappings to HL7 v2 or HL7 v3 code where these have been defined.


comments powered by Disqus