Skip to content
This repository has been archived by the owner on Jul 8, 2020. It is now read-only.

Latest commit

 

History

History
81 lines (60 loc) · 3.95 KB

README.md

File metadata and controls

81 lines (60 loc) · 3.95 KB
Raw

Deprecated

This project has been deprecated, please use FHIR CodeGen.

generate-fhir-prototype-bindings

A .Net Core utility to generate language bindings from FHIR sources for use in prototyping FHIR resources and small projects.

Currently supports serialziation to/from 'fhir+json' only.

Usage

Input Options:
  -i, --fhir-directory    Required. FHIR Base Directory
  --only-structure-defs   (Default: true) Set to use only Structure Definitions (<FHIR Base>/publish/)
  --only-xml-sheets       (Default: false) Set to use only XML Definition Spreadsheets (<FHIR Base>/source/)
  --types-for-xml-sheets  (Default: '') '|' separated list of resources to parse from XML Spreadsheets

Output Options:
  -o, --output-path       Required. Path or filename for output (will append appropriate extension if not provided)
  --output-single         (Default: true) Set to output a single file
  --types-to-output       (Default: '') '|' separated list of resources/types to export (will include all required parent/component types).
  --namespace             (Default: 'fhir') The Exported namespace or module name
  --exclude-code-systems  (Default: false) Set to exclude processing of Code Systems (as constants / enums)
  --exclude-value-sets    (Default: false) Set to exclude processing of Value Sets (as constants / enums)

Language Options:
  --ts                    (Default: false) Generate TypeScript bindings
  --cs                    (Default: false) Generate C# bindings, with annotations for System.Text.Json (.Net Core)
  --cs-plain              (Default: false) Generate C# bindings, with NO annotations (Raw C#)
  --cs-newtonsoft         (Default: false) Generate C# bindings, with annotations for Newtonsoft.Json

General Options:
  --help                  Display this help screen.
  --version               Display version information.

Example:

dotnet generate-fhir-prototype-bindings.dll -i /path/to/fhir -o /path/to/output.ts --ts

To Do:

  • Allow filtering on structure types (e.g., logical)
  • Output multiple files
  • Additional language support (Java, Swagger)
  • Runtime Type Checking for TypeScript
  • Better processing for external Code Systems
  • Allow Value Sets to pull from multiple Code Systems
  • Read Structure Definitions from URL (allow running without local FHIR files)
  • C# Polymorphic Deserialization
  • Explore XML serialization options
  • Explore exporting from Profiles (e.g., additional constraints and specific models only)

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

There are many other ways to contribute:

See Contributing for more information.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

FHIR® is the registered trademark of HL7 and is used with the permission of HL7.