Create a Generic Search filter for Identifiers and Attributes for Resources (Patient, Groups and Related artifacts)

[f-odhiambo]

Create a Generic Search filter for Identifiers and Attributes for Resources (Patient, Groups and Related artefacts)

Patient

1. ID
2. Identifier(s) - Primary, Secondary, Others
3. GIven name
4. Family name
5. Middle name (if provided)

Group

1. ID
2. Identifier(s) - Primary, Secondary, Others
3. Name

Related Discussions

1. When do we need to use the Patient ID and when do we use a Patient Identifier ? #482
2. Generation of Unique Human readable IDs #872

[f-odhiambo]

Key questions

1. If a patient/group has multiple identifiers how do we go about filtering based on a match for the given params to query?
2. Will this be an expensive query and have a performance hit?

[dubdabasoduba]

From the configurability pieces, we can define what the search bar will such through. These are rules to fetch the different attributes we want to search by. e.g For the task register, we would want to search by the Patient, Practitioner name & Task Description.

Search bar configuration

"searchBar": {
		"visible": true,
		"display": "Search by Task, Practitioner & Patient Name",
		"computedRules": [
			"taskName", "practitionerName", "patientName"
		]
	}

Search bar computed rules

  {
    "name": "patientName",
    "condition": "true",
    "actions": [
      "data.put('patientName', fhirPath.extractValue(Patient.get(0), \"Patient.name.select(given + ' ' + family)\"))"
    ]
  },
  {
    "name": "practitionerName",
    "condition": "true",
    "actions": [
      "data.put('practitionerName', fhirPath.extractValue(Practitioner.get(0), \"Practitioner.name.select(given + ' ' + family)\"))"
    ]
  },
  {
    "name": "taskName",
    "condition": "true",
    "actions": [
      "data.put('taskName', fhirPath.extractValue(Task, 'Task.description'))"
    ]
  }

Here is the tasking configuration file https://github.com/opensrp/fhir-resources/blob/main/ecbis/app_configurations/ecbis_tasking/registers/task_register_config.json

We can add the human-readable identifier search in the same way. e.g search a family using it's family Id

Search bar configuration

  "searchBar": {
    "visible": true,
    "display": "Search name or ID",
    "computedRules": [
      "familyName","familyId"
    ]
  },

Search bar computed rules

 {
  "name": "familyId",
  "condition": "true",
  "actions": [
    "data.put('familyId', fhirPath.extractValue(Group, 'Group.identifier[0].value'))"
  ]
}

Here is a sample of the configuration https://github.com/opensrp/fhircore/blob/update_sample_configs/android/quest/src/main/assets/configs/app/registers/household_register_config.json

[pld]

thanks @dubdabasoduba, it sounds like that handles this? We need to create documentation around the configurable registers that includes info like this, but that's a separate task

[dubdabasoduba]

Agreed! Will create an issue for the overall config work