Skip to content

Add comprehensive setup and service account documentation #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add comprehensive setup and service account documentation #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67e6d6d
Initial plan
Copilot Oct 3, 2025
ce541a4
Add comprehensive setup and service account documentation
Copilot Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@

Firebase cloud hosting infrastructure for the ENGAGE-HF project.

## Getting Started

**New to ENGAGE-HF?** Start with our comprehensive [Setup Guide](SETUP.md) for step-by-step instructions on:
- Firebase project configuration
- Service account setup and IAM permissions
- Initial deployment
- Onboarding your first clinicians and patients

## Behavior

The base functionality of the ENGAGE-HF Firebase Functions revolve around three parts:
Expand Down Expand Up @@ -538,8 +546,8 @@

|code>system|code>code|code>display|value>system|value>value|value>code|value>unit|
|-|-|-|-|-|-|-|
|"http://loinc.org"|"8462-4"|"Diastolic blood pressure"|"http://unitsofmeasure.org"|double|"mm[Hg]"|"mmHg"|

Check failure on line 549 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L549 

Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org
Raw output 
message:"Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org" location:{path:"README.md" range:{start:{line:549 column:58} end:{line:549 column:83}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
|"http://loinc.org"|"8480-6"|"Systolic blood pressure"|"http://unitsofmeasure.org"|double|"mm[Hg]"|"mmHg"|

Check failure on line 550 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L550 

Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org
Raw output 
message:"Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org" location:{path:"README.md" range:{start:{line:550 column:57} end:{line:550 column:82}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

#### users/$userId$/bodyWeightObservations/$observationId$

Expand All @@ -547,7 +555,7 @@

|code>system|code>code|code>display|value>system|value>value|value>code|value>unit|
|-|-|-|-|-|-|-|
|"http://loinc.org"|"29463-7"|"Body weight"|double|"http://unitsofmeasure.org"|"kg" or "[lb_av]"|"kg" or "lbs"|

Check failure on line 558 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L558 

Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org
Raw output 
message:"Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org" location:{path:"README.md" range:{start:{line:558 column:53} end:{line:558 column:78}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

#### users/$userId$/creatinineObservations/$observationId$

Expand All @@ -555,7 +563,7 @@

|code>system|code>code|code>display|value>system|value>value|value>code|value>unit|
|-|-|-|-|-|-|-|
|"http://loinc.org"|"2160-0"|"Creatinine [Mass/volume] in Serum or Plasma"|double|"http://unitsofmeasure.org"|"mg/dL"|"mg/dL"|

Check failure on line 566 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L566 

Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org
Raw output 
message:"Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org" location:{path:"README.md" range:{start:{line:566 column:84} end:{line:566 column:109}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

#### users/$userId$/dryBodyWeightObservations/$observationId$

Expand All @@ -563,7 +571,7 @@

|code>system|code>code|code>display|value>system|value>value|value>code|value>unit|
|-|-|-|-|-|-|-|
|"http://loinc.org"|"29463-7"|"Body weight"|double|"http://unitsofmeasure.org"|"kg"|"kg"|

Check failure on line 574 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L574 

Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org
Raw output 
message:"Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org" location:{path:"README.md" range:{start:{line:574 column:53} end:{line:574 column:78}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

#### users/$userId$/eGfrObservations/$observationId$

Expand All @@ -571,7 +579,7 @@

|code>system|code>code|code>display|value>system|value>value|value>code|value>unit|
|-|-|-|-|-|-|-|
|"http://loinc.org"|"98979-8"|"Glomerular filtration rate/1.73 sq M.predicted [Volume Rate/Area] in Serum, Plasma or Blood by Creatinine-based formula (CKD-EPI 2021)"|double|"http://unitsofmeasure.org"|"mL/min/{1.73_m2}"|"mL/min/1.73_m2"|

Check failure on line 582 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L582 

Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org
Raw output 
message:"Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org" location:{path:"README.md" range:{start:{line:582 column:176} end:{line:582 column:201}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

#### users/$userId$/heartRateObservations/$observationId$

Expand All @@ -579,7 +587,7 @@

|code>system|code>code|code>display|value>system|value>value|value>code|value>unit|
|-|-|-|-|-|-|-|
|"http://loinc.org"|"8867-4"|"Heart rate"|double|"http://unitsofmeasure.org"|"/min"|"beats/minute"|

Check failure on line 590 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L590 

Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org
Raw output 
message:"Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org" location:{path:"README.md" range:{start:{line:590 column:51} end:{line:590 column:76}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

#### users/$userId$/potassiumObservations/$observationId$

Expand All @@ -587,7 +595,7 @@

|code>system|code>code|code>display|value>system|value>value|value>code|value>unit|
|-|-|-|-|-|-|-|
|"http://loinc.org"|"6298-4"|"Potassium [Moles/volume] in Blood"|double|"http://unitsofmeasure.org"|"meq/L"|"mEq/L"|

Check failure on line 598 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L598 

Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org
Raw output 
message:"Cannot reach http://unitsofmeasure.org Status: null net::ERR_BLOCKED_BY_CLIENT at http://unitsofmeasure.org" location:{path:"README.md" range:{start:{line:598 column:74} end:{line:598 column:99}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

#### users/$userId$/messages/$messageId$

Expand Down
Loading
Loading