FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

4.3.2.1 CodeSystem http://hl7.org/fhir/fhir-types

Clinical Quality Information icon Work Group  Maturity Level: N Normative (from v4.0.0) Use Context: Country: World
Official URL: http://hl7.org/fhir/fhir-types Version: 6.0.0-ballot2
active as of 2022-08-26 Computable Name: FHIRTypes
Flags: CaseSensitive, Complete. All codes ValueSet: All FHIR Types OID: 2.16.840.1.113883.4.642.4.1802

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:


One of the types defined as part of this version of FHIR.

Generated Narrative: CodeSystem fhir-types

Last updated: 2024-11-18T20:18:03.23Z

Profile: Shareable CodeSystem

Properties

This code system defines the following properties for its concepts

NameCodeURIType
abstract-type abstract-type http://hl7.org/fhir/type-properties#abstract-type boolean
kind kind http://hl7.org/fhir/type-properties#kind code
interface interface http://hl7.org/fhir/type-properties#interface boolean

Concepts

This case-sensitive code system http://hl7.org/fhir/fhir-types defines the following codes in an undefined hierarchy:

LvlCodeDefinitionCopy
1 Base

Base Type: Base definition for all types defined in FHIR type system.

btn btn
2   Element

Element Type: Base definition for all elements in a resource.

btn btn
3     BackboneElement

BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.

btn btn
3     DataType

DataType Type: The base class for all re-useable types defined as part of the FHIR Specification.

btn btn
4       Address

Address Type: 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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.

btn btn
4       Annotation

Annotation Type: A text note which also contains information about who made the statement and when.

btn btn
4       Attachment

Attachment Type: For referring to data content defined in other formats.

btn btn
4       Availability

Availability Type: Availability data for an {item}, declaring what days/times are available, and any exceptions. The exceptions could be textual only, e.g. Public holidays, or could be time period specific and indicate a specific years dates.

btn btn
4       BackboneType

BackboneType Type: Base definition for the few data types that are allowed to carry modifier extensions.

btn btn
5         Dosage

Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.

btn btn
5         ElementDefinition

ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.

btn btn
5         MarketingStatus

MarketingStatus Type: 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.

btn btn
5         ProductShelfLife

ProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.

btn btn
5         RelativeTime

RelativeTime Type: RelativeTime is used to express a point in time or an interval of time relative to an event defined in data types other than dateTime.

btn btn
5         Timing

Timing Type: 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.

btn btn
4       CodeableConcept

CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

btn btn
4       CodeableReference

CodeableReference Type: A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).

btn btn
4       Coding

Coding Type: A reference to a code defined by a terminology system.

btn btn
4       ContactDetail

ContactDetail Type: Specifies contact information for a person or organization.

btn btn
4       ContactPoint

ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

btn btn
4       Contributor

Contributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.

btn btn
4       DataRequirement

DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

btn btn
4       Expression

Expression Type: 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.

btn btn
4       ExtendedContactDetail

ExtendedContactDetail Type: Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.

btn btn
4       Extension

Extension Type: Optional Extension Element - found in all resources.

btn btn
4       HumanName

HumanName Type: A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.

btn btn
4       Identifier

Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

btn btn
4       Meta

Meta Type: 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.

btn btn
4       MonetaryComponent

MonetaryComponent Type: Financial line items use this datatype to commonly categorize the value, and other factors that may effect how the value should be interpreted.

btn btn
4       Money

Money Type: An amount of economic utility in some recognized currency.

btn btn
4       Narrative

Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.

btn btn
4       ParameterDefinition

ParameterDefinition Type: 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.

btn btn
4       Period

Period Type: A time period defined by a start and end date and optionally time.

btn btn
4       PrimitiveType

PrimitiveType Type: The base type for all re-useable types defined that have a simple property.

btn btn
5         base64Binary

base64Binary Type: A stream of bytes

btn btn
5         boolean

boolean Type: Value of "true" or "false"

btn btn
5         date

date Type: A 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.

btn btn
5         dateTime

