TypeSchema/API/TS: prohibit undeclared choice variants, validate them, export profile snapshots

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

@@ -437,6 +437,17 @@ export const validateChoiceRequired = (res: object, profileName: string, choices
         : [`${profileName}: at least one of ${choices.join(", ")} is required`];
 };
 
+/**
+ * Checks that none of the listed prohibited choice-type variants is present.
+ * E.g. a profile narrowing `value[x]` to `valueAddress` prohibits every other variant.
+ */
+export const validateChoiceProhibited = (res: object, profileName: string, prohibited: string[]): string[] => {
+    const rec = res as Record<string, unknown>;
+    return prohibited
+        .filter((c) => rec[c] !== undefined)
+        .map((c) => `${profileName}: field '${c}' must not be present`);
+};
+
 /**
  * Checks that the value of `field` has a code within `allowed`.
  * Handles plain strings, Coding objects, and CodeableConcept objects.

examples/python-r4-us-core/fhir_types/README.md

@@ -2089,6 +2089,8 @@
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus#code_binding`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus#status_binding`
+- `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus#valueCodeableConcept_binding`
+- `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus#valueQuantity_binding`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen#collection.bodySite_binding`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen#condition_binding`
@@ -3028,6 +3030,7 @@
 - `urn:fhir:binding:specialty`
 - `urn:fhir:binding:status`
 - `urn:fhir:binding:strandType`
+- `urn:fhir:binding:v3-Confidentiality`
 - `urn:fhir:binding:v3Act`
 - `urn:fhir:binding:validation-process`
 - `urn:fhir:binding:validation-status`
@@ -5547,6 +5550,9 @@ and check `<pkg>/collisions/<name>/1.json, 2.json, ...` files.
   - Version 1 (auto): Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1)
   - Version 2: Claim (hl7.fhir.r5.core#5.0.0), Claim (hl7.fhir.r5.core#5.0.0), Claim (hl7.fhir.r5.core#5.0.0), ClaimResponse (hl7.fhir.r5.core#5.0.0), ClaimResponse (hl7.fhir.r5.core#5.0.0), ClaimResponse (hl7.fhir.r5.core#5.0.0), ExplanationOfBenefit (hl7.fhir.r5.core#5.0.0), ExplanationOfBenefit (hl7.fhir.r5.core#5.0.0), ExplanationOfBenefit (hl7.fhir.r5.core#5.0.0)
   - Version 3: Claim (hl7.fhir.r4.examples#4.0.1), ClaimResponse (hl7.fhir.r4.examples#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.examples#4.0.1)
+- `urn:fhir:binding:v3-Confidentiality` (2 versions)
+  - Version 1 (auto): confidential (hl7.fhir.uv.extensions.r4#5.2.0), confidential (hl7.fhir.uv.extensions.r4#5.2.0), confidential (hl7.fhir.uv.extensions.r4#5.2.0)
+  - Version 2: confidential (hl7.fhir.uv.extensions#5.1.0-snapshot1), confidential (hl7.fhir.uv.extensions#5.1.0-snapshot1)
 - `urn:fhir:binding:v3Act` (2 versions)
   - Version 1 (auto): DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1)
   - Version 2: DocumentManifest (hl7.fhir.r4.examples#4.0.1)
@@ -8176,6 +8182,10 @@ Add to `.typeSchema({ resolveCollisions: { ... } })` to resolve remaining collis
             package: "hl7.fhir.r4.core#4.0.1",
             canonical: "http://hl7.org/fhir/StructureDefinition/Claim",
         },
+        "urn:fhir:binding:v3-Confidentiality": {
+            package: "hl7.fhir.uv.extensions.r4#5.2.0",
+            canonical: "http://hl7.org/fhir/StructureDefinition/confidential",
+        },
         "urn:fhir:binding:v3Act": {
             package: "hl7.fhir.r4.core#4.0.1",
             canonical: "http://hl7.org/fhir/StructureDefinition/DocumentManifest",

examples/typescript-r4-us-core/fhir-types/README.md

@@ -2081,6 +2081,8 @@
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus#code_binding`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus#status_binding`
+- `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus#valueCodeableConcept_binding`
+- `http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus#valueQuantity_binding`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen#collection.bodySite_binding`
 - `http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen#condition_binding`
@@ -3022,6 +3024,7 @@
 - `urn:fhir:binding:specialty`
 - `urn:fhir:binding:status`
 - `urn:fhir:binding:strandType`
+- `urn:fhir:binding:v3-Confidentiality`
 - `urn:fhir:binding:v3Act`
 - `urn:fhir:binding:validation-process`
 - `urn:fhir:binding:validation-status`
@@ -5541,6 +5544,9 @@ and check `<pkg>/collisions/<name>/1.json, 2.json, ...` files.
   - Version 1 (auto): Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), Claim (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ClaimResponse (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.core#4.0.1)
   - Version 2: Claim (hl7.fhir.r5.core#5.0.0), Claim (hl7.fhir.r5.core#5.0.0), Claim (hl7.fhir.r5.core#5.0.0), ClaimResponse (hl7.fhir.r5.core#5.0.0), ClaimResponse (hl7.fhir.r5.core#5.0.0), ClaimResponse (hl7.fhir.r5.core#5.0.0), ExplanationOfBenefit (hl7.fhir.r5.core#5.0.0), ExplanationOfBenefit (hl7.fhir.r5.core#5.0.0), ExplanationOfBenefit (hl7.fhir.r5.core#5.0.0)
   - Version 3: Claim (hl7.fhir.r4.examples#4.0.1), ClaimResponse (hl7.fhir.r4.examples#4.0.1), ExplanationOfBenefit (hl7.fhir.r4.examples#4.0.1)
+- `urn:fhir:binding:v3-Confidentiality` (2 versions)
+  - Version 1 (auto): confidential (hl7.fhir.uv.extensions.r4#5.2.0), confidential (hl7.fhir.uv.extensions.r4#5.2.0), confidential (hl7.fhir.uv.extensions.r4#5.2.0)
+  - Version 2: confidential (hl7.fhir.uv.extensions#5.1.0-snapshot1), confidential (hl7.fhir.uv.extensions#5.1.0-snapshot1)
 - `urn:fhir:binding:v3Act` (2 versions)
   - Version 1 (auto): DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1), DocumentManifest (hl7.fhir.r4.core#4.0.1)
   - Version 2: DocumentManifest (hl7.fhir.r4.examples#4.0.1)
@@ -8154,6 +8160,10 @@ Add to `.typeSchema({ resolveCollisions: { ... } })` to resolve remaining collis
             package: "hl7.fhir.r4.core#4.0.1",
             canonical: "http://hl7.org/fhir/StructureDefinition/Claim",
         },
+        "urn:fhir:binding:v3-Confidentiality": {
+            package: "hl7.fhir.uv.extensions.r4#5.2.0",
+            canonical: "http://hl7.org/fhir/StructureDefinition/confidential",
+        },
         "urn:fhir:binding:v3Act": {
             package: "hl7.fhir.r4.core#4.0.1",
             canonical: "http://hl7.org/fhir/StructureDefinition/DocumentManifest",

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

@@ -15,6 +15,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 
@@ -92,6 +93,7 @@ export class birthPlaceProfile {
                 ...validateRequired(res, profileName, "url"),
                 ...validateFixedValue(res, profileName, "url", birthPlaceProfile.canonicalUrl),
                 ...validateChoiceRequired(res, profileName, ["valueAddress"]),
+                ...validateChoiceProhibited(res, profileName, ["valueBase64Binary","valueBoolean","valueCanonical","valueCode","valueDate","valueDateTime","valueDecimal","valueId","valueInstant","valueInteger","valueMarkdown","valueOid","valuePositiveInt","valueString","valueTime","valueUnsignedInt","valueUri","valueUrl","valueUuid","valueAge","valueAnnotation","valueAttachment","valueCodeableConcept","valueCoding","valueContactPoint","valueCount","valueDistance","valueDuration","valueHumanName","valueIdentifier","valueMoney","valuePeriod","valueQuantity","valueRange","valueRatio","valueReference","valueSampledData","valueSignature","valueTiming","valueContactDetail","valueContributor","valueDataRequirement","valueExpression","valueParameterDefinition","valueRelatedArtifact","valueTriggerDefinition","valueUsageContext","valueDosage","valueMeta"]),
             ],
             warnings: [],
         }

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

@@ -14,6 +14,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 
@@ -91,6 +92,7 @@ export class birthTimeProfile {
                 ...validateRequired(res, profileName, "url"),
                 ...validateFixedValue(res, profileName, "url", birthTimeProfile.canonicalUrl),
                 ...validateChoiceRequired(res, profileName, ["valueDateTime"]),
+                ...validateChoiceProhibited(res, profileName, ["valueBase64Binary","valueBoolean","valueCanonical","valueCode","valueDate","valueDecimal","valueId","valueInstant","valueInteger","valueMarkdown","valueOid","valuePositiveInt","valueString","valueTime","valueUnsignedInt","valueUri","valueUrl","valueUuid","valueAddress","valueAge","valueAnnotation","valueAttachment","valueCodeableConcept","valueCoding","valueContactPoint","valueCount","valueDistance","valueDuration","valueHumanName","valueIdentifier","valueMoney","valuePeriod","valueQuantity","valueRange","valueRatio","valueReference","valueSampledData","valueSignature","valueTiming","valueContactDetail","valueContributor","valueDataRequirement","valueExpression","valueParameterDefinition","valueRelatedArtifact","valueTriggerDefinition","valueUsageContext","valueDosage","valueMeta"]),
             ],
             warnings: [],
         }

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

@@ -21,6 +21,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 

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

@@ -14,6 +14,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 
@@ -91,6 +92,7 @@ export class own_prefixProfile {
                 ...validateRequired(res, profileName, "url"),
                 ...validateFixedValue(res, profileName, "url", own_prefixProfile.canonicalUrl),
                 ...validateChoiceRequired(res, profileName, ["valueString"]),
+                ...validateChoiceProhibited(res, profileName, ["valueBase64Binary","valueBoolean","valueCanonical","valueCode","valueDate","valueDateTime","valueDecimal","valueId","valueInstant","valueInteger","valueMarkdown","valueOid","valuePositiveInt","valueTime","valueUnsignedInt","valueUri","valueUrl","valueUuid","valueAddress","valueAge","valueAnnotation","valueAttachment","valueCodeableConcept","valueCoding","valueContactPoint","valueCount","valueDistance","valueDuration","valueHumanName","valueIdentifier","valueMoney","valuePeriod","valueQuantity","valueRange","valueRatio","valueReference","valueSampledData","valueSignature","valueTiming","valueContactDetail","valueContributor","valueDataRequirement","valueExpression","valueParameterDefinition","valueRelatedArtifact","valueTriggerDefinition","valueUsageContext","valueDosage","valueMeta"]),
             ],
             warnings: [],
         }

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

@@ -29,6 +29,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 
@@ -210,6 +211,7 @@ export class observation_bodyweightProfile {
                 ...validateRequired(res, profileName, "subject"),
                 ...validateReference(res, profileName, "subject", ["Patient"]),
                 ...validateChoiceRequired(res, profileName, ["effectiveDateTime","effectivePeriod"]),
+                ...validateChoiceProhibited(res, profileName, ["effectiveTiming","effectiveInstant"]),
                 ...validateReference(res, profileName, "hasMember", ["MolecularSequence","QuestionnaireResponse","Observation"]),
                 ...validateReference(res, profileName, "derivedFrom", ["DocumentReference","ImagingStudy","Media","MolecularSequence","QuestionnaireResponse","Observation"]),
             ],

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

@@ -37,6 +37,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 
@@ -291,6 +292,7 @@ export class observation_bpProfile {
                 ...validateRequired(res, profileName, "subject"),
                 ...validateReference(res, profileName, "subject", ["Patient"]),
                 ...validateChoiceRequired(res, profileName, ["effectiveDateTime","effectivePeriod"]),
+                ...validateChoiceProhibited(res, profileName, ["effectiveTiming","effectiveInstant"]),
                 ...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),

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

@@ -27,6 +27,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 
@@ -203,6 +204,7 @@ export class observation_vitalsignsProfile {
                 ...validateRequired(res, profileName, "subject"),
                 ...validateReference(res, profileName, "subject", ["Patient"]),
                 ...validateChoiceRequired(res, profileName, ["effectiveDateTime","effectivePeriod"]),
+                ...validateChoiceProhibited(res, profileName, ["effectiveTiming","effectiveInstant"]),
                 ...validateReference(res, profileName, "hasMember", ["MolecularSequence","QuestionnaireResponse","Observation"]),
                 ...validateReference(res, profileName, "derivedFrom", ["DocumentReference","ImagingStudy","Media","MolecularSequence","QuestionnaireResponse","Observation"]),
             ],

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

@@ -40,6 +40,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 

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

@@ -15,6 +15,7 @@ import {
     validateEnum,
     validateReference,
     validateChoiceRequired,
+    validateChoiceProhibited,
     validateMustSupport,
 } from "../../profile-helpers";
 
@@ -92,6 +93,7 @@ export class USCoreIndividualSexExtensionProfile {
                 ...validateRequired(res, profileName, "url"),
                 ...validateFixedValue(res, profileName, "url", USCoreIndividualSexExtensionProfile.canonicalUrl),
                 ...validateChoiceRequired(res, profileName, ["valueCoding"]),
+                ...validateChoiceProhibited(res, profileName, ["valueBase64Binary","valueBoolean","valueCanonical","valueCode","valueDate","valueDateTime","valueDecimal","valueId","valueInstant","valueInteger","valueMarkdown","valueOid","valuePositiveInt","valueString","valueTime","valueUnsignedInt","valueUri","valueUrl","valueUuid","valueAddress","valueAge","valueAnnotation","valueAttachment","valueCodeableConcept","valueContactPoint","valueCount","valueDistance","valueDuration","valueHumanName","valueIdentifier","valueMoney","valuePeriod","valueQuantity","valueRange","valueRatio","valueReference","valueSampledData","valueSignature","valueTiming","valueContactDetail","valueContributor","valueDataRequirement","valueExpression","valueParameterDefinition","valueRelatedArtifact","valueTriggerDefinition","valueUsageContext","valueDosage","valueMeta"]),
             ],
             warnings: [],
         }