From 2f863940969ea9384cb057d5cda29af9b15ab87a Mon Sep 17 00:00:00 2001 From: Sean Fong Date: Thu, 4 Jul 2024 11:18:48 +0930 Subject: [PATCH] Clean up READMEs --- services/assemble-express/README.md | 6 +++--- services/extract-express/README.md | 12 ++++++++---- services/populate-express/{src => }/README.md | 12 ++++++------ 3 files changed, 17 insertions(+), 13 deletions(-) rename services/populate-express/{src => }/README.md (75%) diff --git a/services/assemble-express/README.md b/services/assemble-express/README.md index 883127ba..84c03818 100644 --- a/services/assemble-express/README.md +++ b/services/assemble-express/README.md @@ -10,7 +10,7 @@ FORMS_SERVER_URL= FORMS_SERVER_AUTH_TOKEN= ``` -If FORMS_SERVER_URL is left empty, the service will use the request endpoint as the forms server URL. +If ```FORMS_SERVER_URL``` is left empty, the service will use the request endpoint as the forms server URL. i.e. Deploying this service on http://localhost:3001/fhir will result in calls to fetch subquestionnaires on the http://localhost:3001/fhir FHIR API during execution of the $assemble operation. ## Docker Usage @@ -24,6 +24,6 @@ You can supply your `docker run` command environment variables. i.e. Docker image: https://hub.docker.com/r/aehrc/smart-forms-assemble ## Sample implementation -A sample implementation of this service is available at https://smartforms.csiro.au/fhir/Questionnaire/$assemble. +A sample implementation of this service is available at https://smartforms.csiro.au/api/fhir/Questionnaire/$assemble. -Note: The $assemble service on https://smartforms.csiro.au/fhir only performs processing - it does not persist any data. +Note: The $assemble service on https://smartforms.csiro.au/api/fhir only performs processing - it does not persist any data. diff --git a/services/extract-express/README.md b/services/extract-express/README.md index 1c6e7c58..45452def 100644 --- a/services/extract-express/README.md +++ b/services/extract-express/README.md @@ -8,12 +8,12 @@ A proof-of-concept StructureMap $transform is defined on https://proxy.smartform ## Configuration Create a .env file (or copy from example.env) in the root of the project with the following: ```env -EHR_SERVER_URL = -EHR_SERVER_AUTH_TOKEN = +EHR_SERVER_URL= +EHR_SERVER_AUTH_TOKEN= # Change this to wherever your FHIR questionnaires are stored -FORMS_SERVER_URL = https://smartforms.csiro.au/api/fhir -FORMS_SERVER_AUTH_TOKEN = +FORMS_SERVER_URL=https://smartforms.csiro.au/api/fhir +FORMS_SERVER_AUTH_TOKEN= ``` If you are planning to deploy this as a microservice on your EHR server, it is required for your EHR server to have a StructureMap $transform operation defined. @@ -31,5 +31,9 @@ You can use `docker run -p 3003:3003 -e EHR_SERVER_URL=https://proxy.smartforms. Docker image: https://hub.docker.com/r/aehrc/smart-forms-extract +**By default, ```FORMS_SERVER_URL``` is set to https://smartforms.csiro.au/api/fhir in the Docker image.** + ## Sample implementation A sample implementation of this service is available at https://proxy.smartforms.io/fhir/QuestionnaireResponse/$extract. + +Note: The $extract service on https://smartforms.csiro.au/api/fhir only performs processing - it does not persist any data. diff --git a/services/populate-express/src/README.md b/services/populate-express/README.md similarity index 75% rename from services/populate-express/src/README.md rename to services/populate-express/README.md index a7fb8a06..e55bedcd 100644 --- a/services/populate-express/src/README.md +++ b/services/populate-express/README.md @@ -6,14 +6,14 @@ It builds on [@aehrc/sdc-populate](https://www.npmjs.com/package/@aehrc/sdc-popu ## Configuration Create a .env file (or copy from example.env) in the root of the project with the following: ```env -EHR_SERVER_URL = -EHR_SERVER_AUTH_TOKEN = +EHR_SERVER_URL= +EHR_SERVER_AUTH_TOKEN= TERMINOLOGY_SERVER_URL= TERMINOLOGY_SERVER_AUTH_TOKEN= ``` -If EHR_SERVER_URL is left empty, the service will use the request endpoint as the EHR server URL (recommended). +If ```EHR_SERVER_URL``` is left empty, the service will use the request endpoint as the EHR server URL (recommended). i.e. Deploying this service on http://localhost:3001/fhir will result in calls to fetch resources on the http://localhost:3001/fhir FHIR API during execution of the $populate operation. By default, sdc-populate uses https://r4.ontoserver.csiro.au/fhir as the terminology server under the hood. If you want to use a different terminology server, you can set the `TERMINOLOGY_SERVER_URL` and `TERMINOLOGY_SERVER_AUTH_TOKEN` environment variables. @@ -31,9 +31,9 @@ You can supply your `docker run` command environment variables. i.e. Docker image: https://hub.docker.com/r/aehrc/smart-forms-populate ## Sample implementation -A sample implementation of this service is available at https://smartforms.csiro.au/fhir/Questionnaire/$populate. -https://smartforms.csiro.au/fhir only stores Questionnaire definitions and does not contain any clinical data. Therefore when using this sample implementation, contextual information for pre-population should be provided as actual FHIR resources, not references. +A sample implementation of this service is available at https://smartforms.csiro.au/api/fhir/Questionnaire/$populate. +https://smartforms.csiro.au/api/fhir only stores Questionnaire definitions and does not contain any clinical data. Therefore when using this sample implementation, contextual information for pre-population should be provided as actual FHIR resources, not references. This service also allows you to specify a query parameter `debug=true` which returns a base64-encoded FHIRPath context object (useful for debugging!) as the `contextResult-custom` output parameter. -Note: The $populate service on https://smartforms.csiro.au/fhir only performs processing - it does not persist any data. +Note: The $populate service on https://smartforms.csiro.au/api/fhir only performs processing - it does not persist any data.