This subproject contains a SMART on FHIR app, which provides a standardized way to interact with FHIR servers. This Reference Impementation (RI) supports the Documents Templates and Rules (DTR) IG which specifies how payer rules can be executed in a provider context to ensure that documentation requirements are met. This RI and IG are companions to the Coverage Requirements Discovery (CRD) IG and Coverage Requirements Discovery (CRD) RI.
Install node.js.
- Clone the repository
git clone https://github.com/HL7-DaVinci/dtr.git
- In a terminal, navigate to the directory the project was cloned into
- Run
npm install
- To Run:
- dev:
npm start
- production:
npm run startProd
- dev:
The service will run on port 3005. This can be changed in package.json
and the configuration file for the desired version. The dev version is configured with webpack.dev.config.js
and does not use https
by default. The production version is configured through webpack.prod.config.js
and does use https
by default. This can also be changed in the desired config by changing the https
boolean. There is currently no redirection between https
and http
, so using the wrong scheme in the url will result in an empty response.
Once the app is up and running you can launch it manually by visiting the launch page and including the two required parameters:
Param | Description |
---|---|
iss |
The base URL of the FHIR server |
launch |
The unique ID for this launch |
The FHIR server must properly comply with the SMART on FHIR specification and have a conformace statement with a security
section that contains the authorization endpoints that the app needs to request a token from.
For example,
http://localhost:3005/launch?iss=http://launch.smarthealthit.org/v/r2/fhir/&launch=1234 is an example of a valid launch url that will successfully launch the app. However, note that the actual app requires an appContext
parameter that is only available through an EHR launch. The app is not able to work with a standalone launch. If you wish to test the actual DTR app, and not the SMART launch sequence, you will need to either use the EHR/CRD servers provided below or use an actual EHR that supports SMART launch with an appContext
.
It is recommmended when first starting out you have all five applications running (Request Generator, EHR (FHIR) Server, CRD Server, DTR Server, and KeyCloak Server) to test the full SMART on FHIR App launch sequence. After getting these applications up and running you can swap your appliaction if desired.
Note: If you have your own EHR then you should not need to run the EHR (FHIR) Server, KeyCloak and the Request Generator. Otherwise please follow the below steps.
Steps to prepare local EHR server, Keycloak server, and Request Generator:
-
Remove the target folder (if it exists) in the EHR server folder.
-
Start the EHR server.
-
Make sure the EHR server has the data it needs, by running
gradle loadData
to populate it. -
Then, run the KeyCloak server. Follow the guide in the CRD readme if you have never set it up before, make the appropriate realm/client/user.
Note: You might need to modify the frame-ancesters setting in the KeyCloak admin: e.g. Realm | Security Defences | Content-Security-Policy = frame-src 'self'; frame-ancesters http://localhost:*; object-src 'none';
-
Then run the CRD server, DTR server, and Request Generator.
Note: The DTR app's authorization against the EHR server requires a
client_id
that is registered with the auth server of that EHR to work. The DTR app has a/register
endpoint that allows user entry of whichclient_id
to use for a specific EHR server. If following the KeyCloak guide provided in the CRD readme, the client would be calledapp-login
.
Test it!
Assuming you have completed the above. You should be able to send a request from the Request Generator in order for the SMART app to launch by clicking the
Dara
button to pre-populate the inputs. Checkinclude prefetch
and send the request, you should get a CDS Hooks Card back. Click the SMART link and you should see a login screen. Login with whatever user you've registered, and the SMART App should proceed to launch.
Official releases are built automatically, but you may test the process or roll your own similar to the following:
docker build -t hspc/davinci-dtr:latest .
To run dev (https=false, port=3005, proxy=http://localhost:8090):
docker run -it --name davinci-dtr -p 3005:3005 --rm hspc/davinci-dtr:latest
To run production (https=true, port=3005, proxy=https://davinci-crd.logicahealth.org):
docker run -e VERSION='Prod' -it --name davinci-dtr -p 3005:3005 --rm hspc/davinci-dtr:latest
To run configurable template:
docker run -e VERSION='Template' -e PROXY_TARGET='http:\/\/localhost:8090' -e SERVER_PORT='3005' -e SERVER_HTTPS='false' -it --name davinci-dtr -p 3005:3005 --rm hspc/davinci-dtr:latest
The configurable template will use the environment variables passed to the docker run command to replace the PROXY_TARGET
, SERVER_PORT
, and SERVER_HTTPS
values in the webpack configuration file.
This project is licensed under the Apache License 2.0. See LICENSE for more details.