Patient Management Catalog Events

List of Catalogs

Catalog	Description
HCW Catalog	Catalog representing values for Healthcare Worker.
Patient Catalog	Catalog representing values for Patient.

---

"Required Catalog Fields"

Some catalog fields can be marked as optional below but may be required for your app. Please refer to your integration notes to verify which fields are required for your use-case.

HCW Catalog

Below are the Healthcare Worker (HCW) Catalog values.

Format

Param	Usability	Format	Description
name	OPTIONAL	STRING	Name of the hcw, provided by the partner.
role	OPTIONAL	STRING	Role assigned to the hcw.
site_id_list	OPTIONAL	ARRAY (STRING)	Id for the sites assigned to the hcw
supervisor_id_list	OPTIONAL	ARRAY (STRING)	Ids of the hcw supervisors attached to the hce profile.

Usage

Android (Java/Kotlin)

     val hcwCatalogModel = HcwCatalogModel(
        name = "John Doe",
        role = "Provider",
        siteIdList = listOf("item1", "item1")
    )

    CFPatientMgmtEvent.logCatalog(
        patientMgmtCatalogType = PatientMgmtCatalogSubject.UserHcw,
        Common.testUserId,
        catalogModel = hcwCatalogModel
    )

iOS (Swift)

     let hcwCatalogModel = HcwCatalogModel (
        role: "Nutritionist",
        name: "John Doe",
        siteIdList: ["site1", "site2"],
        supervisorIdList:["11", "22", "33"]
     )
    CFPatientMgmtEvent.shared.logCatalog(patientMgmtCatalogType: PatientMgmtCatalogType.UserHcw, subjectId: "RandomHCCWWWID1", catalogModel: hcwCatalogModel)
        

React Native (JS/TS)

    const hcwCatalogModel = {
      name: 'name',
      role: 'role',
      site_id_list: ['site_id_list'],
      supervisor_id_list: ['supervisor_id_list'],
    } as HcwCatalog;

    CFPatientMgmt.logCatalogEvent(
      'useCFPatientMgmtCatalogEventsID1',
      PatientMgmtCatalogType.HcwUser,
      hcwCatalogModel,
    );

Web Application (JS/TS)

    let hcwCatalogModel = {
        name: "John Doe",
        role: "Nutritionist",
        site_id_list: ["site1", "site2"],
        supervisor_id_list: ["value1", "value2"],
    };

    PatientMgmt.logCatalogEvent("JohnHCWTEST", PatientMgmtCatalogType.UserHcw, hcwCatalogModel);

JSON

 "data": [
   {
      "id":"UserDoeTEST4",
      "kv":{
         "hello":"world",
         "name":"John Doe",
         "role":"Provider",
         "site_id_list":"item1, item1"
      },
      "type":"user_chw"
   }
 ]

---

Patient Catalog

Below are the Patient Catalog values.

Format

Param	Usability	Format	Description
country	OPTIONAL	STRING	Country in which the patient is at.
region_state	OPTIONAL	STRING	Region or State in which the patient is at.
city	OPTIONAL	STRING	City in which the patient is at.
profession	OPTIONAL	STRING	Profession in which the patient is at.
education_level	OPTIONAL	STRING	Education_level of the patient.
site_id_list	OPTIONAL	ARRAY (STRING)	Sites list that are visited by the patient.
insurance_id	OPTIONAL	STRING	Insurance Id of the patient.
insurance_type	OPTIONAL	STRING	Insurance Type of the patient.
insurance_status	OPTIONAL	BOOLEAN	If the insurance is active for the patient.
landmark	OPTIONAL	STRING	Any landmark nearby patient.
phone_number_category	OPTIONAL	STRING	Phone number category of the patient.
program_id	OPTIONAL	STRING	Id for the program the patient is enrolled in.
family_id	OPTIONAL	STRING	Id for the family the patient is enrolled in.
hw_id_list	OPTIONAL	ARRAY (STRING)	Hcw Id list assigned to the patient.
buddy_id_list	OPTIONAL	ARRAY (STRING)	Id for the buddies (other patients on the program) the patient is enrolled in.
transport_mode	OPTIONAL	STRING	Transport mode used by the patient.
marital_status	OPTIONAL	STRING	Marital Status of the patient.
employment_status	OPTIONAL	STRING	Employment Status of the patient.
nationality	OPTIONAL	STRING	Nationality of the patient.
has_whatsapp	OPTIONAL	BOOLEAN	If the Patient has provided their whatsapp number in the program.
has_email	OPTIONAL	BOOLEAN	If the Patient has provided their email in the program.

