Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

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

Clinical Quality Information icon Work Group Maturity Level: NNormative (from v4.0.0) Use Context: Not Intended for Production use, Not Intended for Production use

This is a code system defined by the FHIR project.

Summary

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

All FHIR types

Committee:Clinical Quality Information icon Work Group
OID:2.16.840.1.113883.4.642.4.1802 (for OID based terminology systems)
Flags:Experimental, CaseSensitive, Complete
All codes ValueSet:All FHIR Types

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:

Properties

CodeURLType
abstract-typehttp://hl7.org/fhir/concept-properties#abstract-typeboolean
kindhttp://hl7.org/fhir/concept-properties#kindcode
interfacehttp://hl7.org/fhir/concept-properties#interfaceboolean

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

LvlCodeDisplayDefinitionabstract-typekindinterfaceCopy
1Base BaseBase Type: Base definition for all types defined in FHIR type system.truebtn btn
2  Element ElementElement Type: Base definition for all elements in a resource.truedatatypebtn btn
3    BackboneElement BackboneElementBackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.truedatatypebtn btn
3    DataType DataTypeDataType Type: The base class for all re-useable types defined as part of the FHIR Specification.truedatatypebtn btn
4      Address AddressAddress 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.datatypebtn btn
4      Annotation AnnotationAnnotation Type: A text note which also contains information about who made the statement and when.datatypebtn btn
4      Attachment AttachmentAttachment Type: For referring to data content defined in other formats.datatypebtn btn
4      Availability AvailabilityAvailability Type: Availability data for an {item}.datatypebtn btn
4      BackboneType BackboneTypeBackboneType Type: Base definition for the few data types that are allowed to carry modifier extensions.truedatatypebtn btn
5        Dosage DosageDosage Type: Indicates how the medication is/was taken or should be taken by the patient.datatypebtn btn
5        ElementDefinition ElementDefinitionElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.datatypebtn btn
5        MarketingStatus MarketingStatusMarketingStatus 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.datatypebtn btn
5        Population PopulationPopulation Type: A populatioof people with some set of grouping criteria.datatypebtn btn
5        ProductShelfLife ProductShelfLifeProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.datatypebtn btn
5        Timing TimingTiming 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.datatypebtn btn
4      CodeableConcept CodeableConceptCodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.datatypebtn btn
4      CodeableReference CodeableReferenceCodeableReference Type: A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).datatypebtn btn
4      Coding CodingCoding Type: A reference to a code defined by a terminology system.datatypebtn btn
4      ContactDetail ContactDetailContactDetail Type: Specifies contact information for a person or organization.datatypebtn btn
4      ContactPoint ContactPointContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.datatypebtn btn
4      Contributor ContributorContributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.datatypebtn btn
4      DataRequirement DataRequirementDataRequirement 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.datatypebtn btn
4      Expression ExpressionExpression 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.datatypebtn btn
4      ExtendedContactDetail ExtendedContactDetailExtendedContactDetail Type: Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.datatypebtn btn
4      Extension ExtensionExtension Type: Optional Extension Element - found in all resources.datatypebtn btn
4      HumanName HumanNameHumanName 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.datatypebtn btn
4      Identifier IdentifierIdentifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.datatypebtn btn
4      Meta MetaMeta 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.datatypebtn btn
4      MonetaryComponent MonetaryComponentMonetaryComponent Type: Availability data for an {item}.datatypebtn btn
4      Money MoneyMoney Type: An amount of economic utility in some recognized currency.datatypebtn btn
4      Narrative NarrativeNarrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.datatypebtn btn
4      ParameterDefinition ParameterDefinitionParameterDefinition 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.datatypebtn btn
4      Period PeriodPeriod Type: A time period defined by a start and end date and optionally time.datatypebtn btn
4      PrimitiveType PrimitiveTypePrimitiveType Type: The base type for all re-useable types defined that have a simple property.truedatatypebtn btn
5        base64Binary base64Binarybase64Binary Type: A stream of bytesprimitivebtn btn
5        boolean booleanboolean Type: Value of "true" or "false"primitivebtn btn
5        date datedate 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.primitivebtn btn
5        dateTime dateTimedateTime 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.primitivebtn btn
5        decimal decimaldecimal Type: A rational number with implicit precisionprimitivebtn btn
5        instant instantinstant Type: An instant in time - known at least to the secondprimitivebtn btn
5        integer integerinteger Type: A whole numberprimitivebtn btn
6          positiveInt positiveIntpositiveInt type: An integer with a value that is positive (e.g. >0)primitivebtn btn
6          unsignedInt unsignedIntunsignedInt type: An integer with a value that is not negative (e.g. >= 0)primitivebtn btn
5        integer64 integer64integer64 Type: A very large whole numberprimitivebtn btn
5        string stringstring Type: A sequence of Unicode charactersprimitivebtn btn
6          code codecode 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 contentsprimitivebtn btn
6          id idid 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.primitivebtn btn
6          markdown markdownmarkdown type: A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engineprimitivebtn btn
5        time timetime Type: A time during the day, with no date specifiedprimitivebtn btn
5        uri uriuri Type: String of characters used to identify a name or a resourceprimitivebtn btn
6          canonical canonicalcanonical type: A URI that is a reference to a canonical URL on a FHIR resourceprimitivebtn btn
6          oid oidoid type: An OID represented as a URIprimitivebtn btn
6          url urlurl type: A URI that is a literal referenceprimitivebtn btn
6          uuid uuiduuid type: A UUID, represented as a URIprimitivebtn btn
4      Quantity QuantityQuantity 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.datatypebtn btn
5        Age AgeAge Type: A duration of time during which an organism (or a process) has existed.datatypebtn btn
5        Count CountCount 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.datatypebtn btn
5        Distance DistanceDistance Type: A length - a value with a unit that is a physical distance.datatypebtn btn
5        Duration DurationDuration Type: A length of time.datatypebtn btn
5        Quantity QuantityAn amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision)datatypebtn btn
5        Quantity QuantityA fixed quantity (no comparator)datatypebtn btn
4      Range RangeRange Type: A set of ordered Quantities defined by a low and high limit.datatypebtn btn
4      Ratio RatioRatio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.datatypebtn btn
4      RatioRange RatioRangeRatioRange Type: A range of ratios expressed as a low and high numerator and a denominator.datatypebtn btn
4      Reference ReferenceReference Type: A reference from one resource to another.datatypebtn btn
4      RelatedArtifact RelatedArtifactRelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.datatypebtn btn
4      SampledData SampledDataSampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.datatypebtn btn
4      Signature SignatureSignature 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.datatypebtn btn
4      TriggerDefinition TriggerDefinitionTriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.datatypebtn btn
4      UsageContext UsageContextUsageContext 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).datatypebtn btn
4      VirtualServiceDetail VirtualServiceDetailVirtualServiceDetail Type: Virtual Service Contact Details.datatypebtn btn
3    xhtml xhtmlxhtml Type definitionprimitivebtn btn
2  Resource ResourceThis is the base resource type for everything.trueresourcebtn btn
3    Binary BinaryA 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.resourcebtn btn
3    Bundle BundleA container for a collection of resources.resourcebtn btn
3    DomainResource DomainResourceA resource that includes narrative, extensions, and contained resources.trueresourcebtn btn
4      Account AccountA financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.resourcebtn btn
4      ActivityDefinition ActivityDefinitionThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.resourcebtn btn
4      ActorDefinition ActorDefinitionThe 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.resourcebtn btn
4      AdministrableProductDefinition AdministrableProductDefinitionA 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).resourcebtn btn
4      AdverseEvent AdverseEventAn 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 arenas, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.resourcebtn btn
4      AllergyIntolerance AllergyIntoleranceRisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.resourcebtn btn
4      Appointment AppointmentA 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).resourcebtn btn
4      AppointmentResponse AppointmentResponseA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.resourcebtn btn
4      ArtifactAssessment ArtifactAssessmentThis Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.resourcebtn btn
4      AuditEvent AuditEventA record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.resourcebtn btn
4      Basic BasicBasic 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.resourcebtn btn
4      BiologicallyDerivedProduct BiologicallyDerivedProductA biological material originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.resourcebtn btn
4      BodyStructure BodyStructureRecord 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.resourcebtn btn
4      CanonicalResource CanonicalResourceCommon Interface declaration for conformance and knowledge artifact resources.trueresourcetruebtn btn
4      CapabilityStatement CapabilityStatementA 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.resourcebtn btn
4      CarePlan CarePlanDescribes 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.resourcebtn btn
4      CareTeam CareTeamThe Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care.resourcebtn btn
4      ChargeItem ChargeItemThe 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.resourcebtn btn
4      ChargeItemDefinition ChargeItemDefinitionThe 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.resourcebtn btn
4      Citation CitationThe 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.resourcebtn btn
4      Claim ClaimA 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.resourcebtn btn
4      ClaimResponse ClaimResponseThis resource provides the adjudication details from the processing of a Claim resource.resourcebtn btn
4      ClinicalImpression ClinicalImpressionA 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.resourcebtn btn
4      ClinicalUseDefinition ClinicalUseDefinitionA single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.resourcebtn btn
4      CodeSystem CodeSystemThe 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.resourcebtn btn
4      Communication CommunicationA 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.resourcebtn btn
4      CommunicationRequest CommunicationRequestA 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.resourcebtn btn
4      CompartmentDefinition CompartmentDefinitionA compartment definition that defines how resources are accessed on a server.resourcebtn btn
4      Composition CompositionA 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.).resourcebtn btn
4      ConceptMap ConceptMapA 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.resourcebtn btn
4      Condition ConditionA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.resourcebtn btn
4      ConditionDefinition ConditionDefinitionA definition of a condition and information relevant to managing it.resourcebtn btn
4      Consent ConsentA 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.resourcebtn btn
4      Contract ContractLegally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.resourcebtn btn
4      Coverage CoverageFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.resourcebtn btn
4      CoverageEligibilityRequest CoverageEligibilityRequestThe 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.resourcebtn btn
4      CoverageEligibilityResponse CoverageEligibilityResponseThis resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.resourcebtn btn
4      DetectedIssue DetectedIssueIndicates 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.resourcebtn btn
4      Device DeviceThis 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.resourcebtn btn
4      DeviceDefinition DeviceDefinitionThis is a specialized resource that defines the characteristics and capabilities of a device.resourcebtn btn
4      DeviceDispense DeviceDispenseIndicates 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.resourcebtn btn
4      DeviceMetric DeviceMetricDescribes a measurement, calculation or setting capability of a medical device.resourcebtn btn
4      DeviceRequest DeviceRequestRepresents 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.resourcebtn btn
4      DeviceUsage DeviceUsageA record of a device being used by a patient where the record is the result of a report from the patient or a clinician.resourcebtn btn
4      DiagnosticReport DiagnosticReportThe 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.resourcebtn btn
4      DocumentManifest DocumentManifestA collection of documents compiled for a purpose together with metadata that applies to the collection.resourcebtn btn
4      DocumentReference DocumentReferenceA 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.resourcebtn btn
4      Encounter EncounterAn 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).resourcebtn btn
4      Endpoint EndpointThe 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.resourcebtn btn
4      EnrollmentRequest EnrollmentRequestThis resource provides the insurance enrollment details to the insurer regarding a specified coverage.resourcebtn btn
4      EnrollmentResponse EnrollmentResponseThis resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.resourcebtn btn
4      EpisodeOfCare EpisodeOfCareAn 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.resourcebtn btn
4      EventDefinition EventDefinitionThe EventDefinition resource provides a reusable description of when a particular event can occur.resourcebtn btn
4      Evidence EvidenceThe 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.resourcebtn btn
4      EvidenceReport EvidenceReportThe 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.resourcebtn btn
4      EvidenceVariable EvidenceVariableThe EvidenceVariable resource describes an element that knowledge (Evidence) is about.resourcebtn btn
4      ExampleScenario ExampleScenarioA walkthrough of a workflow showing the interaction between systems and the instances shared, possibly including the evolution of instances over time.resourcebtn btn
4      ExplanationOfBenefit ExplanationOfBenefitThis 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.resourcebtn btn
4      FamilyMemberHistory FamilyMemberHistorySignificant health conditions for a person related to the patient relevant in the context of care for the patient.resourcebtn btn
4      Flag FlagProspective warnings of potential issues when providing care to the patient.resourcebtn btn
4      FormularyItem FormularyItemThis 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.resourcebtn btn
4      GenomicStudy GenomicStudyA Genomic Study is a set of analysis performed to analyze and generate genomic data.resourcebtn btn
4      Goal GoalDescribes 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.resourcebtn btn
4      GraphDefinition GraphDefinitionA 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.resourcebtn btn
4      Group GroupRepresents 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.resourcebtn btn
4      GuidanceResponse GuidanceResponseA 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.resourcebtn btn
4      HealthcareService HealthcareServiceThe 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.resourcebtn btn
4      ImagingSelection ImagingSelectionA 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.resourcebtn btn
4      ImagingStudy ImagingStudyRepresentation 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.resourcebtn btn
4      Immunization ImmunizationDescribes 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.resourcebtn btn
4      ImmunizationEvaluation ImmunizationEvaluationDescribes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.resourcebtn btn
4      ImmunizationRecommendation ImmunizationRecommendationA patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.resourcebtn btn
4      ImplementationGuide ImplementationGuideA 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.resourcebtn btn
4      Ingredient IngredientAn ingredient of a manufactured item or pharmaceutical product.resourcebtn btn
4      InsurancePlan InsurancePlanDetails of a Health Insurance product/plan provided by an organization.resourcebtn btn
4      InventoryReport InventoryReportA report of inventory or stock items.resourcebtn btn
4      Invoice InvoiceInvoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.resourcebtn btn
4      Library LibraryThe 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.resourcebtn btn
4      Linkage LinkageIdentifies two or more records (resource instances) that refer to the same real-world "occurrence".resourcebtn btn
4      List ListA List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.resourcebtn btn
4      Location LocationDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.resourcebtn btn
4      ManufacturedItemDefinition ManufacturedItemDefinitionThe definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.resourcebtn btn
4      Measure MeasureThe Measure resource provides the definition of a quality measure.resourcebtn btn
4      MeasureReport MeasureReportThe MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.resourcebtn btn
4      Medication MedicationThis 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.resourcebtn btn
4      MedicationAdministration MedicationAdministrationDescribes 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.resourcebtn btn
4      MedicationDispense MedicationDispenseIndicates 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.resourcebtn btn
4      MedicationKnowledge MedicationKnowledgeInformation about a medication that is used to support knowledge.resourcebtn btn
4      MedicationRequest MedicationRequestAn 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.resourcebtn btn
4      MedicationUsage MedicationUsageA 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.resourcebtn btn
4      MedicinalProductDefinition MedicinalProductDefinitionDetailed 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.).resourcebtn btn
4      MessageDefinition MessageDefinitionDefines 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.resourcebtn btn
4      MessageHeader MessageHeaderThe 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.resourcebtn btn
4      MetadataResource MetadataResourceCommon Interface declaration for conformance and knowledge artifact resources.trueresourcetruebtn btn
4      MolecularSequence MolecularSequenceRepresentation of a molecular sequence.resourcebtn btn
4      NamingSystem NamingSystemA 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.resourcebtn btn
4      NutritionIntake NutritionIntakeA 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.resourcebtn btn
4      NutritionOrder NutritionOrderA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.resourcebtn btn
4      NutritionProduct NutritionProductA food or supplement that is consumed by patients.resourcebtn btn
4      Observation ObservationMeasurements and simple assertions made about a patient, device or other subject.resourcebtn btn
4      ObservationDefinition ObservationDefinitionSet of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.resourcebtn btn
4      OperationDefinition OperationDefinitionA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).resourcebtn btn
4      OperationOutcome OperationOutcomeA collection of error, warning, or information messages that result from a system action.resourcebtn btn
4      Organization OrganizationA 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.resourcebtn btn
4      OrganizationAffiliation OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship.resourcebtn btn
4      PackagedProductDefinition PackagedProductDefinitionA medically related item or items, in a container or package.resourcebtn btn
4      Patient PatientDemographics and other administrative information about an individual or animal receiving care or other health-related services.resourcebtn btn
4      PaymentNotice PaymentNoticeThis resource provides the status of the payment for goods and services rendered, and the request and response resource references.resourcebtn btn
4      PaymentReconciliation PaymentReconciliationThis resource provides the details including amount of a payment and allocates the payment items being paid.resourcebtn btn
4      Permission PermissionPermission resource holds access rules for a given data and context.resourcebtn btn
4      Person PersonDemographics and administrative information about a person independent of a specific health-related context.resourcebtn btn
4      PlanDefinition PlanDefinitionThis 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.resourcebtn btn
4      Practitioner PractitionerA person who is directly or indirectly involved in the provisioning of healthcare or related services.resourcebtn btn
4      PractitionerRole PractitionerRoleA specific set of Roles/Locations/specialties/services that a practitioner may perform, or has performed at an organization during a period of time.resourcebtn btn
4      Procedure ProcedureAn 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.resourcebtn btn
4      Provenance ProvenanceProvenance 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.resourcebtn btn
4      Questionnaire QuestionnaireA 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.resourcebtn btn
4      QuestionnaireResponse QuestionnaireResponseA 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.resourcebtn btn
4      RegulatedAuthorization RegulatedAuthorizationRegulatory 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.resourcebtn btn
4      RelatedPerson RelatedPersonInformation 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.resourcebtn btn
4      RequestOrchestration RequestOrchestrationA set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".resourcebtn btn
4      Requirements RequirementsThe 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.resourcebtn btn
4      ResearchStudy ResearchStudyA 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.resourcebtn btn
4      ResearchSubject ResearchSubjectA physical entity which is the primary unit of operational and/or administrative interest in a study.resourcebtn btn
4      RiskAssessment RiskAssessmentAn assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.resourcebtn btn
4      Schedule ScheduleA container for slots of time that may be available for booking appointments.resourcebtn btn
4      SearchParameter SearchParameterA search parameter that defines a named search item that can be used to search/filter on a resource.resourcebtn btn
4      ServiceRequest ServiceRequestA record of a request for service such as diagnostic investigations, treatments, or operations to be performed.resourcebtn btn
4      Slot SlotA slot of time on a schedule that may be available for booking appointments.resourcebtn btn
4      Specimen SpecimenA sample to be used for analysis.resourcebtn btn
4      SpecimenDefinition SpecimenDefinitionA kind of specimen with associated set of requirements.resourcebtn btn
4      StructureDefinition StructureDefinitionA 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.resourcebtn btn
4      StructureMap StructureMapA Map of relationships between 2 structures that can be used to transform data.resourcebtn btn
4      Subscription SubscriptionThe subscription resource describes a particular client's request to be notified about a SubscriptionTopic.resourcebtn btn
4      SubscriptionStatus SubscriptionStatusThe SubscriptionStatus resource describes the state of a Subscription during notifications. It is not persisted.resourcebtn btn
4      SubscriptionTopic SubscriptionTopicDescribes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.resourcebtn btn
4      Substance SubstanceA homogeneous material with a definite composition.resourcebtn btn
4      SubstanceDefinition SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing.resourcebtn btn
4      SubstanceNucleicAcid SubstanceNucleicAcidNucleic 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.resourcebtn btn
4      SubstancePolymer SubstancePolymerProperties of a substance specific to it being a polymer.resourcebtn btn
4      SubstanceProtein SubstanceProteinA 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.resourcebtn btn
4      SubstanceReferenceInformation SubstanceReferenceInformationTodo.resourcebtn btn
4      SubstanceSourceMaterial SubstanceSourceMaterialSource 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.resourcebtn btn
4      SupplyDelivery SupplyDeliveryRecord of delivery of what is supplied.resourcebtn btn
4      SupplyRequest SupplyRequestA 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.resourcebtn btn
4      Task TaskA task to be performed.resourcebtn btn
4      TerminologyCapabilities TerminologyCapabilitiesA 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.resourcebtn btn
4      TestReport TestReportA summary of information based on the results of executing a TestScript.resourcebtn btn
4      TestScript TestScriptA structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.resourcebtn btn
4      Transport TransportRecord of transport.resourcebtn btn
4      ValueSet ValueSetA 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](terminologies.html).resourcebtn btn
4      VerificationResult VerificationResultDescribes validation requirements, source(s), status and dates for one or more elements.resourcebtn btn
4      VisionPrescription VisionPrescriptionAn authorization for the provision of glasses and/or contact lenses to a patient.resourcebtn btn
3    Parameters ParametersThis 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.resourcebtn btn

 

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


Explanation of the columns that may appear on this page:

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