parth-io/ped

Locating patients by nok is confusing and should be re-worded to emphasise that we are locating nok data

Opened this issue · 0 comments

The user guide states that to retrieve the next-of-kin data for a patient, you can use the get /nok PATIENT_NAME command. However, the behaviour of the command is inconsistent with what is implied by the formatting/structure of the user guide. The /nok prefix is under Locating patients, as shown here:

Locating patients: get

by next-of-kin data: /nok

The implication of this in the UG is that you can locate patients by searching for their next-of-kin data.

But the command locates next-of-kin data by searching for a patient's name.

The object of our search is different, and confusing to those reading the User Guide. This command can be moved out to a separate section, which can be labelled like this:

Getting next-of-kin data