Usage

Android (Java/Kotlin)

     val patientCatalog = PatientCatalogModel(
        country = CountryCode.Spain.toString(),
        regionState = "Barcelona",
        city = "Barcelona",
        profession = "HCW",
        educationLevel = EducationalLevel.Bachelors.toString(),
        siteIdList = listOf("item1", "item1"),
        insuranceId = null,
        insuranceType = null,
        insuranceStatus = null,
        landmark = "Some landmark",
        phoneNumberCategory = null,
        programId = "some Program Id"
    )

    CFPatientMgmtEvent.logCatalog(
        patientMgmtCatalogType = PatientMgmtCatalogSubject.Patient,
        "samplePatientId",
        catalogModel = patientCatalog
    )

iOS (Swift)

     let patientCatalog = PatientCatalogModel(
        country: CountryCode.Andorra.rawValue,
        regionState: "Barcelona",
        city: "Barcelona",
        profession: "HCW",
        educationLevel: EducationalLevel.Bachelors.rawValue,
        siteIdList: ["site1", "site2"],
        insuranceId: "",
        insuranceType: "",
        insuranceStatus:false,
        programId: "some Program Id")
    
    CFPatientMgmtEvent.shared.logCatalog(patientMgmtCatalogType: PatientMgmtCatalogType.Patient, subjectId: "RandomPatientId2", catalogModel: patientCatalog)

React Native (JS/TS)

     const patientCatalog = {
      country: Country.Argentina,
      region_state: 'region_state',
      city: 'city',
      profession: 'profession',
      education_level: 'education_level',
      site_id_list: ['site_id_list'],
      insurance_id: 'insurance_id',
      insurance_type: 'insurance_type',
      insurance_status: false,
      landmark: 'landmark',
      phone_number_category: 'phone_number_category',
      program_id: 'program_id',
      family_id: 'family_id',
      hw_id_list: ['hw_id_list'],
      buddy_id_list: ['buddy_id_list'],
      transport_mode: 'transport_mode',
      marital_status: 'marital_status',
      employment_status: 'employment_status',
      nationality: 'nationality',
      has_whatsapp: false,
      has_email: false,
    } as PatientCatalog;

    CFPatientMgmt.logCatalogEvent(
      'useCFPatientMgmtCatalogEventsID1',
      PatientMgmtCatalogType.Patient,
      patientCatalog,
    );

Web Application (JS/TS)

    let patientCatalogModel = {
        country: Country.Albania,
        region_state: "Barcelona",
        city: "Barcelona",
        profession: "HCW",
        education_level: EducationalLevel.Bachelors,
        site_id_list: ["site1", "site2"],
        insurance_id: "",
        insurance_type: "",
        insurance_status: false,
        landmark: "Some landmark",
        phone_number_category: "",
        program_id: "some Program Id",
        family_id: "",
        hw_id_list: [],
        buddy_id_list: [],
        transport_mode: "",
        marital_status: "",
        employment_status: "",
        nationality: "",
        has_whatsapp: false,
        has_email: false,
    };
    PatientMgmt.logCatalogEvent("JohnPatientTEST", PatientMgmtCatalogType.Patient, patientCatalogModel);

JSON

"data": [
  {
     "id":"samplePatientId",
     "kv":{
        "city":"Barcelona",
        "country":"Spain",
        "education_level":"bachelors",
        "landmark":"Some landmark",
        "hello":"world",
        "profession":"HCW",
        "program_id":"some Program Id",
        "region_state":"Barcelona",
        "site_id_list":"item1, item1"
     },
     "type":"patient"
  }
]

---