Added docs for Activity flow #2735
Conversation
aditya-07
force-pushed
the
ak/workflow-md
branch
from
509eb8c
to
ecbd1dd
Compare
| @@ -22,6 +22,7 @@ Future features of the library will provide support for Tasking and other Workfl | |||
| * [Evaluate a Measure](Evaluate-a-Measure.md) | |||
| * [Evaluate a Library](Evaluate-a-Library.md) | |||
| * [Compile CQL](Compile-and-Execute-CQL.md) | |||
| * [Run an Activity Flow](Run-an-Activity-Flow.md) | |||
There was a problem hiding this comment.
i would put this after generate care plan, and before evaluate measure.
actually maybe separate this list into 2. one list includes care plan generation, activity flow, and measure - and we can call it workflow guides.... and another list including the other two, maybe call it "other operations" or soemthign similar?
There was a problem hiding this comment.
add a short paragraph on top of this page in the right order to describe this step in between generation of care plan and the measure evaluation.
There was a problem hiding this comment.
can we have a simple diagram to explain the phases. no need to discuss the intents of the phases (we're trying to hide those things from developers) but just the phases and transitions.
but also - add something about the fact that this api makes it easy for you to implement the activity flow - because we manage the resources, and manage the intents and statuses to make sure they are compliant with the cpg ig.
| val planPhase = flow.initiatePlan(preparedPlan).getOrThrow( ) | ||
| ``` | ||
|
|
||
| ## Transitioning to Perform Phase |
There was a problem hiding this comment.
say that perform is a special phase that needs an event
| * **`RequestPhase`:** (`ProposalPhase`, `PlanPhase`, `OrderPhase`) allows updating the request state using `update()`. | ||
| * **`EventPhase`:** (`PerformPhase`) allows updating the event state using `update()` and completing the phase using `complete()`. | ||
|
|
||
| ## Factory Functions |
There was a problem hiding this comment.
have a section called api list, and list the factory functions and other functions - or, if these are covered and clear enough from previous sections, we don't ahve to have this separate list.
or maybe these can be part of the diagram if you can squeeze them in.
IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).
Fixes #[issue number]
Description
Clear and concise code change description.
Alternative(s) considered
Have you considered any alternatives? And if so, why have you chosen the approach in this PR?
Type
Choose one: (Bug fix | Feature | Documentation | Testing | Code health | Builds | Releases | Other)
Screenshots (if applicable)
Checklist
./gradlew spotlessApplyand./gradlew spotlessCheckto check my code follows the style guide of this project../gradlew checkand./gradlew connectedCheckto test my changes locally.