feat(case): add followup schema

Author: lykmapipo

src/case.model.js

@@ -16,7 +16,7 @@ import {
 } from './internals';
 
 import { number, description, remarks } from './schema/base.schema';
-import { victim } from './schema/common.schema';
+import { victim, followup } from './schema/common.schema';
 import { reporter, resolver } from './schema/parties.schema';
 import { reportedAt, resolvedAt } from './schema/dates.schema';
 
@@ -26,6 +26,7 @@ const SCHEMA = mergeObjects(
   { description },
   { reportedAt, reporter },
   { resolvedAt, resolver },
+  { followup },
   { remarks }
 );
 

src/schema/base.schema.js

@@ -263,3 +263,36 @@ export const remarks = {
     type: 'sentence',
   },
 };
+
+/**
+ * @name outcome
+ * @description An outcome of about a case followup.
+ *
+ * @memberof Case
+ *
+ * @type {object}
+ * @property {object} type - schema(data) type
+ * @property {boolean} trim - force trimming
+ * @property {boolean} index - ensure database index
+ * @property {boolean} searchable - allow for searching
+ * @property {boolean} exportable - allow field use for exporting
+ * @property {object} fake - fake data generator options
+ *
+ * @author lally elias <lallyelias87@gmail.com>
+ * @since 0.1.0
+ * @version 0.1.0
+ * @instance
+ * @example
+ * Home
+ */
+export const outcome = {
+  type: String,
+  trim: true,
+  index: true,
+  searchable: true,
+  exportable: true,
+  fake: {
+    generator: 'lorem',
+    type: 'sentence',
+  },
+};

src/schema/common.schema.js

@@ -7,14 +7,44 @@ import {
 import { DEFAULT_SEEDS } from '@codetanzania/ewea-common';
 import { compact } from '@lykmapipo/common';
 import { Point } from 'mongoose-geojson-schemas';
-import { ObjectId, createSubSchema } from '@lykmapipo/mongoose-common';
+import { ObjectId, Mixed, createSubSchema } from '@lykmapipo/mongoose-common';
 import { Predefine } from '@lykmapipo/predefine';
 
 import {
   AUTOPOPULATE_OPTION_PREDEFINE,
   AUTOPOPULATE_OPTION_AREA,
 } from '../internals';
 
+import { follower } from './parties.schema';
+import { followedAt } from './dates.schema';
+import { outcome, remarks } from './base.schema';
+
+/**
+ * @name properties
+ * @description A map of key value pairs to allow to associate
+ * other meaningful information to a case.
+ *
+ * @type {object}
+ * @property {object} type - schema(data) type
+ * @property {object} fake - fake data generator options
+ *
+ * @since 0.2.0
+ * @version 0.1.0
+ * @instance
+ * @example
+ * {
+ *   "population": {
+ *     "male": 1700000,
+ *     "female": 2700000
+ *    }
+ * }
+ */
+export const properties = {
+  type: Map,
+  of: Mixed,
+  fake: (f) => f.helpers.createTransaction(),
+};
+
 /**
  * @name name
  * @description Full name name of the party(i.e individual).
@@ -521,3 +551,40 @@ export const victim = createSubSchema({
   area,
   nextOfKin,
 });
+
+/**
+ * @name victim
+ * @description A party(i.e patient or victim) whom a case is for.
+ *
+ * @type {object}
+ * @property {string} referral - Valid referral number
+ * @property {string} pcr - Valid patient care number
+ * @property {string} name - Full name of the victim
+ * @property {string} mobile - Mobile phone number of the victim
+ * @property {object} gender - Gender of the victim
+ * @property {number} age - Age of the victim
+ * @property {number} weight - Weight of the victim
+ * @property {object} occupation - Occupation of the victim
+ * @property {object} nationality - Nationality of the victim
+ * @property {string} address - Address of the victim
+ *
+ * @author lally elias <lallyelias87@gmail.com>
+ * @since 0.1.0
+ * @version 0.2.0
+ * @instance
+ * @example
+ * {
+ *   follower: {_id: "5bcda2c073dd0700048fb846", name: "Jane Doe" }
+ *   followedAt: '2018-10-19T07:55:32.831Z',
+ *   symptoms: { cough: 5 },
+ *   outcome: 'Hospital',
+ *   remarks: 'Handled'
+ * }
+ */
+export const followup = createSubSchema({
+  follower,
+  followedAt,
+  symptoms: properties,
+  outcome,
+  remarks,
+});

src/schema/dates.schema.js

@@ -55,3 +55,31 @@ export const resolvedAt = {
     type: 'recent',
   },
 };
