Skip to content

Commit

Permalink
Readme additions
Browse files Browse the repository at this point in the history
  • Loading branch information
elsaperelli committed Apr 10, 2024
1 parent 6e5d7d7 commit d7ed993
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
Clone the source code:

```bash
git clone https://github.com/projecttacoma/deqm-test-server.git
git clone https://github.com/projecttacoma/bulk-export-server.git
```

Install dependencies:
Expand Down Expand Up @@ -77,7 +77,7 @@ You should receive the output `PONG`.

### Docker

This test server can be run with Docker by calling `docker-compose up --build`.
This test server can be run with Docker by calling `docker compose up --build`.
Debugging with terminal input can be facilitated with `stdin_open: true` and `tty: true` added to the service specification for the service you want to debug. You can then attach to the image of interest using `docker attach <imagename>`. If you're unsure of the image name, use `docker ps` to find the image of interest.

## Usage
Expand All @@ -93,7 +93,7 @@ The following `npm` commands can be used to set up the database:
- `npm run db:setup` creates collections for all the valid FHIR resource types
- `npm run db:delete` deletes all existing collections in the database
- `npm run db:reset` runs both of the above, deleting all current collections and then creating new, empty collections
- To upload all the ecqm-content-r4-2021 measure bundles, `git clone` the [ecqm-content-r4-2021 repo](https://github.com/cqframework/ecqm-content-r4-2021) into the root directory of the `deqm-test-server` repository. Run `npm run upload-bundles`. This runs a script that uploads all the measure bundle resources to the appropriate Mongo collections.
- To upload all the ecqm-content-r4-2021 measure bundles, `git clone` the [ecqm-content-r4-2021 repo](https://github.com/cqframework/ecqm-content-r4-2021) into the root directory of the `bulk-export-server` repository. Run `npm run upload-bundles`. This runs a script that uploads all the measure bundle resources to the appropriate Mongo collections.
- The full CLI function signature of `upload-bundles` script is `npm run upload-bundles [dirPath] [searchPattern]`. The command can be run more dynamically by specifying a `dirPath` string which represents the path to a repository that contains the desired bundles for upload. `searchPattern` is a string which is used as a regex to filter bundle files for upload by file name. Example: `npm run upload-bundles connectathon/fhir401/bundles/measure "^EXM124.*-bundle.json"`

## Server Endpoints
Expand Down Expand Up @@ -127,7 +127,9 @@ Alternatively, a POST request (`POST [fhir base]/$export`) can be sent. The expo
For more information on the export endpoints, read this documentation on the [Export Request Flow](https://hl7.org/fhir/uv/bulkdata/export/index.html#request-flow).

## Supported Query Parameters

The server supports the following query parameters:

- `_type`: Filters the response to only include resources of the specified resource type(s)
- If omitted, system-level requests will return all resources supported by the server within the scope of the client authorization
- For Patient- and Group-level requests, the [Patient Compartment](https://www.hl7.org/fhir/compartmentdefinition-patient.html) is used as a point of reference for filtering the resource types that are returned.
Expand Down

0 comments on commit d7ed993

Please sign in to comment.