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.4.1.507 ValueSet http://hl7.org/fhir/ValueSet/fhir-types

FHIR Infrastructure icon Work Group Maturity Level: NNormative Use Context: Not Intended for Production use, Not Intended for Production use

This is a value set defined by the FHIR project.

Summary

Defining URL:http://hl7.org/fhir/ValueSet/fhir-types
Version:5.0.0-cibuild
Name:FHIRTypes
Title:All FHIR Types
Status:active
Definition:

All FHIR types

Committee:FHIR Infrastructure icon Work Group
OID:2.16.840.1.113883.4.642.3.3299 (for OID based terminology systems)
Flags:Experimental, Immutable

This value set is used in the following places:


 

This expansion generated 02 Dec 2022


This value set contains 228 concepts

Expansion based on All FHIR Types v5.0.0-cibuild (CodeSystem)

CodeSystemDisplayDefinition
  Basehttp://hl7.org/fhir/fhir-typesBase

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

  Elementhttp://hl7.org/fhir/fhir-typesElement

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

  BackboneElementhttp://hl7.org/fhir/fhir-typesBackboneElement

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

  DataTypehttp://hl7.org/fhir/fhir-typesDataType

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

  Addresshttp://hl7.org/fhir/fhir-typesAddress

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.

  Annotationhttp://hl7.org/fhir/fhir-typesAnnotation

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

  Attachmenthttp://hl7.org/fhir/fhir-typesAttachment

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

  Availabilityhttp://hl7.org/fhir/fhir-typesAvailability

Availability Type: Availability data for an {item}.

  BackboneTypehttp://hl7.org/fhir/fhir-typesBackboneType

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

  Dosagehttp://hl7.org/fhir/fhir-typesDosage

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

  ElementDefinitionhttp://hl7.org/fhir/fhir-typesElementDefinition

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

  MarketingStatushttp://hl7.org/fhir/fhir-typesMarketingStatus

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.

  Populationhttp://hl7.org/fhir/fhir-typesPopulation

Population Type: A populatioof people with some set of grouping criteria.

  ProductShelfLifehttp://hl7.org/fhir/fhir-typesProductShelfLife

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

  Timinghttp://hl7.org/fhir/fhir-typesTiming

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.

  CodeableConcepthttp://hl7.org/fhir/fhir-typesCodeableConcept

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

  CodeableReferencehttp://hl7.org/fhir/fhir-typesCodeableReference

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

  Codinghttp://hl7.org/fhir/fhir-typesCoding

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

  ContactDetailhttp://hl7.org/fhir/fhir-typesContactDetail

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

  ContactPointhttp://hl7.org/fhir/fhir-typesContactPoint

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

  Contributorhttp://hl7.org/fhir/fhir-typesContributor

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

  DataRequirementhttp://hl7.org/fhir/fhir-typesDataRequirement

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.

  Expressionhttp://hl7.org/fhir/fhir-typesExpression

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.

  ExtendedContactDetailhttp://hl7.org/fhir/fhir-typesExtendedContactDetail

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.

  Extensionhttp://hl7.org/fhir/fhir-typesExtension

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

  HumanNamehttp://hl7.org/fhir/fhir-typesHumanName

