Others titles

  • FHIR Basic Resource
  • Electronic Health Records Exchange Through FHIR


  • FHIR
  • HL7
  • Medical Terminology
  • Processes Data
  • Processes Information
  • Processes Documentation
  • Health Information Exchange
  • Electronic Health Records
  • FHIR Smart
  • Smart on FHIR


Basic is a special type of resource. Unlike all other resources, it does not correspond to a specific pre-defined Health Level Seven International (HL7) concept. Instead, it is a placeholder for any resource-like concept that is not already defined in the HL7 specification. Basic defines only those necessary data elements to identify the kind of resource it represents and those necessary to support resource compartmenting. All other data elements are represented using the extension mechanism.

Log in to download

Get The Data

  • The data in CSV format DOWNLOAD
  • Metadata in Human Readable format (PDF) DOWNLOAD
  • Metadata in Machine Readable format (JSON) DOWNLOAD
Your Data License
  • Research
    Non-Commercial, Share-Alike, Attribution Free Forever
  • Commercial
    Commercial Use, Remix & Adapt, White Label Buy Subscription


The Basic resource is intended for use in three circumstances:

– When an implementer needs a resource concept that is likely to be defined by Health Level Seven International (HL7) in the future, but they have not yet done so (due to bandwidth issues, lack of sufficient requirements, lower prioritization, etc.)
– When there is a need to convey a narrative-only construct that does not neatly correspond to one of the other resources, either because it combines aspects of several resources (e.g. Assessment + Plan) or because the allowed content is flexible such that the system cannot be totally sure what sort of content might have been included in the narrative text.
– Other than the circumstances above, this resource will see minimal use. To keep the Fast Healthcare Interoperability Resources (FHIR) specification manageable, it cannot incorporate every site-specific requirement that might be needed in some implementation somewhere. This set of resources likely will not ever be officially defined in HL7.

There is also a fourth circumstance: An implementer wishes to convey information that could/should be conveyed using a standard resource, however, they want to represent the information in a custom format that is not aligned with the official resource elements. While this resource would be the preferred way of meeting that use-case because it will at least be wire-format compatible, such a use would not be conformant because making use of the Basic resource would prevent the healthcare-related information from being safely processed, queried and analyzed by other conformant systems.

Implementers do not need to be concerned with which of the three categories their desired resource fits within. If they need a resource and it clearly does not fit one of the ones currently defined, they should use Basic.

Fast Healthcare Interoperability Resources (FHIR) is a draft standard describing data formats and elements (known as “resources”) and an application programming interface (API) for exchanging electronic health records. The standard was created by the Health Level Seven International (HL7) health-care standards organization.

Its goal is to facilitate interoperation between legacy healthcare systems, to make it easy to provide healthcare information to healthcare providers and individuals on a wide variety of devices from computers to tablets to cell phones, and to allow third-party application developers to provide medical applications which can be easily integrated into existing systems.

FHIR provides an alternative to document-centric approaches by directly exposing discrete data elements as services. For example, basic elements of healthcare like patients, admissions, diagnostic reports and medications can each be retrieved and manipulated via their own resource URLs (Uniform Resource Locators). FHIR was supported at an American Medical Informatics Association meeting by many EHR (Electronic Health Record) vendors which value its open and extensible nature.

About this Dataset

Data Info

Date Created


Last Modified




Update Frequency


Temporal Coverage


Spatial Coverage

United States


John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements


Source Citation



FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Basic Resource, Electronic Health Records Exchange Through FHIR

Data Fields

Name Description Type Constraints
Concept_NameName of the concept in the FHIR structurestringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe Dollar_Ref ($ref) string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON (JavaScript Object Notation) value being referenced.string-
DescriptionA free text natural language description of the structure and its usestring-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
RequiredThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
ConstThe value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword.string-

Data Preview

Concept NameComputer Ready NameTypeDollar RefDescriptionItemsRequiredConst
BasicresourceTypeThis is a Basic resourceBasic
Basicid#/definitions/idThe logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Basicmeta#/definitions/MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
BasicimplicitRules#/definitions/uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Basic_implicitRules#/definitions/ElementExtensions for implicitRules
Basiclanguage#/definitions/codeThe base language in which the resource is written.
Basic_language#/definitions/ElementExtensions for language
Basictext#/definitions/NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
BasiccontainedarrayThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.{'$ref': '#/definitions/ResourceList'}
BasicextensionarrayMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.{'$ref': '#/definitions/Extension'}