Add table showing mapping between Julia packages and standards/specif…

…ications (#107) * Add table showing mapping between Julia packages and standards/specifications Taken from https://github.com/JuliaHealth/SMARTAppLaunch.jl * Bump version number from "0.7.5" to "0.7.6"
JuliaHealth · Feb 17, 2021 · 3748b6b · 3748b6b · DilumAluthge · Feb 17, 2021
1 parent a9fa40d
commit 3748b6b
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 19 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "FHIRClient"
 uuid = "b44d2ca2-8176-4fa9-8684-826e17b2a2da"
 authors = ["Dilum Aluthge", "Rhode Island Quality Institute", "contributors"]
-version = "0.7.5"
+version = "0.7.6"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

diff --git a/README.md b/README.md
@@ -26,15 +26,24 @@ applications.
 
 Please see the [documentation](https://juliahealth.org/FHIRClient.jl/stable/).
 
----
+The following tables show the mapping between Julia packages and
+standards/specifications:
+
+| Julia Package | Standard/Specification | Description |
+| ------------- | ---------------------- | ----------- |
+| [FHIRClient.jl](https://github.com/JuliaHealth/FHIRClient.jl) | [FHIR](https://hl7.org/fhir/) | Fast Healthcare Interoperability Resources. Web standard for health interop. |
+| [SMARTAppLaunch.jl](https://github.com/JuliaHealth/SMARTAppLaunch.jl) | [SMART App Launch](https://hl7.org/fhir/smart-app-launch/) | User-facing apps that connect to EHRs and health portals. |
 
-FHIRClient implements the following functionality:
-1. [FHIR](https://hl7.org/fhir/): Fast Healthcare Interoperability Resources. Web standard for health interop.
+---
 
-We currently do not implement the following; however, we would like to do so
+We currently do not implement the following; however, we plan to implement them
 in the future:
-1. [CDS Hooks](https://cds-hooks.hl7.org/): Clinical Decision Support Hooks. Web standard for CDS in the EHR workflow.
-2. [US Core Data Profiles](https://www.hl7.org/fhir/us/core/): FHIR data profiles for health data in the US (“core data for interoperability”).
-3. [FHIR Bulk Data API Implementation Guide](https://hl7.org/fhir/uv/bulkdata/): FHIR export API for large-scale data access.
-4. [SMART App Launch](https://hl7.org/fhir/smart-app-launch/): User-facing apps that connect to EHRs and health portals.
-5. [SMART Backend Services](https://hl7.org/fhir/uv/bulkdata/authorization/): Server-to-server FHIR connections.
+
+| Standard/Specification | Description |
+| ---------------------- | ----------- |
+| [CDS Hooks](https://cds-hooks.hl7.org/) | Clinical Decision Support Hooks. Web standard for CDS in the EHR workflow. |
+| [FHIR Bulk Data Access (Flat FHIR)](https://hl7.org/fhir/uv/bulkdata/) | FHIR export API for large-scale data access. |
+| [SMART Backend Services](https://hl7.org/fhir/uv/bulkdata/authorization/) | Server-to-server FHIR connections. |
+
+These descriptions are taken from the
+[SMART on FHIR technical documentation](https://docs.smarthealthit.org/).
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -13,15 +13,24 @@ applications.
 
 The source code for this package is available in the [GitHub repository](https://github.com/JuliaHealth/FHIRClient.jl).
 
----
+The following tables show the mapping between Julia packages and
+standards/specifications:
+
+| Julia Package | Standard/Specification | Description |
+| ------------- | ---------------------- | ----------- |
+| [FHIRClient.jl](https://github.com/JuliaHealth/FHIRClient.jl) | [FHIR](https://hl7.org/fhir/) | Fast Healthcare Interoperability Resources. Web standard for health interop. |
+| [SMARTAppLaunch.jl](https://github.com/JuliaHealth/SMARTAppLaunch.jl) | [SMART App Launch](https://hl7.org/fhir/smart-app-launch/) | User-facing apps that connect to EHRs and health portals. |
 
-FHIRClient implements the following functionality:
-1. [FHIR](https://hl7.org/fhir/): Fast Healthcare Interoperability Resources. Web standard for health interop.
+---
 
-We currently do not implement the following; however, we would like to do so
+We currently do not implement the following; however, we plan to implement them
 in the future:
-1. [CDS Hooks](https://cds-hooks.hl7.org/): Clinical Decision Support Hooks. Web standard for CDS in the EHR workflow.
-2. [US Core Data Profiles](https://www.hl7.org/fhir/us/core/): FHIR data profiles for health data in the US (“core data for interoperability”).
-3. [FHIR Bulk Data API Implementation Guide](https://hl7.org/fhir/uv/bulkdata/): FHIR export API for large-scale data access.
-4. [SMART App Launch](https://hl7.org/fhir/smart-app-launch/): User-facing apps that connect to EHRs and health portals.
-5. [SMART Backend Services](https://hl7.org/fhir/uv/bulkdata/authorization/): Server-to-server FHIR connections.
+
+| Standard/Specification | Description |
+| ---------------------- | ----------- |
+| [CDS Hooks](https://cds-hooks.hl7.org/) | Clinical Decision Support Hooks. Web standard for CDS in the EHR workflow. |
+| [FHIR Bulk Data Access (Flat FHIR)](https://hl7.org/fhir/uv/bulkdata/) | FHIR export API for large-scale data access. |
+| [SMART Backend Services](https://hl7.org/fhir/uv/bulkdata/authorization/) | Server-to-server FHIR connections. |
+
+These descriptions are taken from the
+[SMART on FHIR technical documentation](https://docs.smarthealthit.org/).