dateTime Type: A 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.

btn btn
5         decimal

decimal Type: A rational number with implicit precision

btn btn
5         instant

instant Type: An instant in time - known at least to the second

btn btn
5         integer

integer Type: A whole number

btn btn
6           positiveInt

positiveInt type: An integer with a value that is positive (e.g. >0)

btn btn
6           unsignedInt

unsignedInt type: An integer with a value that is not negative (e.g. >= 0)

btn btn
5         integer64

integer64 Type: A very large whole number

btn btn
5         string

string Type: A sequence of Unicode characters

btn btn
6           code

code type: 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

btn btn
6           id

id type: 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.

btn btn
6           markdown

markdown type: A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine

btn btn
5         time

time Type: A time during the day, with no date specified

btn btn
5         uri

uri Type: String of characters used to identify a name or a resource

btn btn
6           canonical

canonical type: A URI that is a reference to a canonical URL on a FHIR resource

btn btn
6           oid

oid type: An OID represented as a URI

btn btn
6           url

url type: A URI that is a literal reference

btn btn
6           uuid

uuid type: A UUID, represented as a URI

btn btn
4       Quantity

Quantity Type: 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.

btn btn
5         Age

Age Type: A duration of time during which an organism (or a process) has existed.

btn btn
5         Count

Count Type: 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.

btn btn
5         Distance

Distance Type: A length - a value with a unit that is a physical distance.

btn btn
5         Duration

Duration Type: A length of time.

btn btn
4       Range

Range Type: A set of ordered Quantities defined by a low and high limit.

btn btn
4       Ratio

Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.

btn btn
4       RatioRange

RatioRange Type: A range of ratios expressed as a low and high numerator and a denominator.

btn btn
4       Reference

Reference Type: A reference from one resource to another.

btn btn
4       RelatedArtifact

RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.

btn btn
4       SampledData

SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

btn btn
4       Signature

Signature Type: 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.

btn btn
4       TriggerDefinition

TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

btn btn
4       UsageContext

UsageContext Type: 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).

btn btn
4       VirtualServiceDetail

VirtualServiceDetail Type: The set of values required to describe a virtual service's connection details, including some limitations of the service.

btn btn
3     xhtml

xhtml Type definition

btn btn
2   Resource

This is the base resource type for everything.

btn btn
3     Binary

A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.

btn btn
3     Bundle

A container for a collection of resources.

btn btn
3     DomainResource

A resource that includes narrative, extensions, and contained resources.

btn btn
4       Account

A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.

btn btn
4       ActivityDefinition

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

btn btn
4       ActorDefinition

The ActorDefinition resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.

btn btn
4       AdministrableProductDefinition

A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).

btn btn
4       AdverseEvent

An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.

btn btn
4       AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

btn btn
4       Appointment

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

btn btn
4       AppointmentResponse

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

btn btn
4       ArtifactAssessment

This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.

btn btn
4       AuditEvent

A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.

btn btn
4       Basic

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

btn btn
4       BiologicallyDerivedProduct

A biological material originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.

btn btn
4       BiologicallyDerivedProductDispense

A record of dispensation of a biologically derived product.

btn btn
4       BodyStructure

Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

btn btn
4       CanonicalResource

Common Interface declaration for conformance and knowledge artifact resources.

btn btn
4       CapabilityStatement

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

btn btn
4       CarePlan

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

btn btn
4       CareTeam

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care.

btn btn
4       ChargeItem

The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

btn btn
4       ChargeItemDefinition

The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

btn btn
4       Citation

The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.

btn btn
4       Claim

A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

btn btn
4       ClaimResponse

This resource provides the adjudication details from the processing of a Claim resource.

btn btn
4       ClinicalImpression

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

btn btn
4       ClinicalUseDefinition

A single issue - either an indication, contraindication, interaction, undesirable effect or warning for a medicinal product, medication, device or procedure.

btn btn
4       CodeSystem

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

btn btn
4       Communication

