Nifty Pony Merchandise

    @medplum/fhirtypes
    TypeScript icon, indicating that this package has built-in type declarations

    0.9.5 • Public • Published

    Medplum FHIR Type Definitions

    This library contains TypeScript type definitions for all R4 types.

    Installation

    Add as a dependency:

    npm install --save-dev @medplum/fhirtypes

    Basic Usage

    Consider the following untyped code:

    const myPatient = {
      resourceType: 'Patient',
      name: 'George Washington',
    };

    Keen observers will note that Patient.name should not be a string. Instead, it should be an array of HumanName objects.

    Let's add the type definition and see what happens:

    import { Patient } from '@medplum/fhirtypes';
    
    const myPatient: Patient = {
      resourceType: 'Patient',
      name: 'George Wasington',
    };

    Now "name" is a compile error. Developer tools with TypeScript support should provide feedback. For example, VS Code adds red squigglies and a helpful error message:

    Medplum fhirtypes screenshot

    And now you will receive typeahead support:

    Medplum fhirtypes typeahead

    So we can build a well-formed example:

    import { Patient } from '@medplum/fhirtypes';
    
    const myPatient: Patient = {
      resourceType: 'Patient',
      name: [
        {
          given: ['George'],
          family: 'Washington',
        },
      ],
    };

    About Medplum

    Medplum is a healthcare platform that helps you quickly develop high-quality compliant applications. Medplum includes a FHIR server, React component library, and developer app.

    License

    Apache 2.0. Copyright © Medplum 2022

    Install

    npm i @medplum/fhirtypes

    DownloadsWeekly Downloads

    587

    Version

    0.9.5

    License

    Apache-2.0

    Unpacked Size

    2.44 MB

    Total Files

    200

    Last publish

    Collaborators

    • codyebberson