HumanName Type: A name, normally of a human, that can be used for other living entities (eg. 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.

  Identifierhttp://hl7.org/fhir/fhir-typesIdentifier

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

  Metahttp://hl7.org/fhir/fhir-typesMeta

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.

  MonetaryComponenthttp://hl7.org/fhir/fhir-typesMonetaryComponent

MonetaryComponent Type: Availability data for an {item}.

  Moneyhttp://hl7.org/fhir/fhir-typesMoney

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

  Narrativehttp://hl7.org/fhir/fhir-typesNarrative

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

  ParameterDefinitionhttp://hl7.org/fhir/fhir-typesParameterDefinition

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.

  Periodhttp://hl7.org/fhir/fhir-typesPeriod

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

  PrimitiveTypehttp://hl7.org/fhir/fhir-typesPrimitiveType

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

  base64Binaryhttp://hl7.org/fhir/fhir-typesbase64Binary

base64Binary Type: A stream of bytes

  booleanhttp://hl7.org/fhir/fhir-typesboolean

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

  datehttp://hl7.org/fhir/fhir-typesdate

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.

  dateTimehttp://hl7.org/fhir/fhir-typesdateTime

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.

  decimalhttp://hl7.org/fhir/fhir-typesdecimal

decimal Type: A rational number with implicit precision

  instanthttp://hl7.org/fhir/fhir-typesinstant

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

  integerhttp://hl7.org/fhir/fhir-typesinteger

integer Type: A whole number

  positiveInthttp://hl7.org/fhir/fhir-typespositiveInt

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

  unsignedInthttp://hl7.org/fhir/fhir-typesunsignedInt

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

  integer64http://hl7.org/fhir/fhir-typesinteger64

integer64 Type: A very large whole number

  stringhttp://hl7.org/fhir/fhir-typesstring

string Type: A sequence of Unicode characters

  codehttp://hl7.org/fhir/fhir-typescode

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

  idhttp://hl7.org/fhir/fhir-typesid

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.

  markdownhttp://hl7.org/fhir/fhir-typesmarkdown

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

  timehttp://hl7.org/fhir/fhir-typestime

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

  urihttp://hl7.org/fhir/fhir-typesuri

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

  canonicalhttp://hl7.org/fhir/fhir-typescanonical

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

  oidhttp://hl7.org/fhir/fhir-typesoid

oid type: An OID represented as a URI

  urlhttp://hl7.org/fhir/fhir-typesurl

url type: A URI that is a literal reference

  uuidhttp://hl7.org/fhir/fhir-typesuuid

uuid type: A UUID, represented as a URI

  Quantityhttp://hl7.org/fhir/fhir-typesQuantity

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.

  Agehttp://hl7.org/fhir/fhir-typesAge

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

  Counthttp://hl7.org/fhir/fhir-typesCount

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.

  Distancehttp://hl7.org/fhir/fhir-typesDistance

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

  Durationhttp://hl7.org/fhir/fhir-typesDuration

Duration Type: A length of time.

  Rangehttp://hl7.org/fhir/fhir-typesRange

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

  Ratiohttp://hl7.org/fhir/fhir-typesRatio

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

  RatioRangehttp://hl7.org/fhir/fhir-typesRatioRange

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

  Referencehttp://hl7.org/fhir/fhir-typesReference

Reference Type: A reference from one resource to another.

  RelatedArtifacthttp://hl7.org/fhir/fhir-typesRelatedArtifact

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

  SampledDatahttp://hl7.org/fhir/fhir-typesSampledData

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.

  Signaturehttp://hl7.org/fhir/fhir-typesSignature

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.

  TriggerDefinitionhttp://hl7.org/fhir/fhir-typesTriggerDefinition

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

  UsageContexthttp://hl7.org/fhir/fhir-typesUsageContext

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

  VirtualServiceDetailhttp://hl7.org/fhir/fhir-typesVirtualServiceDetail

VirtualServiceDetail Type: Virtual Service Contact Details.

  xhtmlhttp://hl7.org/fhir/fhir-typesxhtml

xhtml Type definition

  Resourcehttp://hl7.org/fhir/fhir-typesResource

This is the base resource type for everything.

  Binaryhttp://hl7.org/fhir/fhir-typesBinary

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.

  Bundlehttp://hl7.org/fhir/fhir-typesBundle

A container for a collection of resources.

  DomainResourcehttp://hl7.org/fhir/fhir-typesDomainResource

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

  Accounthttp://hl7.org/fhir/fhir-typesAccount

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.

  ActivityDefinitionhttp://hl7.org/fhir/fhir-typesActivityDefinition

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

  ActorDefinitionhttp://hl7.org/fhir/fhir-typesActorDefinition

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.

  AdministrableProductDefinitionhttp://hl7.org/fhir/fhir-typesAdministrableProductDefinition

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

  AdverseEventhttp://hl7.org/fhir/fhir-typesAdverseEvent

An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research subject. 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. 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.

  AllergyIntolerancehttp://hl7.org/fhir/fhir-typesAllergyIntolerance

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

  Appointmenthttp://hl7.org/fhir/fhir-typesAppointment

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

  AppointmentResponsehttp://hl7.org/fhir/fhir-typesAppointmentResponse

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

  ArtifactAssessmenthttp://hl7.org/fhir/fhir-typesArtifactAssessment

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

  AuditEventhttp://hl7.org/fhir/fhir-typesAuditEvent

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

  Basichttp://hl7.org/fhir/fhir-typesBasic

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.

  BiologicallyDerivedProducthttp://hl7.org/fhir/fhir-typesBiologicallyDerivedProduct

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

  BodyStructurehttp://hl7.org/fhir/fhir-typesBodyStructure

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.

  CanonicalResourcehttp://hl7.org/fhir/fhir-typesCanonicalResource

Common Interface declaration for conformance and knowledge artifact resources.

  CapabilityStatementhttp://hl7.org/fhir/fhir-typesCapabilityStatement

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.

  CarePlanhttp://hl7.org/fhir/fhir-typesCarePlan

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.

  CareTeamhttp://hl7.org/fhir/fhir-typesCareTeam

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

  ChargeItemhttp://hl7.org/fhir/fhir-typesChargeItem

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.

  ChargeItemDefinitionhttp://hl7.org/fhir/fhir-typesChargeItemDefinition

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.

  Citationhttp://hl7.org/fhir/fhir-typesCitation

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.

  Claimhttp://hl7.org/fhir/fhir-typesClaim

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.

  ClaimResponsehttp://hl7.org/fhir/fhir-typesClaimResponse

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

  ClinicalImpressionhttp://hl7.org/fhir/fhir-typesClinicalImpression

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.

  ClinicalUseDefinitionhttp://hl7.org/fhir/fhir-typesClinicalUseDefinition

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

  CodeSystemhttp://hl7.org/fhir/fhir-typesCodeSystem

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.

  Communicationhttp://hl7.org/fhir/fhir-typesCommunication

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.

  CommunicationRequesthttp://hl7.org/fhir/fhir-typesCommunicationRequest

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

  CompartmentDefinitionhttp://hl7.org/fhir/fhir-typesCompartmentDefinition

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

  Compositionhttp://hl7.org/fhir/fhir-typesComposition

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

  ConceptMaphttp://hl7.org/fhir/fhir-typesConceptMap

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.

  Conditionhttp://hl7.org/fhir/fhir-typesCondition

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

  ConditionDefinitionhttp://hl7.org/fhir/fhir-typesConditionDefinition

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

  Consenthttp://hl7.org/fhir/fhir-typesConsent

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.

  Contracthttp://hl7.org/fhir/fhir-typesContract

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

  Coveragehttp://hl7.org/fhir/fhir-typesCoverage

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

  CoverageEligibilityRequesthttp://hl7.org/fhir/fhir-typesCoverageEligibilityRequest

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.

  CoverageEligibilityResponsehttp://hl7.org/fhir/fhir-typesCoverageEligibilityResponse

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

  DetectedIssuehttp://hl7.org/fhir/fhir-typesDetectedIssue

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, etc.

  Devicehttp://hl7.org/fhir/fhir-typesDevice

This resource describes the properties (regulated, has real time clock, etc.), adminstrative (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 serail 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.

  DeviceDefinitionhttp://hl7.org/fhir/fhir-typesDeviceDefinition

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

  DeviceDispensehttp://hl7.org/fhir/fhir-typesDeviceDispense

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.

  DeviceMetrichttp://hl7.org/fhir/fhir-typesDeviceMetric

Describes a measurement, calculation or setting capability of a medical device.

  DeviceRequesthttp://hl7.org/fhir/fhir-typesDeviceRequest

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.

  DeviceUsagehttp://hl7.org/fhir/fhir-typesDeviceUsage

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.

  DiagnosticReporthttp://hl7.org/fhir/fhir-typesDiagnosticReport

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.

  DocumentManifesthttp://hl7.org/fhir/fhir-typesDocumentManifest

A collection of documents compiled for a purpose together with metadata that applies to the collection.

  DocumentReferencehttp://hl7.org/fhir/fhir-typesDocumentReference

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.

  Encounterhttp://hl7.org/fhir/fhir-typesEncounter

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

  Endpointhttp://hl7.org/fhir/fhir-typesEndpoint

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.

  EnrollmentRequesthttp://hl7.org/fhir/fhir-typesEnrollmentRequest

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

  EnrollmentResponsehttp://hl7.org/fhir/fhir-typesEnrollmentResponse

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

  EpisodeOfCarehttp://hl7.org/fhir/fhir-typesEpisodeOfCare

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.

  EventDefinitionhttp://hl7.org/fhir/fhir-typesEventDefinition

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

  Evidencehttp://hl7.org/fhir/fhir-typesEvidence

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.

  EvidenceReporthttp://hl7.org/fhir/fhir-typesEvidenceReport

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.

  EvidenceVariablehttp://hl7.org/fhir/fhir-typesEvidenceVariable

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

  ExampleScenariohttp://hl7.org/fhir/fhir-typesExampleScenario

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

  ExplanationOfBenefithttp://hl7.org/fhir/fhir-typesExplanationOfBenefit

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.

  FamilyMemberHistoryhttp://hl7.org/fhir/fhir-typesFamilyMemberHistory

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

  Flaghttp://hl7.org/fhir/fhir-typesFlag

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

  FormularyItemhttp://hl7.org/fhir/fhir-typesFormularyItem

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.

  GenomicStudyhttp://hl7.org/fhir/fhir-typesGenomicStudy

A Genomic Study is a set of analysis performed to analyze and generate genomic data.

  Goalhttp://hl7.org/fhir/fhir-typesGoal

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.

  GraphDefinitionhttp://hl7.org/fhir/fhir-typesGraphDefinition

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.

  Grouphttp://hl7.org/fhir/fhir-typesGroup

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.

  GuidanceResponsehttp://hl7.org/fhir/fhir-typesGuidanceResponse

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.

  HealthcareServicehttp://hl7.org/fhir/fhir-typesHealthcareService

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.

  ImagingSelectionhttp://hl7.org/fhir/fhir-typesImagingSelection

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, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.

  ImagingStudyhttp://hl7.org/fhir/fhir-typesImagingStudy

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

  Immunizationhttp://hl7.org/fhir/fhir-typesImmunization

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.

  ImmunizationEvaluationhttp://hl7.org/fhir/fhir-typesImmunizationEvaluation

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

  ImmunizationRecommendationhttp://hl7.org/fhir/fhir-typesImmunizationRecommendation

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

  ImplementationGuidehttp://hl7.org/fhir/fhir-typesImplementationGuide

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.

  Ingredienthttp://hl7.org/fhir/fhir-typesIngredient

An ingredient of a manufactured item or pharmaceutical product.

  InsurancePlanhttp://hl7.org/fhir/fhir-typesInsurancePlan

Details of a Health Insurance product/plan provided by an organization.

  InventoryReporthttp://hl7.org/fhir/fhir-typesInventoryReport

A report of inventory or stock items.

  Invoicehttp://hl7.org/fhir/fhir-typesInvoice

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

  Libraryhttp://hl7.org/fhir/fhir-typesLibrary

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.

  Linkagehttp://hl7.org/fhir/fhir-typesLinkage

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

  Listhttp://hl7.org/fhir/fhir-typesList

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

  Locationhttp://hl7.org/fhir/fhir-typesLocation

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

  ManufacturedItemDefinitionhttp://hl7.org/fhir/fhir-typesManufacturedItemDefinition

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

  Measurehttp://hl7.org/fhir/fhir-typesMeasure

The Measure resource provides the definition of a quality measure.

  MeasureReporthttp://hl7.org/fhir/fhir-typesMeasureReport

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

  Medicationhttp://hl7.org/fhir/fhir-typesMedication

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.

  MedicationAdministrationhttp://hl7.org/fhir/fhir-typesMedicationAdministration

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.

  MedicationDispensehttp://hl7.org/fhir/fhir-typesMedicationDispense

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.

  MedicationKnowledgehttp://hl7.org/fhir/fhir-typesMedicationKnowledge

Information about a medication that is used to support knowledge.

  MedicationRequesthttp://hl7.org/fhir/fhir-typesMedicationRequest

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.

  MedicationUsagehttp://hl7.org/fhir/fhir-typesMedicationUsage

A record of a medication that is being consumed by a patient. A MedicationUsage 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 medicationusage 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 medicationusage 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 Usage 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.

  MedicinalProductDefinitionhttp://hl7.org/fhir/fhir-typesMedicinalProductDefinition

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

  MessageDefinitionhttp://hl7.org/fhir/fhir-typesMessageDefinition

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.

  MessageHeaderhttp://hl7.org/fhir/fhir-typesMessageHeader

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.

  MetadataResourcehttp://hl7.org/fhir/fhir-typesMetadataResource

Common Interface declaration for conformance and knowledge artifact resources.

  MolecularSequencehttp://hl7.org/fhir/fhir-typesMolecularSequence

Representation of a molecular sequence.

  NamingSystemhttp://hl7.org/fhir/fhir-typesNamingSystem

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.

  NutritionIntakehttp://hl7.org/fhir/fhir-typesNutritionIntake

A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid 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 or fluids 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.

  NutritionOrderhttp://hl7.org/fhir/fhir-typesNutritionOrder

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

  NutritionProducthttp://hl7.org/fhir/fhir-typesNutritionProduct

A food or supplement that is consumed by patients.

  Observationhttp://hl7.org/fhir/fhir-typesObservation

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

  ObservationDefinitionhttp://hl7.org/fhir/fhir-typesObservationDefinition

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

  OperationDefinitionhttp://hl7.org/fhir/fhir-typesOperationDefinition

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

  OperationOutcomehttp://hl7.org/fhir/fhir-typesOperationOutcome

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

  Organizationhttp://hl7.org/fhir/fhir-typesOrganization

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, payer/insurer, etc.

  OrganizationAffiliationhttp://hl7.org/fhir/fhir-typesOrganizationAffiliation

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

  PackagedProductDefinitionhttp://hl7.org/fhir/fhir-typesPackagedProductDefinition

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

  Patienthttp://hl7.org/fhir/fhir-typesPatient

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

  PaymentNoticehttp://hl7.org/fhir/fhir-typesPaymentNotice

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

  PaymentReconciliationhttp://hl7.org/fhir/fhir-typesPaymentReconciliation

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

  Permissionhttp://hl7.org/fhir/fhir-typesPermission

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

  Personhttp://hl7.org/fhir/fhir-typesPerson

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

  PlanDefinitionhttp://hl7.org/fhir/fhir-typesPlanDefinition

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.

  Practitionerhttp://hl7.org/fhir/fhir-typesPractitioner

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

  PractitionerRolehttp://hl7.org/fhir/fhir-typesPractitionerRole

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

  Procedurehttp://hl7.org/fhir/fhir-typesProcedure

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.

  Provenancehttp://hl7.org/fhir/fhir-typesProvenance

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.

  Questionnairehttp://hl7.org/fhir/fhir-typesQuestionnaire

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.

  QuestionnaireResponsehttp://hl7.org/fhir/fhir-typesQuestionnaireResponse

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.

  RegulatedAuthorizationhttp://hl7.org/fhir/fhir-typesRegulatedAuthorization

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.

  RelatedPersonhttp://hl7.org/fhir/fhir-typesRelatedPerson

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

  RequestOrchestrationhttp://hl7.org/fhir/fhir-typesRequestOrchestration

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

  Requirementshttp://hl7.org/fhir/fhir-typesRequirements

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.

  ResearchStudyhttp://hl7.org/fhir/fhir-typesResearchStudy

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.

  ResearchSubjecthttp://hl7.org/fhir/fhir-typesResearchSubject

A physical entity which is the primary unit of operational and/or administrative interest in a study.

  RiskAssessmenthttp://hl7.org/fhir/fhir-typesRiskAssessment

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

  Schedulehttp://hl7.org/fhir/fhir-typesSchedule

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

  SearchParameterhttp://hl7.org/fhir/fhir-typesSearchParameter

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

  ServiceRequesthttp://hl7.org/fhir/fhir-typesServiceRequest

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

  Slothttp://hl7.org/fhir/fhir-typesSlot

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

  Specimenhttp://hl7.org/fhir/fhir-typesSpecimen

A sample to be used for analysis.

  SpecimenDefinitionhttp://hl7.org/fhir/fhir-typesSpecimenDefinition

A kind of specimen with associated set of requirements.

  StructureDefinitionhttp://hl7.org/fhir/fhir-typesStructureDefinition

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.

  StructureMaphttp://hl7.org/fhir/fhir-typesStructureMap

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

  Subscriptionhttp://hl7.org/fhir/fhir-typesSubscription

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

  SubscriptionStatushttp://hl7.org/fhir/fhir-typesSubscriptionStatus

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

  SubscriptionTopichttp://hl7.org/fhir/fhir-typesSubscriptionTopic

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

  Substancehttp://hl7.org/fhir/fhir-typesSubstance

A homogeneous material with a definite composition.

  SubstanceDefinitionhttp://hl7.org/fhir/fhir-typesSubstanceDefinition

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

  SubstanceNucleicAcidhttp://hl7.org/fhir/fhir-typesSubstanceNucleicAcid

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.

  SubstancePolymerhttp://hl7.org/fhir/fhir-typesSubstancePolymer

Properties of a substance specific to it being a polymer.

  SubstanceProteinhttp://hl7.org/fhir/fhir-typesSubstanceProtein

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.

  SubstanceReferenceInformationhttp://hl7.org/fhir/fhir-typesSubstanceReferenceInformation

Todo.

  SubstanceSourceMaterialhttp://hl7.org/fhir/fhir-typesSubstanceSourceMaterial

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.

  SupplyDeliveryhttp://hl7.org/fhir/fhir-typesSupplyDelivery

Record of delivery of what is supplied.

  SupplyRequesthttp://hl7.org/fhir/fhir-typesSupplyRequest

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.

  Taskhttp://hl7.org/fhir/fhir-typesTask

A task to be performed.

  TerminologyCapabilitieshttp://hl7.org/fhir/fhir-typesTerminologyCapabilities

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.

  TestReporthttp://hl7.org/fhir/fhir-typesTestReport

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

  TestScripthttp://hl7.org/fhir/fhir-typesTestScript

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

  Transporthttp://hl7.org/fhir/fhir-typesTransport

Record of transport.

  ValueSethttp://hl7.org/fhir/fhir-typesValueSet

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.

  VerificationResulthttp://hl7.org/fhir/fhir-typesVerificationResult

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

  VisionPrescriptionhttp://hl7.org/fhir/fhir-typesVisionPrescription

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

  Parametershttp://hl7.org/fhir/fhir-typesParameters

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.

 

See the full registry of value sets defined as part of FHIR.


Explanation of the columns that may appear on this page:

LvlA few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code system hierarchy - 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