Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
pauljohanneskraft committed Jan 23, 2025
1 parent f2be3bd commit 00401c5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -484,9 +484,9 @@ Diuretics, if currently present as medication request, will be shown as a recomm
|title|LocalizedText|e.g. "Carvedilol"|The name of the medication (not the tablet), e.g. coming from `medications/1998`.|
|subtitle|LocalizedText|e.g. "Beta Blockers"|The medication class name, e.g. coming from `medicationClasses/0`.|
|description|LocalizedText|e.g. "Personal target dose reached. No action required."|The explanation of the recommendation, displayed along with a summary of the medication.|
|type|[Medication Recommendation Type](README.md#Medication-Recommendation-Type)|e.g. "personalTargetDoseReached"|See [Medication Recommendation Type](README.md#Medication-Recommendation-Type) for more information.|
|type|[Medication Recommendation Type](#Medication-Recommendation-Type)|e.g. "personalTargetDoseReached"|See [Medication Recommendation Type](#Medication-Recommendation-Type) for more information.|

Check failure on line 487 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L487

Cannot reach #Medication-Recommendation-Type. Status: 404 Cannot find section: #Medication-Recommendation-Type in file: README.md.
Raw output
message:"Cannot reach #Medication-Recommendation-Type. Status: 404 Cannot find section: #Medication-Recommendation-Type in file: README.md." location:{path:"README.md" range:{start:{line:487 column:7} end:{line:487 column:72}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

Check failure on line 487 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L487

Cannot reach #Medication-Recommendation-Type. Status: 404 Cannot find section: #Medication-Recommendation-Type in file: README.md.
Raw output
message:"Cannot reach #Medication-Recommendation-Type. Status: 404 Cannot find section: #Medication-Recommendation-Type in file: README.md." location:{path:"README.md" range:{start:{line:487 column:110} end:{line:487 column:175}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
|videoPath|optional string|e.g. `videoSections/1/videos/3`|This is the video to show when the recommendation is tapped. The clients may want to hide the icon to get to the video when this value is not present.|
|dosageInformation|DosageInformation|See [Dosage Information](README.md#Dosage-Information)|A description of the current, minimum, and target doses for a given medication.
|dosageInformation|DosageInformation|See [Dosage Information](#Dosage-Information)|A description of the current, minimum, and target doses for a given medication.

Check failure on line 489 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L489

Cannot reach #Dosage-Information. Status: 404 Cannot find section: #Dosage-Information in file: README.md.
Raw output
message:"Cannot reach #Dosage-Information. Status: 404 Cannot find section: #Dosage-Information in file: README.md." location:{path:"README.md" range:{start:{line:489 column:42} end:{line:489 column:83}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
When the patient is not yet taking the medication, its currentSchedule will be an empty list.|

The `DosageInformation` property contains the following information:
Expand Down Expand Up @@ -698,7 +698,7 @@ An admin may create invitations for any user, an owner or clinician may only cre
|auth>email|optional string|-|An email address to use for the user. This is non-optional for invitations for owners and clinicians, since this email address is used as the invitation code for SSO.|
|auth>phoneNumber|optional string|-|A phone number to use for the user.|
|auth>photoURL|optional string|-|A photo URL to use for the user.|
|user|object|-|A prepared user object to use for the enrollment of the user when using the invitation. It may contain the same properties as in the [`users`](README.md#%2F%0Ausers%2F%24userId%24%0A) collection, except for `dateOfEnrollment` and `invitationCode`.|
|user|object|-|A prepared user object to use for the enrollment of the user when using the invitation. It may contain the same properties as in the [`users`](#%2F%0Ausers%2F%24userId%24%0A) collection, except for `dateOfEnrollment` and `invitationCode`.|

Check failure on line 701 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L701

Cannot reach #%2F%0Ausers%2F%24userId%24%0A. Status: 404 Cannot find section: #%2F%0Ausers%2F%24userId%24%0A in file: README.md.
Raw output
message:"Cannot reach #%2F%0Ausers%2F%24userId%24%0A. Status: 404 Cannot find section: #%2F%0Ausers%2F%24userId%24%0A in file: README.md." location:{path:"README.md" range:{start:{line:701 column:149} end:{line:701 column:190}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

#### Output

Expand Down Expand Up @@ -746,7 +746,7 @@ This function may only be called by admins. On emulators, this function can easi
|date|string|-|An ISO 8601 formatted string of the date to seed data relative to. May be omitted, which will generate data relative to now.|
|only|list of string|e.g. ["users","invitations"]|Allows to limit seeding data to the provided collections.|
|onlyUserCollections|list of string|e.g. ["appointments","bodyWeightObservations"]|Allows to limit the creation of user collections for the created users to the provided collections.|
|staticData|object|-|Allows to seed static data without calling [`updateStaticData`](README.md#updatestaticdata) separately. If not provided, static data will not be updated.|
|staticData|object|-|Allows to seed static data without calling [`updateStaticData`](#updatestaticdata) separately. If not provided, static data will not be updated.|
|userData|list of object|-|Allows to seed user collections to existing users.|
|userData[x]>userId|string|-|The userId for the user to create seeding data for.|
|userData[x]>only|list of string|-|The user collections to create seeding data for. If not provided, all available collections will be seeded.|
Expand Down Expand Up @@ -806,7 +806,7 @@ This function may be called by admins (for any patient), owners/clinicians (for
|Property|Type|Values|Comments|
|-|-|-|-|
|userId|string|-|The patient's user id. Needs to be specified, even if a patient is requesting the health summary for themselves.|
|language|optional string|e.g. 'en-US'|See [`LocalizedText`](README.md#LocalizedText) for specification.|
|language|optional string|e.g. 'en-US'|See [`LocalizedText`](#LocalizedText) for specification.|

Check failure on line 809 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L809

Cannot reach #LocalizedText. Status: 404 Cannot find section: #LocalizedText in file: README.md.
Raw output
message:"Cannot reach #LocalizedText. Status: 404 Cannot find section: #LocalizedText in file: README.md." location:{path:"README.md" range:{start:{line:809 column:44} end:{line:809 column:77}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
|weightUnit|optional string|e.g. '[lb_av]'|A loinc code for the weight unit to be used during generation of the health summary PDF|

#### Output
Expand Down Expand Up @@ -834,7 +834,7 @@ If a notification token could not be generated on the device (e.g. due to missin
|osVersion|optional string|'15.4.3'|The OS version of the device using semantic versioning separated by dots. Minor and patch version may be omitted.|
|appVersion|optional string|'1.0.1'|The app version as shown in the App Store or Play Store using semantic versioning. Minor and patch version may be omitted.|
|appBuild|optional string|'43'|The app build version as used internally to identify individual builds within the same marketing version (i.e. the one shown in App Store / Play Store).|
|language|optional string|'en-US'|The language and region setting as specified for [`LocalizedText`](README.md#LocalizedText).|
|language|optional string|'en-US'|The language and region setting as specified for [`LocalizedText`](#LocalizedText).|

Check failure on line 837 in README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] README.md#L837

Cannot reach #LocalizedText. Status: 404 Cannot find section: #LocalizedText in file: README.md.
Raw output
message:"Cannot reach #LocalizedText. Status: 404 Cannot find section: #LocalizedText in file: README.md." location:{path:"README.md" range:{start:{line:837 column:84} end:{line:837 column:117}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
|timeZone|optional string|e.g. "America/Los_Angeles"|The value needs to correspond to an identifier from [TZDB](https://nodatime.org/TimeZones). It must not be an offset to UTC/GMT, since that wouldn't work well with daylight-savings (even if there is no daylight-savings time at that location). Also, don't use common abbreviations like PST, PDT, CEST, etc (they may be ambiguous, e.g. CST). If the timeZone is unknown, then "America/Los_Angeles" should be used.|

#### Output
Expand Down

0 comments on commit 00401c5

Please sign in to comment.