Skip to content

Commit

Permalink
Updating links for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GinoCanessa committed Jul 21, 2020
1 parent d395386 commit 9a69013
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
36 changes: 18 additions & 18 deletions docfx/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,81 +2,81 @@

This section contains source code information for:

## Executable: [FhirCodegenCli](/api/FhirCodegenCli.html)
## Executable: [FhirCodegenCli](FhirCodegenCli.html)

A command-line tool for downloading, parsing, and exporting various versions of the FHIR specifications to other computer languages.

## Executable: [FhirCodegenTestCli](/api/FhirCodegenTestCli.html)
## Executable: [FhirCodegenTestCli](FhirCodegenTestCli.html)

A command-line tool for exercising the code generation functionality.

## Library: [Microsoft.Health.Fhir.SpecManager](/api/Microsoft.Health.Fhir.SpecManager.html)
## Library: [Microsoft.Health.Fhir.SpecManager](Microsoft.Health.Fhir.SpecManager.html)

Main library to handling downloading, parsing, and exporting various versions of the FHIR specifications.

Parent namespace for all library functionality.

## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Converters](/api/Microsoft.Health.Fhir.SpecManager.Converters.html)
## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Converters](Microsoft.Health.Fhir.SpecManager.Converters.html)

Classes to convert from various FHIR versions into the internal structures used in the library.

Each version-specific loader implements `IFhirConverter`.

## Library Namespaces for Specific FHIR Versions

* [Microsoft.Health.Fhir.SpecManager.fhir.r2](/api/Microsoft.Health.Fhir.SpecManager.fhir.r2.html)
* [Microsoft.Health.Fhir.SpecManager.fhir.r2](Microsoft.Health.Fhir.SpecManager.fhir.r2.html)

Classes for parsing FHIR DSTU2 (R2) JSON files. Validated against version 1.0.2.

* [Microsoft.Health.Fhir.SpecManager.fhir.r3](/api/Microsoft.Health.Fhir.SpecManager.fhir.r3.html)
* [Microsoft.Health.Fhir.SpecManager.fhir.r3](Microsoft.Health.Fhir.SpecManager.fhir.r3.html)

Classes for parsing FHIR STU3 (R3) JSON files. Validated against version 3.0.2.

* [Microsoft.Health.Fhir.SpecManager.fhir.r4](/api/Microsoft.Health.Fhir.SpecManager.fhir.r4.html)
* [Microsoft.Health.Fhir.SpecManager.fhir.r4](Microsoft.Health.Fhir.SpecManager.fhir.r4.html)

Classes for parsing FHIR R4 JSON files. Validated against version 4.0.1.

* [Microsoft.Health.Fhir.SpecManager.fhir.r5](/api/Microsoft.Health.Fhir.SpecManager.fhir.r5.html)
* [Microsoft.Health.Fhir.SpecManager.fhir.r5](Microsoft.Health.Fhir.SpecManager.fhir.r5.html)

Classes for parsing FHIR R5 JSON files. Validated against version 4.4.0 (May 2020).

## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Language](/api/Microsoft.Health.Fhir.SpecManager.Language.html)
## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Language](Microsoft.Health.Fhir.SpecManager.Language.html)

Classes used to export different languages from a loaded version of FHIR.

* Interface [ILanguage](/api/Microsoft.Health.Fhir.SpecManager.Language.ILanguage.html)
* Interface [ILanguage](Microsoft.Health.Fhir.SpecManager.Language.ILanguage.html)

Interface used to define a language available for export.

* Class [ExportStreamWriter](/api/Microsoft.Health.Fhir.SpecManager.Language.ExportStreamWriter.html)
* Class [ExportStreamWriter](Microsoft.Health.Fhir.SpecManager.Language.ExportStreamWriter.html)

Extended `System.IO.StreamWriter` used for internally-defined languages. Includes convenience functions to ease exporting code files.

