From b06aedcedfc6235f92cbe6b4ea790c850cb58635 Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Mon, 3 Aug 2020 07:50:49 -0400 Subject: [PATCH] Simplify some of the documentation (#34) * Update versions.md * Update Project.toml * Update versions.md * Fix a typo * Update versions.md * Update versions.md * Update versions.md --- Project.toml | 2 +- docs/src/versions.md | 28 +++++++++++----------------- 2 files changed, 12 insertions(+), 18 deletions(-) diff --git a/Project.toml b/Project.toml index c915ff9..5d4e887 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "FHIRClient" uuid = "b44d2ca2-8176-4fa9-8684-826e17b2a2da" authors = ["Dilum Aluthge", "Brown Center for Biomedical Informatics", "JuliaHealth", "contributors"] -version = "0.1.1" +version = "0.1.2" [deps] Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" diff --git a/docs/src/versions.md b/docs/src/versions.md index 3e4aa99..a4f20b2 100644 --- a/docs/src/versions.md +++ b/docs/src/versions.md @@ -2,32 +2,26 @@ CurrentModule = FHIRClient ``` -# CDM Version +# FHIR Versions -The following table shows which versions of the FHIR specifications are +The following table shows which versions of the FHIR specification are implemented in each version of the `FHIRClient.jl` Julia package. -| `FHIRClient.jl` | FHIR specification | -| --------------- | ------------------ | -| 0.1.0 | R4 (4.0.1) | +| `FHIRClient.jl` | FHIR releases | FHIR versions | +| --------------- | ------------- | ------------- | +| 0.1.0 | R4 | 4.0.1 (R4) | -In order to see the current FHIR versions, use the +In order to see the full FHIR version number +for a specific FHIR release, use the `FHIRClient.fhir_version` function: -```jldoctest -julia> using FHIRClient - -julia> FHIRClient.fhir_version(FHIRClient.R4()) -v"4.0.1" +```julia +julia> FHIRClient.fhir_version(FHIRClient.R4()) # prints the full FHIR version number for the R4 release ``` In order to see the current `FHIRClient.jl` version, use the `FHIRClient.version` function: - -```jldoctest -julia> using FHIRClient - -julia> FHIRClient.version() -v"0.1.1" +```julia +julia> FHIRClient.version() # prints the current `FHIRClient.jl` version number ``` To see all versions of the FHIR specification, go to the