+
+/**
+ * @name followedAt
+ * @description Latest date when a case followed up after discharged.
+ *
+ * @memberof Case
+ *
+ * @type {object}
+ * @property {object} type - schema(data) type
+ * @property {boolean} index - ensure database index
+ * @property {object} fake - fake data generator options
+ *
+ * @author lally elias <lallyelias87@gmail.com>
+ * @since 0.3.0
+ * @version 0.1.0
+ * @instance
+ * @example
+ * 2018-10-19T07:55:32.831Z
+ */
+export const followedAt = {
+  type: Date,
+  index: true,
+  exportable: true,
+  fake: {
+    generator: 'date',
+    type: 'recent',
+  },
+};

src/schema/parties.schema.js

@@ -97,3 +97,50 @@ export const resolver = {
   aggregatable: { unwind: true },
   default: undefined,
 };
+
+/**
+ * @name follower
+ * @description A party(i.e call center or EOC operator) who
+ * made a latest follow-up on a case.
+ *
+ * @memberof Case
+ *
+ * @type {object}
+ * @property {object} type - schema(data) type
+ * @property {boolean} required - mark required
+ * @property {boolean} index - ensure database index
+ * @property {boolean} exists - ensure ref exists before save
+ * @property {object} autopopulate - auto populate(eager loading) options
+ * @property {boolean} taggable - allow field use for tagging
+ * @property {boolean} exportable - allow field use for exporting
+ * @property {boolean} aggregatable - allow field use for aggregation
+ * @property {boolean} default - default value set when none provided
+ * @property {object} fake - fake data generator options
+ *
+ * @author lally elias <lallyelias87@gmail.com>
+ * @since 0.1.0
+ * @version 0.1.0
+ * @instance
+ * @example
+ * {
+ *   _id: "5bcda2c073dd0700048fb846",
+ *   name: "Jane Doe",
+ *   mobile: "+255715463739",
+ *   email: "jane.doe@example.com",
+ * }
+ */
+export const follower = {
+  type: ObjectId,
+  ref: Party.MODEL_NAME,
+  // required: true,
+  index: true,
+  exists: true,
+  autopopulate: AUTOPOPULATE_OPTION_PARTY,
+  taggable: true,
+  exportable: {
+    format: (v) => get(v, 'name'),
+    default: 'NA',
+  },
+  aggregatable: { unwind: true },
+  default: undefined,
+};

test/unit/case.schema.spec.js

@@ -252,4 +252,31 @@ describe('Case Schema', () => {
     expect(remarks.options.exportable).to.be.true;
     expect(remarks.options.fake).to.exist;
   });
+
+  it('should have followup field', () => {
+    const followup = Case.path('followup');
+    const follower = Case.path('followup.follower');
+    const followedAt = Case.path('followup.followedAt');
+    const symptoms = Case.path('followup.symptoms');
+    const outcome = Case.path('followup.outcome');
+    const remarks = Case.path('followup.remarks');
+
+    expect(followup).to.exist;
+    expect(followup).to.be.an.instanceof(SchemaTypes.Embedded);
+
+    expect(follower).to.exist;
+    expect(follower).to.be.instanceof(SchemaTypes.ObjectId);
+
+    expect(followedAt).to.exist;
+    expect(followedAt).to.be.instanceof(SchemaTypes.Date);
+
+    expect(symptoms).to.exist;
+    expect(symptoms).to.be.instanceof(SchemaTypes.Map);
+
+    expect(outcome).to.exist;
+    expect(outcome).to.be.instanceof(SchemaTypes.String);
+
+    expect(remarks).to.exist;
+    expect(remarks).to.be.instanceof(SchemaTypes.String);
+  });
 });