A clinical or business level record of information being transmitted or shared; e.g. an alert that was sent to a responsible provider, a public health agency communication to a provider/reporter in response to a case report for a reportable condition.

btn btn
4       CommunicationRequest

A request to convey information from a sender to a recipient.

btn btn
4       CompartmentDefinition

A compartment definition that defines how resources are accessed on a server.

btn btn
4       Composition

A set of healthcare-related information that is assembled together into a single logical package 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. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

btn btn
4       ConceptMap

A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

btn btn
4       Condition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

btn btn
4       ConditionDefinition

A definition of a condition and information relevant to managing it.

btn btn
4       Consent

A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

btn btn
4       Contract

Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

btn btn
4       Coverage

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

btn btn
4       CoverageEligibilityRequest

The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

btn btn
4       CoverageEligibilityResponse

This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

btn btn
4       DetectedIssue

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, gaps in care, etc.

btn btn
4       Device

This resource describes the properties (regulated, has real time clock, etc.), administrative (manufacturer name, model number, serial number, firmware, etc.), and type (knee replacement, blood pressure cuff, MRI, etc.) of a physical unit (these values do not change much within a given module, for example the serial number, manufacturer name, and model number). An actual unit may consist of several modules in a distinct hierarchy and these are represented by multiple Device resources and bound through the 'parent' element.

btn btn
4       DeviceAlert

Describes a physiological or technical alert condition report originated by a device. The DeviceAlert resource is derived from the ISO/IEEE 11073-10201 Domain Information Model standard, but is more widely applicable.

btn btn
4       DeviceAssociation

A record of association of a device.

btn btn
4       DeviceDefinition

This is a specialized resource that defines the characteristics and capabilities of a device.

btn btn
4       DeviceDispense

Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the product (supply) provided and the instructions for using the device.

btn btn
4       DeviceMetric

Describes a measurement, calculation or setting capability of a device. The DeviceMetric resource is derived from the ISO/IEEE 11073-10201 Domain Information Model standard, but is more widely applicable.

btn btn
4       DeviceRequest

Represents a request a device to be provided to a specific patient. The device may be an implantable device to be subsequently implanted, or an external assistive device, such as a walker, to be delivered and subsequently be used.

btn btn
4       DeviceUsage

A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.

btn btn
4       DiagnosticReport

The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances.

btn btn
4       DocumentReference

A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this “document” encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.

btn btn
4       Encounter

An interaction between healthcare provider(s), and/or patient(s) for the purpose of providing healthcare service(s) or assessing the health status of patient(s).

btn btn
4       EncounterHistory

A record of significant events/milestones key data throughout the history of an Encounter

btn btn
4       Endpoint

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.

btn btn
4       EnrollmentRequest

This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

btn btn
4       EnrollmentResponse

This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.

btn btn
4       EpisodeOfCare

An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

btn btn
4       EventDefinition

The EventDefinition resource provides a reusable description of when a particular event can occur.

btn btn
4       Evidence

