-
Notifications
You must be signed in to change notification settings - Fork 35
Adds documentation for update_patient transition. #213
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One minor change / clearup, but nothing that would stop you from merging!
configuration/transitions.md
Outdated
|
||
### update_patient | ||
|
||
Updates a `data_record` to set its patient to its sender, the resulting doc will have `fields.patient_uuid` and `fields.patient_id` filled with the sender's information. Provides hydrated patient information to subsequent transitions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updates a `data_record` to set its patient to its sender, the resulting doc will have `fields.patient_uuid` and `fields.patient_id` filled with the sender's information. Provides hydrated patient information to subsequent transitions. | |
Updates a `data_record` to set its patient to its sender. The resulting doc will have `fields.patient_uuid` and `fields.patient_id` filled with the sender's information. Provides hydrated patient information to subsequent transitions. |
You somewhat explain it the next paragraph, but consider explicitly stating that "sender" is the person who is attached to the phone number the original SMS was sent from.
The transition name |
@abbyad I like |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! One slight re-wording to consider, but it could really just be in my head
configuration/transitions.md
Outdated
|
||
Updates a `data_record` to set its patient to its sender. The resulting doc will have `fields.patient_uuid` and `fields.patient_id` filled with the sender's information. Provides hydrated patient information to subsequent transitions. | ||
The `sender` is the contact associated with the phone number that sent the original SMS. | ||
If a doc already contains a `patient` field, does not have a sender or does not have a configured `form` field, it will be ignored by this transition. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider:
If a doc already contains a `patient` field, does not have a sender or does not have a configured `form` field, it will be ignored by this transition. | |
If a doc already contains a `patient` field, does not have a sender or whose `form` is not configured to be enabled for this transition, it will be ignored. |
When I read my first thought was that you meant a form field that is any configured form (like for the entire application).
medic/cht-core#6286