Skip to content

Commit

Permalink
Ingestion arc diagram (#2346)
Browse files Browse the repository at this point in the history
* Ingestion arc diagram

* [pre-commit.ci] auto fixes from pre-commit hooks

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
KennethSkylight and pre-commit-ci[bot] authored Sep 16, 2024
1 parent b3217ff commit 9884bed
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions containers/ingestion/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,56 @@ To build the Docker image for the Ingestion service from source code instead of
### The API

When viewing these docs from the `/redoc` endpoint on a running instance of the ingestion service or the PHDI website, detailed documentation on the API will be available below.

## Diagrams

###

```mermaid
flowchart LR
subgraph requests["Requests"]
direction TB
subgraph GET["fas:fa-download <code>GET</code>"]
hc["<code>/</code>\n(health check)"]
end
subgraph POST-standardization["fas:fa-upload <code>POST Standardization</code>"]
ecr["<code>/fhir/harmonization/<br>standardization/standardize_names<//code>"]
phones["<code>/fhir/harmonization/<br>standardization/standardize_phones<//code>"]
dob["<code>/fhir/harmonization/<br>standardization/standardize_dob<//code>"]
end
subgraph POST-geospatial["fas:fa-upload <code>POST Geospatial</code>"]
geo["<code>/fhir/geospatial/geocode/geocode_bundle<//code>"]
end
subgraph POST-linkage["fas:fa-upload <code>POST Linkage</code>"]
link["<code>/fhir/linkage/link/add_patient_identifier_in_bundle<//code>"]
end
end
subgraph service[REST API Service]
direction TB
subgraph mr["fab:fa-docker container"]
viewer["fab:fa-python <code>ingestion<br>HTTP:3000/</code>"]
end
subgraph smarty["fab:fa-docker smarty"]
smarty-api["fab:fa-python <code>Smarty API</code>"]
end
mr <--> |<br><code>GET /geocodeAddress</code>| smarty
end
subgraph response["Responses"]
subgraph JSON["fa:fa-file-alt <code>JSON</code>"]
rsp-hc["fa:fa-file-code <code>OK</code> fa:fa-thumbs-up"]
fhirdata["fa:fa-file-code FHIR Data"]
post-ecr["200"]
end
end
hc -.-> mr -.-> rsp-hc
POST-standardization ===> mr ===> post-ecr
POST-linkage ==> mr ===> post-ecr
POST-geospatial --> mr ---> post-ecr
```

0 comments on commit 9884bed

Please sign in to comment.