feat(medical): add a medical module (#3949)

Co-authored-by: ST-DDT <ST-DDT@gmx.de>

Author: rodrigobnogueira

docs/.vitepress/api-pages.ts

@@ -28,6 +28,7 @@ export const apiPages = [
       { text: 'Internet', link: '/api/internet.html' },
       { text: 'Location', link: '/api/location.html' },
       { text: 'Lorem', link: '/api/lorem.html' },
+      { text: 'Medical', link: '/api/medical.html' },
       { text: 'Music', link: '/api/music.html' },
       { text: 'Number', link: '/api/number.html' },
       { text: 'Person', link: '/api/person.html' },

scripts/generate-locales.ts

@@ -63,6 +63,7 @@ const definitionsTypes: DefinitionType = {
   internet: 'InternetDefinition',
   location: 'LocationDefinition',
   lorem: 'LoremDefinition',
+  medical: 'MedicalDefinition',
   metadata: 'MetadataDefinition',
   music: 'MusicDefinition',
   person: 'PersonDefinition',

src/definitions/definitions.ts

@@ -12,6 +12,7 @@ import type { HackerDefinition } from './hacker';
 import type { InternetDefinition } from './internet';
 import type { LocationDefinition } from './location';
 import type { LoremDefinition } from './lorem';
+import type { MedicalDefinition } from './medical';
 import type { MetadataDefinition } from './metadata';
 import type { MusicDefinition } from './music';
 import type { PersonDefinition } from './person';
@@ -47,6 +48,7 @@ export type LocaleDefinition = {
   internet?: InternetDefinition;
   location?: LocationDefinition;
   lorem?: LoremDefinition;
+  medical?: MedicalDefinition;
   music?: MusicDefinition;
   person?: PersonDefinition;
   phone_number?: PhoneNumberDefinition;

src/definitions/index.ts

@@ -16,6 +16,7 @@ export type { HackerDefinition } from './hacker';
 export type { InternetDefinition } from './internet';
 export type { LocationDefinition } from './location';
 export type { LoremDefinition } from './lorem';
+export type { MedicalDefinition } from './medical';
 export type { MetadataDefinition } from './metadata';
 export type { MusicDefinition } from './music';
 export type { PersonDefinition, PersonEntryDefinition } from './person';

src/definitions/medical.ts

@@ -0,0 +1,46 @@
+import type { LocaleEntry } from './definitions';
+
+/**
+ * The possible definitions related to medical and healthcare data.
+ */
+export type MedicalDefinition = LocaleEntry<{
+  /**
+   * Medical specialties, e.g. `'Cardiology'`.
+   */
+  specialty: string[];
+
+  /**
+   * Hospital departments, e.g. `'Emergency Department'`.
+   */
+  department: string[];
+
+  /**
+   * Plausible medical condition names (without diagnosis codes), e.g. `'Type 2 Diabetes'`.
+   */
+  condition: string[];
+
+  /**
+   * Symptoms, e.g. `'Shortness of Breath'`.
+   */
+  symptom: string[];
+
+  /**
+   * Medical procedures, e.g. `'Appendectomy'`.
+   */
+  procedure: string[];
+
+  /**
+   * Common allergens, e.g. `'Penicillin'`.
+   */
+  allergen: string[];
+
+  /**
+   * Blood types, e.g. `'O+'`.
+   */
+  blood_type: string[];
+
+  /**
+   * Fictitious, brand-style drug names, e.g. `'Zolpraxen'`.
+   */
+  drug_name: string[];
+}>;

src/faker.ts

@@ -19,6 +19,7 @@ import { ImageModule } from './modules/image';
 import { InternetModule } from './modules/internet';
 import { LocationModule } from './modules/location';
 import { LoremModule } from './modules/lorem';
+import { MedicalModule } from './modules/medical';
 import { MusicModule } from './modules/music';
 import { PersonModule } from './modules/person';
 import { PhoneModule } from './modules/phone';
@@ -73,6 +74,7 @@ export class Faker extends SimpleFaker {
   readonly internet: InternetModule = new InternetModule(this);
   readonly location: LocationModule = new LocationModule(this);
   readonly lorem: LoremModule = new LoremModule(this);
+  readonly medical: MedicalModule = new MedicalModule(this);
   readonly music: MusicModule = new MusicModule(this);
   readonly person: PersonModule = new PersonModule(this);
   readonly phone: PhoneModule = new PhoneModule(this);

src/index.ts

@@ -20,6 +20,7 @@ export type {
   LocaleEntry,
   LocationDefinition,
   LoremDefinition,
+  MedicalDefinition,
   MetadataDefinition,
   MusicDefinition,
   PersonDefinition,
@@ -75,6 +76,7 @@ export { IPv4Network } from './modules/internet';
 export type { IPv4NetworkType, InternetModule } from './modules/internet';
 export type { LocationModule, SimpleLocationModule } from './modules/location';
 export type { LoremModule } from './modules/lorem';
+export type { MedicalModule } from './modules/medical';
 export type { MusicModule } from './modules/music';
 export type { NumberModule } from './modules/number';
 export { Sex } from './modules/person';

src/locales/en/index.ts

@@ -18,6 +18,7 @@ import hacker from './hacker';
 import internet from './internet';
 import location from './location';
 import lorem from './lorem';
+import medical from './medical';
 import metadata from './metadata';
 import music from './music';
 import person from './person';
@@ -49,6 +50,7 @@ const en: LocaleDefinition = {
   internet,
   location,
   lorem,
+  medical,
   metadata,
   music,
   person,

src/locales/en/medical/allergen.ts

@@ -0,0 +1,38 @@
+export default [
+  'Adhesive',
+  'Anesthesia',
+  'Aspirin',
+  'Bee Sting',
+  'Celery',
+  'Cockroaches',
+  'Codeine',
+  'Contrast Dye',
+  'Corn',
+  'Dust Mites',
+  'Eggs',
+  'Fish',
+  'Fragrance',
+  'Grass',
+  'Ibuprofen',
+  'Insect Bites',
+  'Latex',
+  'Lupin',
+  'Milk',
+  'Mold',
+  'Morphine',
+  'Mustard',
+  'Nickel',
+  'Peanuts',
+  'Penicillin',
+  'Pet Dander',
+  'Pollen',
+  'Ragweed',
+  'Red Dye',
+  'Sesame',
+  'Shellfish',
+  'Soy',
+  'Sulfa Drugs',
+  'Sulfites',
+  'Tree Nuts',
+  'Wheat',
+];

src/locales/en/medical/blood_type.ts

@@ -0,0 +1 @@
+export default ['A+', 'A-', 'AB+', 'AB-', 'B+', 'B-', 'O+', 'O-'];