The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (e.g., population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.

btn btn
4       EvidenceReport

The EvidenceReport Resource is a specialized container for a collection of resources and codeable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.

btn btn
4       EvidenceVariable

The EvidenceVariable resource describes an element that knowledge (Evidence) is about.

btn btn
4       ExampleScenario

A walkthrough of a workflow showing the interaction between systems and the instances shared, possibly including the evolution of instances over time.

btn btn
4       ExplanationOfBenefit

This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

btn btn
4       FamilyMemberHistory

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

btn btn
4       Flag

Prospective warnings of potential issues when providing care to the patient.

btn btn
4       FormularyItem

This resource describes a product or service that is available through a program and includes the conditions and constraints of availability. All of the information in this resource is specific to the inclusion of the item in the formulary and is not inherent to the item itself.

btn btn
4       GenomicStudy

A set of analyses performed to analyze and generate genomic data.

btn btn
4       Goal

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

btn btn
4       GraphDefinition

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

btn btn
4       Group

Represents a defined collection of entities that may be discussed or acted upon collectively but are not formally or legally recognized; i.e. a collection of entities that isn't an Organization. Some groups are allowed to take actions, to do things collectively (but not groups of practitioners providing care - see CareTeam)

btn btn
4       GuidanceResponse

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

btn btn
4       HealthcareService

The details of a healthcare service available at a location or in a catalog. In the case where there is a hierarchy of services (for example, Lab -> Pathology -> Wound Cultures), this can be represented using a set of linked HealthcareServices.

btn btn
4       ImagingSelection

A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, a Referenced Content Item Identifier from a DICOM SR Content Item or a Segment Number from a DICOM Segmentation SOP Instance.

btn btn
4       ImagingStudy

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of instances (images or other data) acquired or produced in a common context. A series SHALL have only one modality (e.g. X-ray, CT, MR, ultrasound). A study MAY have multiple series which MAY have different modality values.

btn btn
4       Immunization

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

btn btn
4       ImmunizationEvaluation

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

btn btn
4       ImmunizationRecommendation

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

btn btn
4       ImplementationGuide

A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

btn btn
4       Ingredient

An ingredient of a manufactured item or pharmaceutical product.

btn btn
4       InsurancePlan

Details of a Health Insurance plan provided by an organization under an InsuranceProduct.

btn btn
4       InsuranceProduct

Details of a Health Insurance product provided by an organization.

btn btn
4       InventoryItem

functional description of an inventory item used in inventory and supply-related workflows.

btn btn
4       InventoryReport

A report of inventory or stock items.

btn btn
4       Invoice

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

btn btn
4       Library

The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

btn btn
4       Linkage

Identifies two or more records (resource instances) that refer to the same real-world "occurrence".

btn btn
4       List

A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.

btn btn
4       Location

Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.

btn btn
4       ManufacturedItemDefinition

The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.

btn btn
4       Measure

The Measure resource provides the definition of a quality measure.

btn btn
4       MeasureReport

The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.

btn btn
4       Medication

This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

btn btn
4       MedicationAdministration

Describes the event of a patient consuming or otherwise being administered 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. This event can also be used to record waste using a status of not-done and the appropriate statusReason.

btn btn
4       MedicationDispense

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

btn btn
4       MedicationKnowledge

Information about a medication that is used to support knowledge.

btn btn
4       MedicationRequest

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

btn btn
4       MedicationStatement

A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains.

The primary difference between a medicationstatement and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationstatement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the Medication Statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.

btn btn
4       MedicinalProductDefinition

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs, to support prescribing, adverse events management etc.).

btn btn
4       MessageDefinition

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

btn btn
4       MessageHeader

