HAPI FHIR Documentation

The @smile-cdr/fhirts package provides TypeScript model definitions for HL7 FHIR (DSTU2, DSTU3, R4, R4B, and R5). These types are automatically generated from the HAPI FHIR runtime model using hapi-fhir-tinder.

Note: Because these files are generated, you should not edit the files within the package directly.

The nickname-and-diminutive-names-lookup is a CSV-based dataset containing US given names (first names) and their associated nicknames or diminutive names (e.g., "gregory" maps to "greg", "geoffrey" maps to "geoff").

It is designed for name matching and lookup tasks. The dataset contains approximately 1,600 names and has been processed to be machine-readable (e.g., splitting names like "rickie(y)" into separate entries for "rickie" and "ricky").

To use this data, you can utilize the provided parsers for the following languages:

• Java
• Perl
• Python
• R

For enterprise-grade commercial support and professional services related to HAPI FHIR, contact Smile CDR.

• Commercial Support: https://smilecdr.com

For detailed technical documentation, implementation guides, and API references, visit the official HAPI FHIR documentation site. You can also interact with a live demonstration of the project to see it in action.

• Official Documentation: http://hapifhir.io
• Live Demonstration: http://hapi.fhir.org/

Install the @smile-cdr/fhirts package to access TypeScript model definitions for HL7 FHIR versions including DSTU2, DSTU3, R4, R4B, and R5.

npm install @smile-cdr/fhirts

If you use AI (e.g., LLMs like Claude Code, Cursor, Amp) as a tool for coding, you must disclose its use in your contribution.

1. State the tool used and the extent of the AI assistance.
2. Apply the GitHub label: Any Pull Request built with AI assistance must include the AI Assisted label.

HAPI FHIR requires human-centric communication. When interacting with maintainers:

• Do not use AI to generate comments or Pull Request descriptions. Comments are expected to be written by humans; AI-generated comments may be hidden or removed.
• Issues and PRs must be in your own words. You must be able to explain proposed changes and respond to maintainer questions without copying responses from an AI.
• Using AI for translation/editing: If using AI to assist as a non-native speaker, ensure the result reflects your own voice. If using AI for translation, write in your native language and include the AI translation in a quote block.
• Including AI context: If you must include context from an AI interaction, it must be in a quote block (using >) and accompanied by human commentary explaining its relevance. Avoid sharing long snippets.

To prevent naming collisions between identically named resources across different FHIR versions, @smile-cdr/fhirts exposes each version as a distinct namespace (e.g., R4, R4B, R5). When defining resource objects, use the versioned namespace to type the variable.

import { R4, R4B, R5 } from '@smile-cdr/fhirts';

const patient: R4.Patient = {
  resourceType: 'Patient',
  gender: 'female',
};

const r4bPatient: R4B.Patient = {
  resourceType: 'Patient',
  gender: 'female',
};

If you encounter issues or need assistance with the library, consult the community wiki for guidance on where to ask questions and how to get support.

• Community Help/Wiki: https://github.com/hapifhir/hapi-fhir/wiki/Getting-Help

To ensure your code matches the project's style, use the Maven Spotless plugin. Run the following command to automatically format your code:

mvn spotless:apply

Note that the project currently uses Java 17.