Neighborly Package Megalodon
    Wondering what’s next for npm?Check out our public roadmap! »

    @ahryman40k/ts-fhir-types
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.36 • Public • Published

    typescript-fhir-types

    Typescript / Javascript object model for FHIR standard Model follows FHIR R4 specifications.

    npm version Build Status codecov Known Vulnerabilities Project dependencies overview(Beta) License: GPL v3

    Definitions are io-ts based interfaces. See io-ts github project for further details. This means you can check your types at runtime.

    Installation

    npm i -S @ahryman40k/ts-fhir-types
    

    or

    yarn install @ahryman40k/ts-fhir-types
    

    articles

    A medium article: Handle FHIR objects with Typescript

    Examples

    let's imagine your server or your application is receiving a FHIR Resource like an observation from a server or any external system

    import { R4 } from '@ahryman40k/ts-fhir-types'
    import { either as E } from 'fp-ts'
    
    const json = {
        "resourceType":"Patient"   
     };
    
    const  validationResult = R4.RTTI_Patient.decode(json)
    
    if ( E.isLeft( validationResult) ) {
        console.log(validationResult.left);
    }
    
    if ( E.isRight( validationResult) ) {
        console.log(validationResult.right);
    }

    There is 2 points:

    • You would like to have strongly typed types (typescript)
    • You would validate data returned from server and test their validity against FHIR standard

    FHIR resources are also provided as interface, so you can inherit and implement your own object implementation.

    Please don't hesitate to give me advice and feedback !

    Keywords

    none

    Install

    npm i @ahryman40k/ts-fhir-types

    DownloadsWeekly Downloads

    9,126

    Version

    4.0.36

    License

    MIT

    Unpacked Size

    3.86 MB

    Total Files

    2080

    Last publish

    Collaborators

    • avatar