* Class [LanguageHelper](/api/Microsoft.Health.Fhir.SpecManager.Language.LanguageHelper.html)
* Class [LanguageHelper](Microsoft.Health.Fhir.SpecManager.Language.LanguageHelper.html)

Utilities for working with Languages for export.

* Internally Defined Langauges
* [Info](/api/Microsoft.Health.Fhir.SpecManager.Language.Info.html)
* [Info](Microsoft.Health.Fhir.SpecManager.Language.Info.html)

Basic text output of a version of FHIR for information and testing.

* [CSharpBasic](/api/Microsoft.Health.Fhir.SpecManager.Language.CSharpBasic.html)
* [CSharpBasic](Microsoft.Health.Fhir.SpecManager.Language.CSharpBasic.html)

Basic C# language bindings, useful for prototyping and small projects. Exported classes are able to serialize to and parse from FHIR JSON.

* [TypeScript](/api/Microsoft.Health.Fhir.SpecManager.Language.TypeScript.html)
* [TypeScript](Microsoft.Health.Fhir.SpecManager.Language.TypeScript.html)

Basic TypeScript bindings, useful for prototyping and small projects. Exported classes are able to serialize to and parse from FHIR JSON.

* [CSharpFirely](/api/Microsoft.Health.Fhir.SpecManager.Language.CSharpFirely.html) **EXPERIMENTAL**
* [CSharpFirely](Microsoft.Health.Fhir.SpecManager.Language.CSharpFirely.html) **EXPERIMENTAL**

Export base C# classes needed for the Firely-maintained C# API ([FHIR-Net-API](https://github.com/FirelyTeam/fhir-net-api/)).

## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Manager](/api/Microsoft.Health.Fhir.SpecManager.Manager.html)
## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Manager](Microsoft.Health.Fhir.SpecManager.Manager.html)

Classes used to manage FHIR versions.

## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Models](/api/Microsoft.Health.Fhir.SpecManager.Models.html)
## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Models](Microsoft.Health.Fhir.SpecManager.Models.html)

Model classes used in the library.
4 changes: 2 additions & 2 deletions docfx/articles/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

The system is designed to allow developers to add additional languages to be exported.

Language files must be added to the `src/Microsoft.Health.Fhir.SpecManager/Langauge` directory, and implement the [ILanguage](/api/Microsoft.Health.Fhir.SpecManager.Language.ILanguage.html) interface present in the same directory.
Language files must be added to the `src/Microsoft.Health.Fhir.SpecManager/Langauge` directory, and implement the [ILanguage](/fhir-codegen/api/Microsoft.Health.Fhir.SpecManager.Language.ILanguage.html) interface present in the same directory.

The library loads and parses all FHIR versions into a consistent local model.

During export, the interface function `Export` is called, with a `FhirVersionInfo` already set to all user options (e.g., the requested version of FHIR has been loaded, filtering has been applied, etc.).

The `Export` function may write as many files as desired in the `exportDirectory`. The exporter will move those files into the user-requested directory, and will bundle them together in an archive if necessary (relative paths are preserved).

The [Info](/api/Microsoft.Health.Fhir.SpecManager.Language.Info.html), [CSharpBasic](/api/Microsoft.Health.Fhir.SpecManager.Language.CSharpBasic.html), and [TypeScript](/api/Microsoft.Health.Fhir.SpecManager.Language.TypeScript.html) languages are all available as references on how to traverse the various structures.
The [Info](/fhir-codegen/api/Microsoft.Health.Fhir.SpecManager.Language.Info.html), [CSharpBasic](/fhir-codegen/api/Microsoft.Health.Fhir.SpecManager.Language.CSharpBasic.html), and [TypeScript](/fhir-codegen/api/Microsoft.Health.Fhir.SpecManager.Language.TypeScript.html) languages are all available as references on how to traverse the various structures.

0 comments on commit 9a69013

Please sign in to comment.