Merge pull request #130 from atomic-ehr/fix-slice-field-validation

TS: Validate required fields inside slice elements

Author: ryukzak

assets/api/writer-generator/typescript/profile-helpers.ts

@@ -378,6 +378,31 @@ export const validateSliceCardinality = (
     return errors;
 };
 
+/**
+ * Validate required fields within matched slice elements.
+ * For each array item matching the discriminator, checks that the listed fields are present.
+ */
+export const validateSliceFields = (
+    res: object,
+    profileName: string,
+    field: string,
+    match: Record<string, unknown>,
+    sliceName: string,
+    requiredFields: string[],
+): string[] => {
+    const items = (res as Record<string, unknown>)[field] as unknown[] | undefined;
+    const errors: string[] = [];
+    for (const item of (items ?? []).filter((item) => matchesValue(item, match))) {
+        const obj = item as Record<string, unknown>;
+        for (const rf of requiredFields) {
+            if (obj[rf] === undefined || obj[rf] === null) {
+                errors.push(`${profileName}.${field}[${sliceName}].${rf} is required`);
+            }
+        }
+    }
+    return errors;
+};
+
 /**
  * Checks that at least one of the listed choice-type variants is present.
  * E.g. `["effectiveDateTime", "effectivePeriod"]`.

examples/typescript-r4/fhir-types/hl7-fhir-r4-core/profiles/Extension_birthPlace.ts

@@ -10,6 +10,7 @@ import {
     validateExcluded,
     validateFixedValue,
     validateSliceCardinality,
+    validateSliceFields,
     validateEnum,
     validateReference,
     validateChoiceRequired,

examples/typescript-r4/fhir-types/hl7-fhir-r4-core/profiles/Extension_birthTime.ts

@@ -9,6 +9,7 @@ import {
     validateExcluded,
     validateFixedValue,
     validateSliceCardinality,
+    validateSliceFields,
     validateEnum,
     validateReference,
     validateChoiceRequired,

examples/typescript-r4/fhir-types/hl7-fhir-r4-core/profiles/Extension_nationality.ts

@@ -16,6 +16,7 @@ import {
     validateExcluded,
     validateFixedValue,
     validateSliceCardinality,
+    validateSliceFields,
     validateEnum,
     validateReference,
     validateChoiceRequired,

examples/typescript-r4/fhir-types/hl7-fhir-r4-core/profiles/Extension_own_prefix.ts

@@ -9,6 +9,7 @@ import {
     validateExcluded,
     validateFixedValue,
     validateSliceCardinality,
+    validateSliceFields,
     validateEnum,
     validateReference,
     validateChoiceRequired,

examples/typescript-r4/fhir-types/hl7-fhir-r4-core/profiles/Observation_observation_bodyweight.ts

@@ -24,6 +24,7 @@ import {
     validateExcluded,
     validateFixedValue,
     validateSliceCardinality,
+    validateSliceFields,
     validateEnum,
     validateReference,
     validateChoiceRequired,

examples/typescript-r4/fhir-types/hl7-fhir-r4-core/profiles/Observation_observation_bp.ts

@@ -32,6 +32,7 @@ import {
     validateExcluded,
     validateFixedValue,
     validateSliceCardinality,
+    validateSliceFields,
     validateEnum,
     validateReference,
     validateChoiceRequired,
@@ -280,7 +281,9 @@ export class observation_bpProfile {
                 ...validateReference(res, profileName, "hasMember", ["MolecularSequence","QuestionnaireResponse","Observation"]),
                 ...validateReference(res, profileName, "derivedFrom", ["DocumentReference","ImagingStudy","Media","MolecularSequence","QuestionnaireResponse","Observation"]),
                 ...validateSliceCardinality(res, profileName, "component", {"code":{"coding":[{"code":"8480-6","system":"http://loinc.org"}]}}, "SystolicBP", 1, 1),
+                ...validateSliceFields(res, profileName, "component", {"code":{"coding":[{"code":"8480-6","system":"http://loinc.org"}]}}, "SystolicBP", ["valueQuantity"]),
                 ...validateSliceCardinality(res, profileName, "component", {"code":{"coding":[{"code":"8462-4","system":"http://loinc.org"}]}}, "DiastolicBP", 1, 1),
+                ...validateSliceFields(res, profileName, "component", {"code":{"coding":[{"code":"8462-4","system":"http://loinc.org"}]}}, "DiastolicBP", ["valueQuantity"]),
             ],
             warnings: [
                 ...validateEnum(res, profileName, "category", ["social-history","vital-signs","imaging","laboratory","procedure","survey","exam","therapy","activity"]),

examples/typescript-r4/fhir-types/hl7-fhir-r4-core/profiles/Observation_observation_vitalsigns.ts

@@ -23,6 +23,7 @@ import {
     validateExcluded,
     validateFixedValue,
     validateSliceCardinality,
+    validateSliceFields,
     validateEnum,
     validateReference,
     validateChoiceRequired,

examples/typescript-r4/fhir-types/profile-helpers.ts

@@ -378,6 +378,31 @@ export const validateSliceCardinality = (
     return errors;
 };
 
+/**
+ * Validate required fields within matched slice elements.
+ * For each array item matching the discriminator, checks that the listed fields are present.
+ */
+export const validateSliceFields = (
+    res: object,
+    profileName: string,
+    field: string,
+    match: Record<string, unknown>,
+    sliceName: string,
+    requiredFields: string[],
+): string[] => {
+    const items = (res as Record<string, unknown>)[field] as unknown[] | undefined;
+    const errors: string[] = [];
+    for (const item of (items ?? []).filter((item) => matchesValue(item, match))) {
+        const obj = item as Record<string, unknown>;
+        for (const rf of requiredFields) {
+            if (obj[rf] === undefined || obj[rf] === null) {
+                errors.push(`${profileName}.${field}[${sliceName}].${rf} is required`);
+            }
+        }
+    }
+    return errors;
+};
+
 /**
  * Checks that at least one of the listed choice-type variants is present.
  * E.g. `["effectiveDateTime", "effectivePeriod"]`.

examples/typescript-r4/profile-bp.test.ts

@@ -14,9 +14,11 @@ describe("demo: create a blood pressure observation", () => {
             subject: { reference: "Patient/pt-1" },
         });
 
-        // Not yet valid: effective[x] is required by the vitalsigns base profile
+        // Not yet valid: effective[x] and component valueQuantity are required
         expect(profile.validate().errors).toEqual([
             "observation-bp: at least one of effectiveDateTime, effectivePeriod is required",
+            "observation-bp.component[SystolicBP].valueQuantity is required",
+            "observation-bp.component[DiastolicBP].valueQuantity is required",
         ]);
 
         // Fill in the remaining required fields
@@ -44,9 +46,11 @@ describe("demo: apply BP profile to an existing Observation", () => {
         // apply() adds meta.profile, sets fixed values (code), and auto-populates required slices
         const profile = bpProfile.apply(obs);
 
-        // Not yet valid: effective[x] is required
+        // Not yet valid: effective[x] and component valueQuantity are required
         expect(profile.validate().errors).toEqual([
             "observation-bp: at least one of effectiveDateTime, effectivePeriod is required",
+            "observation-bp.component[SystolicBP].valueQuantity is required",
+            "observation-bp.component[DiastolicBP].valueQuantity is required",
         ]);
 
         // The profile mutates the original resource — no copy is made