The header for a message exchange that is either requesting or responding to an action. The reference(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.

btn btn
4       MetadataResource

Common Interface declaration for conformance and knowledge artifact resources.

btn btn
4       MolecularDefinition

Representation of a molecular definition.

btn btn
4       MolecularSequence

Representation of a molecular sequence.

btn btn
4       NamingSystem

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

btn btn
4       NutritionIntake

A record of intake by a patient. A NutritionIntake may indicate that the patient may be consuming the food (i.e., solid and/or liquid), breastmilk, infant formula, supplements, enteral formula now or has consumed it in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food (i.e., solid and/or liquid), breastmilk, infant formula, supplements, enteral formula consumed. The consumption information may come from sources such as the patient's memory, from a nutrition label, or from a clinician documenting observed intake.

btn btn
4       NutritionOrder

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to an individual or group.

btn btn
4       NutritionProduct

A food or supplement that is consumed by patients.

btn btn
4       Observation

Measurements and simple assertions made about a patient, device or other subject.

btn btn
4       ObservationDefinition

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

btn btn
4       OperationDefinition

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

btn btn
4       OperationOutcome

A collection of error, warning, or information messages that result from a system action.

btn btn
4       Organization

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.

btn btn
4       OrganizationAffiliation

Defines an affiliation/assotiation/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship.

btn btn
4       PackagedProductDefinition

A medically related item or items, in a container or package.

btn btn
4       Patient

Demographics and other administrative information about an individual or animal that is the subject of potential, past, current, or future health-related care, services, or processes.

btn btn
4       PaymentNotice

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

btn btn
4       PaymentReconciliation

This resource provides the details including amount of a payment and allocates the payment items being paid.

btn btn
4       Permission

Permission resource holds access rules for a given data and context.

btn btn
4       Person

Demographics and administrative information about a person independent of a specific health-related context.

btn btn
4       PersonalRelationship

Details about the relationship between 2 individuals.

btn btn
4       PlanDefinition

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

btn btn
4       Practitioner

A person who is directly or indirectly involved in the provisioning of healthcare or related services.

btn btn
4       PractitionerRole

A specific set of Roles/Locations/specialties/services that a practitioner may perform, or has performed at an organization during a period of time.

btn btn
4       Procedure

An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing.

btn btn
4       Provenance

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

btn btn
4       Questionnaire

A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

btn btn
4       QuestionnaireResponse

A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.

btn btn
4       RegulatedAuthorization

Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity that is cited in a guidance, regulation, rule or legislative act. An example is Market Authorization relating to a Medicinal Product.

btn btn
4       RelatedPerson

Information about a person that is involved in a patient's health or the care for a patient, but who is not the primary target of healthcare.

btn btn
4       RequestOrchestration

A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

btn btn
4       Requirements

The Requirements resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.

btn btn
4       ResearchStudy

A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future.

btn btn
4       ResearchSubject

A ResearchSubject is a participant or object which is the recipient of investigative activities in a research study.

btn btn
4       RiskAssessment

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

btn btn
4       Schedule

A container for slots of time that may be available for booking appointments.

btn btn
4       SearchParameter

A search parameter that defines a named search item that can be used to search/filter on a resource.

btn btn
4       ServiceRequest

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

btn btn
4       Slot

A slot of time on a schedule that may be available for booking appointments.

btn btn
4       Specimen

A sample to be used for analysis.

btn btn
4       SpecimenDefinition

A kind of specimen with associated set of requirements.

btn btn
4       StructureDefinition

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

btn btn
4       StructureMap

A Map of relationships between 2 structures that can be used to transform data.

btn btn
4       Subscription

The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.

btn btn
4       SubscriptionStatus

The SubscriptionStatus resource describes the state of a Subscription during notifications. It is not persisted.

btn btn
4       SubscriptionTopic

Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.

btn btn
4       Substance

A homogeneous material with a definite composition.

btn btn
4       SubstanceDefinition

The detailed description of a substance, typically at a level beyond what is used for prescribing.

btn btn
4       SubstanceNucleicAcid

Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.

btn btn
4       SubstancePolymer

Properties of a substance specific to it being a polymer.

btn btn
4       SubstanceProtein

A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.

btn btn
4       SubstanceReferenceInformation

Todo.

btn btn
4       SubstanceSourceMaterial

Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.

btn btn
4       SupplyDelivery

Record of delivery of what is supplied.

btn btn
4       SupplyRequest

A record of a non-patient specific request for a medication, substance, device, certain types of biologically derived product, and nutrition product used in the healthcare setting.

btn btn
4       Task

A task to be performed as a part of a workflow and the related information like inputs, outputs and execution progress.

btn btn
4       TerminologyCapabilities

A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

btn btn
4       TestPlan

A plan for executing testing on an artifact or specifications

btn btn
4       TestReport

A summary of information based on the results of executing a TestScript.

btn btn
4       TestScript

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

btn btn
4       Transport

Record of transport.

btn btn
4       ValueSet

A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements.

btn btn
4       VerificationResult

Describes validation requirements, source(s), status and dates for one or more elements.

btn btn
4       VisionPrescription

An authorization for the provision of glasses and/or contact lenses to a patient.

btn btn
3     Parameters

This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources except as described in the definition of the Parameters resource.

btn btn

 

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


Explanation of the columns that may appear on this page:

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