@cosyte/synth 0.0.9 → 0.1.0

package/dist/fhir/index.d.cts

@@ -1,5 +1,5 @@
 import { FhirComplex, StructureDefinition, FhirNode } from '@cosyte/fhir';
-import { C as Corpus, R as Rng, S as SyntheticName, a as SyntheticIdentifier, b as SyntheticAddress } from '../providers-B9uVinAe.cjs';
+import { C as Corpus, R as Rng, S as SyntheticName, a as SyntheticIdentifier, b as SyntheticAddress } from '../providers-BQtPk3PN.cjs';
 export { C as CodeConcept, E as EXAMPLE_ALLERGENS, a as EXAMPLE_ALLERGY_MANIFESTATIONS, b as EXAMPLE_CONDITIONS, c as EXAMPLE_DIAGNOSTIC_REPORTS, d as EXAMPLE_ENCOUNTER_CLASSES, e as EXAMPLE_ENCOUNTER_TYPES, f as EXAMPLE_ETHNICITY_CATEGORIES, g as EXAMPLE_LAB_OBSERVATIONS, h as EXAMPLE_MEDICATIONS, i as EXAMPLE_PROCEDURES, j as EXAMPLE_RACE_CATEGORIES, k as EXAMPLE_VACCINES, l as EXAMPLE_VITAL_SIGNS, Q as QuantConcept } from '../example-codes-88f3_bQZ.cjs';
 
 /**
@@ -273,6 +273,48 @@ interface GenerateProcedureOptions {
  */
 declare function generateProcedure(options?: GenerateProcedureOptions): FhirComplex;
 
+/**
+ * Synthetic FHIR R4 **`Provenance`** generation: a US Core Provenance, the record of who authored and
+ * transmitted a resource. Built through `@cosyte/fhir`'s model constructors like every other resource
+ * here, so it is spec-clean by construction and needs no upstream builder of its own.
+ *
+ * The profile's required elements (`target`, `recorded`, `agent.who`) are always present, as is the
+ * must-support `agent.onBehalfOf`, which also discharges the profile's `provenance-1` invariant
+ * ("onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device") outright
+ * rather than leaving it to a resolver.
+ *
+ * **The single agent is typed as both author and transmitter, deliberately.** US Core slices
+ * `Provenance.agent` on a `type` pattern into a `ProvenanceAuthor` slice and a `ProvenanceTransmitter`
+ * slice, both must-support and both optional. One synthetic source system authored this record and
+ * transmitted it, so one agent carries both participation codings: a `CodeableConcept` is a set of
+ * codings for exactly this reason, and the slicing is `open`. Splitting it into two agents would say
+ * two parties were involved, which is not what a self-contained synthetic fixture models.
+ *
+ * @module
+ */
+
+/** Options for {@link generateProvenance}. */
+interface GenerateProvenanceOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `target` reference this provenance is about (e.g. `"Patient/syn-patient-1"`). */
+    readonly target?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core `Provenance`, built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, target reference, and US Core posture. See {@link GenerateProvenanceOptions}.
+ * @returns The `Provenance` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateProvenance } from "@cosyte/synth/fhir";
+ * const provenance = generateProvenance({ seed: 19, target: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateProvenance(options?: GenerateProvenanceOptions): FhirComplex;
+
 /**
  * Synthetic FHIR R4 **`DiagnosticReport`** generation: the US Core DiagnosticReport Profile for
  * Laboratory Results Reporting. Built through `@cosyte/fhir`;
@@ -721,7 +763,44 @@ declare const US_CORE_PROFILE: Readonly<{
     readonly ALLERGY_INTOLERANCE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance";
     /** US Core Procedure. */
     readonly PROCEDURE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure";
+    /** US Core Provenance. */
+    readonly PROVENANCE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance";
 }>;
+/**
+ * The canonical prefix every US Core 6.1.0 resource profile's `url` shares. A profile's canonical is
+ * this prefix followed by its profile id.
+ *
+ * @example
+ * ```ts
+ * import { US_CORE_PROFILE_BASE } from "@cosyte/synth/fhir";
+ * `${US_CORE_PROFILE_BASE}us-core-provenance`;
+ * ```
+ */
+declare const US_CORE_PROFILE_BASE = "http://hl7.org/fhir/us/core/StructureDefinition/";
+/**
+ * The **adopted set**: the profile ids of every US Core 6.1.0 **resource profile** the implementation
+ * guide publishes, transcribed from the guide's own artifact index ("Structures: Resource Profiles").
+ * This is the closed set a profile-addressed request is resolved against, and it is *identifiers
+ * only*, never IG content, exactly like {@link US_CORE_PROFILE}.
+ *
+ * `45 CFR 170.215` adopts FHIR R4.0.1 and US Core STU 6.1.0, so this is the profile set a developer
+ * building to `45 CFR 170.315(g)(10)` addresses. It is **not** the count of
+ * `StructureDefinition-us-core-*.json` files in the guide's source tree: that directory also holds
+ * the guide's extension definitions and omits profiles the guide publishes.
+ *
+ * The guide's 10 **extension definitions** (`us-core-race`, `us-core-birthsex`, …) are deliberately
+ * absent: an extension is not a standalone artifact, so a request naming one is refused like any
+ * other name outside this set.
+ *
+ * @example
+ * ```ts
+ * import { US_CORE_ADOPTED_PROFILES } from "@cosyte/synth/fhir";
+ * US_CORE_ADOPTED_PROFILES.includes("us-core-provenance"); // true
+ * ```
+ */
+declare const US_CORE_ADOPTED_PROFILES: readonly ["head-occipital-frontal-circumference-percentile", "pediatric-bmi-for-age", "pediatric-weight-for-height", "us-core-allergyintolerance", "us-core-blood-pressure", "us-core-bmi", "us-core-body-height", "us-core-body-temperature", "us-core-body-weight", "us-core-careplan", "us-core-careteam", "us-core-condition-encounter-diagnosis", "us-core-condition-problems-health-concerns", "us-core-coverage", "us-core-diagnosticreport-lab", "us-core-diagnosticreport-note", "us-core-documentreference", "us-core-encounter", "us-core-goal", "us-core-head-circumference", "us-core-heart-rate", "us-core-immunization", "us-core-implantable-device", "us-core-location", "us-core-medication", "us-core-medicationdispense", "us-core-medicationrequest", "us-core-observation-clinical-result", "us-core-observation-lab", "us-core-observation-occupation", "us-core-observation-pregnancyintent", "us-core-observation-pregnancystatus", "us-core-observation-screening-assessment", "us-core-observation-sexual-orientation", "us-core-organization", "us-core-patient", "us-core-practitioner", "us-core-practitionerrole", "us-core-procedure", "us-core-provenance", "us-core-pulse-oximetry", "us-core-questionnaireresponse", "us-core-relatedperson", "us-core-respiratory-rate", "us-core-servicerequest", "us-core-simple-observation", "us-core-smokingstatus", "us-core-specimen", "us-core-vital-signs"];
+/** One profile id from the adopted US Core 6.1.0 set. Erased at run time, so it is resolved, not trusted. */
+type UsCoreProfileId = (typeof US_CORE_ADOPTED_PROFILES)[number];
 /** The US Core `us-core-race` extension URL (a Patient must-support extension). */
 declare const US_CORE_RACE_EXTENSION = "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race";
 /** The US Core `us-core-ethnicity` extension URL (a Patient must-support extension). */
@@ -765,8 +844,90 @@ declare const SYSTEM: Readonly<{
     readonly ALLERGY_CLINICAL: "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical";
     /** HL7 Terminology `allergyintolerance-verification`, `AllergyIntolerance.verificationStatus`. */
     readonly ALLERGY_VERIFICATION: "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification";
+    /** HL7 Terminology `provenance-participant-type`, `Provenance.agent.type` (`author`). */
+    readonly PROVENANCE_PARTICIPANT_TYPE: "http://terminology.hl7.org/CodeSystem/provenance-participant-type";
+    /** US Core `us-core-provenance-participant-type`, `Provenance.agent.type` (`transmitter`). */
+    readonly US_CORE_PROVENANCE_PARTICIPANT_TYPE: "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type";
 }>;
 /** A US Core profile canonical URL. */
 type UsCoreProfileUrl = (typeof US_CORE_PROFILE)[keyof typeof US_CORE_PROFILE];
 
-export { type BuildCompositionInput, type CompositionSection, type FhirBundleType, type FhirCorpusOptions, type FhirPatientIdentity, type FhirResourceKind, type GenerateAllergyIntoleranceOptions, type GenerateBundleOptions, type GenerateConditionOptions, type GenerateDiagnosticReportOptions, type GenerateEncounterOptions, type GenerateImmunizationOptions, type GenerateMedicationRequestOptions, type GenerateObservationOptions, type GeneratePatientOptions, type GenerateProcedureOptions, type Prop, type RoundTripOptions, type RoundTripResult, SYSTEM, US_CORE_BIRTHSEX_EXTENSION, US_CORE_ETHNICITY_EXTENSION, US_CORE_PROFILE, US_CORE_RACE_EXTENSION, type UsCoreProfileUrl, bool, buildComposition, codeableConcept, coding, dec, fhirCorpus, fhirPatientIdentity, generateAllergyIntolerance, generateBundle, generateCondition, generateDiagnosticReport, generateEncounter, generateImmunization, generateMedicationRequest, generateObservationLab, generatePatient, generateProcedure, generateVitalSign, meta, mrnIdentifier, narrative, prop, reference, roundTrip, str, toFhirDate };
+/**
+ * **Profile-addressed generation, and the coverage surface it is resolved against.**
+ *
+ * A consumer building to `45 CFR 170.315(g)(10)` does not think in this package's generator names: it
+ * thinks in US Core 6.1.0 profile names, because that is what the regulation adopts. So this module
+ * offers exactly two things, and the pair is the whole contract:
+ *
+ * 1. {@link usCoreCoverage} reports one entry for **every** profile the adopted guide publishes, each
+ *    carrying its canonical URL and whether this build generates it. "The guide does not publish this"
+ *    and "we do not generate this yet" are different answers, and without a published closed set
+ *    nothing could tell them apart.
+ * 2. {@link generateUsCoreProfile} takes a profile name and either returns an artifact claiming that
+ *    profile, or **fails closed before anything is generated**, on the `resolveKind` discipline every
+ *    other caller-supplied selector here already holds. Two distinct codes: `SYNTH_UNSUPPORTED_KIND`
+ *    for a name outside the adopted set (an extension definition, a typo, a blank, a non-string), and
+ *    `SYNTH_PROFILE_NOT_GENERATED` for an adopted profile this build does not yet cover. Neither
+ *    quotes the requested name, so no caller string reaches a diagnostic surface.
+ *
+ * **Coverage is derived, never declared twice.** The `generated` flag is read off the generator map
+ * below, so a profile cannot be advertised as covered without a generator behind it, and the
+ * conformance suite additionally requires a committed `StructureDefinition` for every profile this
+ * surface reports as generated.
+ *
+ * No IG content is bundled: what is encoded here is a set of identifiers, exactly like `./us-core.js`.
+ *
+ * @module
+ */
+
+/** One adopted US Core 6.1.0 resource profile, and whether this build generates a fixture for it. */
+interface UsCoreProfileCoverage {
+    /** The profile id, as the guide's artifact index spells it. */
+    readonly profile: UsCoreProfileId;
+    /** The profile's canonical URL: the value a generated artifact's `meta.profile` claims. */
+    readonly canonical: string;
+    /** `true` when {@link generateUsCoreProfile} returns an artifact for this profile. */
+    readonly generated: boolean;
+}
+/**
+ * Report this build's US Core 6.1.0 coverage: one entry per **adopted** resource profile, in the
+ * guide's own order, each carrying its canonical URL and whether this build generates it.
+ *
+ * The report is exhaustive over the adopted set by construction, so a profile the guide publishes and
+ * this build does not generate is *named* here rather than being indistinguishable from a typo.
+ *
+ * @returns One frozen {@link UsCoreProfileCoverage} entry per adopted profile.
+ * @example
+ * ```ts
+ * import { usCoreCoverage } from "@cosyte/synth/fhir";
+ * usCoreCoverage().filter((entry) => !entry.generated).map((entry) => entry.profile);
+ * ```
+ */
+declare function usCoreCoverage(): readonly UsCoreProfileCoverage[];
+/** Options for {@link generateUsCoreProfile}. */
+interface GenerateUsCoreProfileOptions {
+    /**
+     * The US Core 6.1.0 profile id to generate. Resolved against the adopted set **before** anything is
+     * generated; there is deliberately no default, so a blank or absent name refuses rather than
+     * falling through to some other profile's artifact.
+     */
+    readonly profile: UsCoreProfileId;
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+}
+/**
+ * Generate a fixture **by US Core 6.1.0 profile name**, or fail closed before anything is generated.
+ *
+ * @param options - The profile name and seed. See {@link GenerateUsCoreProfileOptions}.
+ * @returns The resource model (a `FhirComplex`) claiming that profile in `meta.profile`.
+ * @throws SynthError `SYNTH_UNSUPPORTED_KIND` when the name is not in the adopted set.
+ * @throws SynthError `SYNTH_PROFILE_NOT_GENERATED` when the profile is adopted and not generated here.
+ * @example
+ * ```ts
+ * import { generateUsCoreProfile } from "@cosyte/synth/fhir";
+ * const provenance = generateUsCoreProfile({ profile: "us-core-provenance", seed: 42 });
+ * ```
+ */
+declare function generateUsCoreProfile(options: GenerateUsCoreProfileOptions): FhirComplex;
+
+export { type BuildCompositionInput, type CompositionSection, type FhirBundleType, type FhirCorpusOptions, type FhirPatientIdentity, type FhirResourceKind, type GenerateAllergyIntoleranceOptions, type GenerateBundleOptions, type GenerateConditionOptions, type GenerateDiagnosticReportOptions, type GenerateEncounterOptions, type GenerateImmunizationOptions, type GenerateMedicationRequestOptions, type GenerateObservationOptions, type GeneratePatientOptions, type GenerateProcedureOptions, type GenerateProvenanceOptions, type GenerateUsCoreProfileOptions, type Prop, type RoundTripOptions, type RoundTripResult, SYSTEM, US_CORE_ADOPTED_PROFILES, US_CORE_BIRTHSEX_EXTENSION, US_CORE_ETHNICITY_EXTENSION, US_CORE_PROFILE, US_CORE_PROFILE_BASE, US_CORE_RACE_EXTENSION, type UsCoreProfileCoverage, type UsCoreProfileId, type UsCoreProfileUrl, bool, buildComposition, codeableConcept, coding, dec, fhirCorpus, fhirPatientIdentity, generateAllergyIntolerance, generateBundle, generateCondition, generateDiagnosticReport, generateEncounter, generateImmunization, generateMedicationRequest, generateObservationLab, generatePatient, generateProcedure, generateProvenance, generateUsCoreProfile, generateVitalSign, meta, mrnIdentifier, narrative, prop, reference, roundTrip, str, toFhirDate, usCoreCoverage };

package/dist/fhir/index.d.ts

@@ -1,5 +1,5 @@
 import { FhirComplex, StructureDefinition, FhirNode } from '@cosyte/fhir';
-import { C as Corpus, R as Rng, S as SyntheticName, a as SyntheticIdentifier, b as SyntheticAddress } from '../providers-B9uVinAe.js';
+import { C as Corpus, R as Rng, S as SyntheticName, a as SyntheticIdentifier, b as SyntheticAddress } from '../providers-BQtPk3PN.js';
 export { C as CodeConcept, E as EXAMPLE_ALLERGENS, a as EXAMPLE_ALLERGY_MANIFESTATIONS, b as EXAMPLE_CONDITIONS, c as EXAMPLE_DIAGNOSTIC_REPORTS, d as EXAMPLE_ENCOUNTER_CLASSES, e as EXAMPLE_ENCOUNTER_TYPES, f as EXAMPLE_ETHNICITY_CATEGORIES, g as EXAMPLE_LAB_OBSERVATIONS, h as EXAMPLE_MEDICATIONS, i as EXAMPLE_PROCEDURES, j as EXAMPLE_RACE_CATEGORIES, k as EXAMPLE_VACCINES, l as EXAMPLE_VITAL_SIGNS, Q as QuantConcept } from '../example-codes-88f3_bQZ.js';
 
 /**
@@ -273,6 +273,48 @@ interface GenerateProcedureOptions {
  */
 declare function generateProcedure(options?: GenerateProcedureOptions): FhirComplex;
 
+/**
+ * Synthetic FHIR R4 **`Provenance`** generation: a US Core Provenance, the record of who authored and
+ * transmitted a resource. Built through `@cosyte/fhir`'s model constructors like every other resource
+ * here, so it is spec-clean by construction and needs no upstream builder of its own.
+ *
+ * The profile's required elements (`target`, `recorded`, `agent.who`) are always present, as is the
+ * must-support `agent.onBehalfOf`, which also discharges the profile's `provenance-1` invariant
+ * ("onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device") outright
+ * rather than leaving it to a resolver.
+ *
+ * **The single agent is typed as both author and transmitter, deliberately.** US Core slices
+ * `Provenance.agent` on a `type` pattern into a `ProvenanceAuthor` slice and a `ProvenanceTransmitter`
+ * slice, both must-support and both optional. One synthetic source system authored this record and
+ * transmitted it, so one agent carries both participation codings: a `CodeableConcept` is a set of
+ * codings for exactly this reason, and the slicing is `open`. Splitting it into two agents would say
+ * two parties were involved, which is not what a self-contained synthetic fixture models.
+ *
+ * @module
+ */
+
+/** Options for {@link generateProvenance}. */
+interface GenerateProvenanceOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `target` reference this provenance is about (e.g. `"Patient/syn-patient-1"`). */
+    readonly target?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core `Provenance`, built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, target reference, and US Core posture. See {@link GenerateProvenanceOptions}.
+ * @returns The `Provenance` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateProvenance } from "@cosyte/synth/fhir";
+ * const provenance = generateProvenance({ seed: 19, target: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateProvenance(options?: GenerateProvenanceOptions): FhirComplex;
+
 /**
  * Synthetic FHIR R4 **`DiagnosticReport`** generation: the US Core DiagnosticReport Profile for
  * Laboratory Results Reporting. Built through `@cosyte/fhir`;
@@ -721,7 +763,44 @@ declare const US_CORE_PROFILE: Readonly<{
     readonly ALLERGY_INTOLERANCE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance";
     /** US Core Procedure. */
     readonly PROCEDURE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure";
+    /** US Core Provenance. */
+    readonly PROVENANCE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance";
 }>;
+/**
+ * The canonical prefix every US Core 6.1.0 resource profile's `url` shares. A profile's canonical is
+ * this prefix followed by its profile id.
+ *
+ * @example
+ * ```ts
+ * import { US_CORE_PROFILE_BASE } from "@cosyte/synth/fhir";
+ * `${US_CORE_PROFILE_BASE}us-core-provenance`;
+ * ```
+ */
+declare const US_CORE_PROFILE_BASE = "http://hl7.org/fhir/us/core/StructureDefinition/";
+/**
+ * The **adopted set**: the profile ids of every US Core 6.1.0 **resource profile** the implementation
+ * guide publishes, transcribed from the guide's own artifact index ("Structures: Resource Profiles").
+ * This is the closed set a profile-addressed request is resolved against, and it is *identifiers
+ * only*, never IG content, exactly like {@link US_CORE_PROFILE}.
+ *
+ * `45 CFR 170.215` adopts FHIR R4.0.1 and US Core STU 6.1.0, so this is the profile set a developer
+ * building to `45 CFR 170.315(g)(10)` addresses. It is **not** the count of
+ * `StructureDefinition-us-core-*.json` files in the guide's source tree: that directory also holds
+ * the guide's extension definitions and omits profiles the guide publishes.
+ *
+ * The guide's 10 **extension definitions** (`us-core-race`, `us-core-birthsex`, …) are deliberately
+ * absent: an extension is not a standalone artifact, so a request naming one is refused like any
+ * other name outside this set.
+ *
+ * @example
+ * ```ts
+ * import { US_CORE_ADOPTED_PROFILES } from "@cosyte/synth/fhir";
+ * US_CORE_ADOPTED_PROFILES.includes("us-core-provenance"); // true
+ * ```
+ */
+declare const US_CORE_ADOPTED_PROFILES: readonly ["head-occipital-frontal-circumference-percentile", "pediatric-bmi-for-age", "pediatric-weight-for-height", "us-core-allergyintolerance", "us-core-blood-pressure", "us-core-bmi", "us-core-body-height", "us-core-body-temperature", "us-core-body-weight", "us-core-careplan", "us-core-careteam", "us-core-condition-encounter-diagnosis", "us-core-condition-problems-health-concerns", "us-core-coverage", "us-core-diagnosticreport-lab", "us-core-diagnosticreport-note", "us-core-documentreference", "us-core-encounter", "us-core-goal", "us-core-head-circumference", "us-core-heart-rate", "us-core-immunization", "us-core-implantable-device", "us-core-location", "us-core-medication", "us-core-medicationdispense", "us-core-medicationrequest", "us-core-observation-clinical-result", "us-core-observation-lab", "us-core-observation-occupation", "us-core-observation-pregnancyintent", "us-core-observation-pregnancystatus", "us-core-observation-screening-assessment", "us-core-observation-sexual-orientation", "us-core-organization", "us-core-patient", "us-core-practitioner", "us-core-practitionerrole", "us-core-procedure", "us-core-provenance", "us-core-pulse-oximetry", "us-core-questionnaireresponse", "us-core-relatedperson", "us-core-respiratory-rate", "us-core-servicerequest", "us-core-simple-observation", "us-core-smokingstatus", "us-core-specimen", "us-core-vital-signs"];
+/** One profile id from the adopted US Core 6.1.0 set. Erased at run time, so it is resolved, not trusted. */
+type UsCoreProfileId = (typeof US_CORE_ADOPTED_PROFILES)[number];
 /** The US Core `us-core-race` extension URL (a Patient must-support extension). */
 declare const US_CORE_RACE_EXTENSION = "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race";
 /** The US Core `us-core-ethnicity` extension URL (a Patient must-support extension). */
@@ -765,8 +844,90 @@ declare const SYSTEM: Readonly<{
     readonly ALLERGY_CLINICAL: "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical";
     /** HL7 Terminology `allergyintolerance-verification`, `AllergyIntolerance.verificationStatus`. */
     readonly ALLERGY_VERIFICATION: "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification";
+    /** HL7 Terminology `provenance-participant-type`, `Provenance.agent.type` (`author`). */
+    readonly PROVENANCE_PARTICIPANT_TYPE: "http://terminology.hl7.org/CodeSystem/provenance-participant-type";
+    /** US Core `us-core-provenance-participant-type`, `Provenance.agent.type` (`transmitter`). */
+    readonly US_CORE_PROVENANCE_PARTICIPANT_TYPE: "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type";
 }>;
 /** A US Core profile canonical URL. */
 type UsCoreProfileUrl = (typeof US_CORE_PROFILE)[keyof typeof US_CORE_PROFILE];
 
-export { type BuildCompositionInput, type CompositionSection, type FhirBundleType, type FhirCorpusOptions, type FhirPatientIdentity, type FhirResourceKind, type GenerateAllergyIntoleranceOptions, type GenerateBundleOptions, type GenerateConditionOptions, type GenerateDiagnosticReportOptions, type GenerateEncounterOptions, type GenerateImmunizationOptions, type GenerateMedicationRequestOptions, type GenerateObservationOptions, type GeneratePatientOptions, type GenerateProcedureOptions, type Prop, type RoundTripOptions, type RoundTripResult, SYSTEM, US_CORE_BIRTHSEX_EXTENSION, US_CORE_ETHNICITY_EXTENSION, US_CORE_PROFILE, US_CORE_RACE_EXTENSION, type UsCoreProfileUrl, bool, buildComposition, codeableConcept, coding, dec, fhirCorpus, fhirPatientIdentity, generateAllergyIntolerance, generateBundle, generateCondition, generateDiagnosticReport, generateEncounter, generateImmunization, generateMedicationRequest, generateObservationLab, generatePatient, generateProcedure, generateVitalSign, meta, mrnIdentifier, narrative, prop, reference, roundTrip, str, toFhirDate };
+/**
+ * **Profile-addressed generation, and the coverage surface it is resolved against.**
+ *
+ * A consumer building to `45 CFR 170.315(g)(10)` does not think in this package's generator names: it
+ * thinks in US Core 6.1.0 profile names, because that is what the regulation adopts. So this module
+ * offers exactly two things, and the pair is the whole contract:
+ *
+ * 1. {@link usCoreCoverage} reports one entry for **every** profile the adopted guide publishes, each
+ *    carrying its canonical URL and whether this build generates it. "The guide does not publish this"
+ *    and "we do not generate this yet" are different answers, and without a published closed set
+ *    nothing could tell them apart.
+ * 2. {@link generateUsCoreProfile} takes a profile name and either returns an artifact claiming that
+ *    profile, or **fails closed before anything is generated**, on the `resolveKind` discipline every
+ *    other caller-supplied selector here already holds. Two distinct codes: `SYNTH_UNSUPPORTED_KIND`
+ *    for a name outside the adopted set (an extension definition, a typo, a blank, a non-string), and
+ *    `SYNTH_PROFILE_NOT_GENERATED` for an adopted profile this build does not yet cover. Neither
+ *    quotes the requested name, so no caller string reaches a diagnostic surface.
+ *
+ * **Coverage is derived, never declared twice.** The `generated` flag is read off the generator map
+ * below, so a profile cannot be advertised as covered without a generator behind it, and the
+ * conformance suite additionally requires a committed `StructureDefinition` for every profile this
+ * surface reports as generated.
+ *
+ * No IG content is bundled: what is encoded here is a set of identifiers, exactly like `./us-core.js`.
+ *
+ * @module
+ */
+
+/** One adopted US Core 6.1.0 resource profile, and whether this build generates a fixture for it. */
+interface UsCoreProfileCoverage {
+    /** The profile id, as the guide's artifact index spells it. */
+    readonly profile: UsCoreProfileId;
+    /** The profile's canonical URL: the value a generated artifact's `meta.profile` claims. */
+    readonly canonical: string;
+    /** `true` when {@link generateUsCoreProfile} returns an artifact for this profile. */
+    readonly generated: boolean;
+}
+/**
+ * Report this build's US Core 6.1.0 coverage: one entry per **adopted** resource profile, in the
+ * guide's own order, each carrying its canonical URL and whether this build generates it.
+ *
+ * The report is exhaustive over the adopted set by construction, so a profile the guide publishes and
+ * this build does not generate is *named* here rather than being indistinguishable from a typo.
+ *
+ * @returns One frozen {@link UsCoreProfileCoverage} entry per adopted profile.
+ * @example
+ * ```ts
+ * import { usCoreCoverage } from "@cosyte/synth/fhir";
+ * usCoreCoverage().filter((entry) => !entry.generated).map((entry) => entry.profile);
+ * ```
+ */
+declare function usCoreCoverage(): readonly UsCoreProfileCoverage[];
+/** Options for {@link generateUsCoreProfile}. */
+interface GenerateUsCoreProfileOptions {
+    /**
+     * The US Core 6.1.0 profile id to generate. Resolved against the adopted set **before** anything is
+     * generated; there is deliberately no default, so a blank or absent name refuses rather than
+     * falling through to some other profile's artifact.
+     */
+    readonly profile: UsCoreProfileId;
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+}
+/**
+ * Generate a fixture **by US Core 6.1.0 profile name**, or fail closed before anything is generated.
+ *
+ * @param options - The profile name and seed. See {@link GenerateUsCoreProfileOptions}.
+ * @returns The resource model (a `FhirComplex`) claiming that profile in `meta.profile`.
+ * @throws SynthError `SYNTH_UNSUPPORTED_KIND` when the name is not in the adopted set.
+ * @throws SynthError `SYNTH_PROFILE_NOT_GENERATED` when the profile is adopted and not generated here.
+ * @example
+ * ```ts
+ * import { generateUsCoreProfile } from "@cosyte/synth/fhir";
+ * const provenance = generateUsCoreProfile({ profile: "us-core-provenance", seed: 42 });
+ * ```
+ */
+declare function generateUsCoreProfile(options: GenerateUsCoreProfileOptions): FhirComplex;
+
+export { type BuildCompositionInput, type CompositionSection, type FhirBundleType, type FhirCorpusOptions, type FhirPatientIdentity, type FhirResourceKind, type GenerateAllergyIntoleranceOptions, type GenerateBundleOptions, type GenerateConditionOptions, type GenerateDiagnosticReportOptions, type GenerateEncounterOptions, type GenerateImmunizationOptions, type GenerateMedicationRequestOptions, type GenerateObservationOptions, type GeneratePatientOptions, type GenerateProcedureOptions, type GenerateProvenanceOptions, type GenerateUsCoreProfileOptions, type Prop, type RoundTripOptions, type RoundTripResult, SYSTEM, US_CORE_ADOPTED_PROFILES, US_CORE_BIRTHSEX_EXTENSION, US_CORE_ETHNICITY_EXTENSION, US_CORE_PROFILE, US_CORE_PROFILE_BASE, US_CORE_RACE_EXTENSION, type UsCoreProfileCoverage, type UsCoreProfileId, type UsCoreProfileUrl, bool, buildComposition, codeableConcept, coding, dec, fhirCorpus, fhirPatientIdentity, generateAllergyIntolerance, generateBundle, generateCondition, generateDiagnosticReport, generateEncounter, generateImmunization, generateMedicationRequest, generateObservationLab, generatePatient, generateProcedure, generateProvenance, generateUsCoreProfile, generateVitalSign, meta, mrnIdentifier, narrative, prop, reference, roundTrip, str, toFhirDate, usCoreCoverage };

package/dist/fhir/index.mjs

@@ -1,4 +1,4 @@
-import { primitive, decimal, complex, list, serializeResource, parseResource, validateResource } from '@cosyte/fhir';
+import { list, complex, primitive, decimal, serializeResource, parseResource, validateResource } from '@cosyte/fhir';
 
 // src/fhir/patient.ts
 
@@ -43,7 +43,16 @@ var SYNTH_FATAL_CODES = {
    * see `resolveKind`: a selector union is erased at run time, and a selector that falls through
    * either mislabels the fixture or hands the value to a peer builder that quotes it back.
    */
-  SYNTH_UNSUPPORTED_KIND: "SYNTH_UNSUPPORTED_KIND"
+  SYNTH_UNSUPPORTED_KIND: "SYNTH_UNSUPPORTED_KIND",
+  /**
+   * A requested profile IS published by the adopted implementation guide, and this build does not
+   * generate it. Deliberately distinct from `SYNTH_UNSUPPORTED_KIND`, which says the name is not in
+   * the adopted set at all: "the guide does not publish this" and "we do not generate this yet" are
+   * different answers, and a caller building to a regulatory profile set has to be able to tell them
+   * apart without matching message text. Fatal, and raised **before** anything is generated: a
+   * mislabelled artifact is worse than no artifact.
+   */
+  SYNTH_PROFILE_NOT_GENERATED: "SYNTH_PROFILE_NOT_GENERATED"
 };
 var SYNTH_FATAL_MESSAGES = Object.freeze({
   SYNTH_UNSUPPORTED_FORMAT: "The requested format is not generable by this build. A generator has no byte fallback: it builds through a parser's own serializer or it refuses.",
@@ -55,7 +64,8 @@ var SYNTH_FATAL_MESSAGES = Object.freeze({
   SYNTH_INVALID_RANGE: "An integer range was requested with its maximum below its minimum.",
   SYNTH_EMPTY_POOL: "A value was drawn from an empty pool.",
   SYNTH_INVALID_PROFILE: "defineSynthProfile requires a non-empty string name.",
-  SYNTH_UNSUPPORTED_KIND: "The requested kind, document type, corpus mix entry, variant or profile is not one this generator supports. The supported set is the exported union for that option."
+  SYNTH_UNSUPPORTED_KIND: "The requested kind, document type, corpus mix entry, variant or profile is not one this generator supports. The supported set is the exported union for that option.",
+  SYNTH_PROFILE_NOT_GENERATED: "The requested profile is published by the adopted implementation guide, and this build does not generate it. The coverage surface reports, per adopted profile, whether it is generated."
 });
 var SynthError = class extends Error {
   /** The stable fatal code. */
@@ -112,7 +122,7 @@ function createRng(seed) {
 var SYNTHETIC_ASSIGNING_AUTHORITY = Object.freeze({
   /** The human-readable assigning-authority namespace id (HL7 HD.1). */
   namespaceId: "COSYTE-SYNTH",
-  /** The universal id, an OID under HL7's example arc `2.16.840.1.113883.19` (HD.2). */
+  /** The universal id, an OID this package chose under the root `2.16.840.1.113883.19` (HD.2). */
   universalId: "2.16.840.1.113883.19.999",
   /** The universal id type (HD.3). */
   universalIdType: "ISO"
@@ -131,6 +141,18 @@ var TEST_NET_V4_PREFIXES = Object.freeze([
   // TEST-NET-3
 ]);
 var DOC_V6_PREFIX = "2001:db8";
+var ITIN_GROUP_RANGES = Object.freeze([
+  Object.freeze({ min: 50, max: 65 }),
+  Object.freeze({ min: 70, max: 88 }),
+  Object.freeze({ min: 90, max: 92 }),
+  Object.freeze({ min: 94, max: 99 })
+]);
+var ITIN_EXCLUDED_GROUPS = Object.freeze([89, 93]);
+var SSN_SYNTHETIC_GROUPS = Object.freeze(
+  Array.from({ length: 100 }, (_unused, group) => group).filter(
+    (group) => !ITIN_GROUP_RANGES.some((range) => group >= range.min && group <= range.max) && !ITIN_EXCLUDED_GROUPS.includes(group)
+  ).map((group) => String(group).padStart(2, "0"))
+);
 var NPI_LUHN_PREFIX = "80840";
 function luhnMod10(digits) {
   let sum = 0;
@@ -239,10 +261,10 @@ var SYNTHETIC_CITY_NAMES = Object.freeze([
 // src/safe/providers.ts
 function ssn(rng, block = "never-issued") {
   if (block === "advertising") {
-    return `987-65-432${String(rng.int(0, 9))}`;
+    return `987-00-432${String(rng.int(0, 9))}`;
   }
   const area = rng.int(900, 999);
-  const group = rng.digits(2);
+  const group = rng.pick(SSN_SYNTHETIC_GROUPS);
   const serial = rng.digits(4);
   return `${String(area)}-${group}-${serial}`;
 }
@@ -401,8 +423,62 @@ var US_CORE_PROFILE = Object.freeze({
   /** US Core AllergyIntolerance. */
   ALLERGY_INTOLERANCE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance",
   /** US Core Procedure. */
-  PROCEDURE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
+  PROCEDURE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure",
+  /** US Core Provenance. */
+  PROVENANCE: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
 });
+var US_CORE_PROFILE_BASE = "http://hl7.org/fhir/us/core/StructureDefinition/";
+var US_CORE_ADOPTED_PROFILES = Object.freeze([
+  "head-occipital-frontal-circumference-percentile",
+  "pediatric-bmi-for-age",
+  "pediatric-weight-for-height",
+  "us-core-allergyintolerance",
+  "us-core-blood-pressure",
+  "us-core-bmi",
+  "us-core-body-height",
+  "us-core-body-temperature",
+  "us-core-body-weight",
+  "us-core-careplan",
+  "us-core-careteam",
+  "us-core-condition-encounter-diagnosis",
+  "us-core-condition-problems-health-concerns",
+  "us-core-coverage",
+  "us-core-diagnosticreport-lab",
+  "us-core-diagnosticreport-note",
+  "us-core-documentreference",
+  "us-core-encounter",
+  "us-core-goal",
+  "us-core-head-circumference",
+  "us-core-heart-rate",
+  "us-core-immunization",
+  "us-core-implantable-device",
+  "us-core-location",
+  "us-core-medication",
+  "us-core-medicationdispense",
+  "us-core-medicationrequest",
+  "us-core-observation-clinical-result",
+  "us-core-observation-lab",
+  "us-core-observation-occupation",
+  "us-core-observation-pregnancyintent",
+  "us-core-observation-pregnancystatus",
+  "us-core-observation-screening-assessment",
+  "us-core-observation-sexual-orientation",
+  "us-core-organization",
+  "us-core-patient",
+  "us-core-practitioner",
+  "us-core-practitionerrole",
+  "us-core-procedure",
+  "us-core-provenance",
+  "us-core-pulse-oximetry",
+  "us-core-questionnaireresponse",
+  "us-core-relatedperson",
+  "us-core-respiratory-rate",
+  "us-core-servicerequest",
+  "us-core-simple-observation",
+  "us-core-smokingstatus",
+  "us-core-specimen",
+  "us-core-vital-signs"
+]);
 var US_CORE_RACE_EXTENSION = "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race";
 var US_CORE_ETHNICITY_EXTENSION = "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity";
 var US_CORE_BIRTHSEX_EXTENSION = "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex";
@@ -438,7 +514,11 @@ var SYSTEM = Object.freeze({
   /** HL7 Terminology `allergyintolerance-clinical`, `AllergyIntolerance.clinicalStatus`. */
   ALLERGY_CLINICAL: "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
   /** HL7 Terminology `allergyintolerance-verification`, `AllergyIntolerance.verificationStatus`. */
-  ALLERGY_VERIFICATION: "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification"
+  ALLERGY_VERIFICATION: "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
+  /** HL7 Terminology `provenance-participant-type`, `Provenance.agent.type` (`author`). */
+  PROVENANCE_PARTICIPANT_TYPE: "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
+  /** US Core `us-core-provenance-participant-type`, `Provenance.agent.type` (`transmitter`). */
+  US_CORE_PROVENANCE_PARTICIPANT_TYPE: "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type"
 });
 
 // src/fhir/builder.ts
@@ -1125,6 +1205,53 @@ function generateProcedure(options = {}) {
   props.push(prop("performedDateTime", str(`${performed}T10:00:00Z`)));
   return complex(props);
 }
+function generateProvenance(options = {}) {
+  const { seed = 0, target = "Patient/syn-patient-1", usCore = true } = options;
+  const rng = createRng(seed);
+  const recorded = toFhirDate(safe.dateYmd(rng, 2018, 2024));
+  const practitioner = `Practitioner/syn-practitioner-${rng.digits(8)}`;
+  const organization = `Organization/syn-org-${rng.digits(8)}`;
+  const props = [
+    prop("resourceType", str("Provenance")),
+    prop("id", str(`syn-prov-${rng.digits(8)}`))
+  ];
+  if (usCore) props.push(prop("meta", meta([US_CORE_PROFILE.PROVENANCE])));
+  props.push(prop("text", narrative("Synthetic provenance for a generated fixture.")));
+  props.push(prop("target", list([reference(target)])));
+  props.push(prop("recorded", str(`${recorded}T10:00:00Z`)));
+  props.push(
+    prop(
+      "agent",
+      list([
+        complex([
+          prop(
+            "type",
+            complex([
+              prop(
+                "coding",
+                list([
+                  coding({
+                    system: SYSTEM.PROVENANCE_PARTICIPANT_TYPE,
+                    code: "author",
+                    display: "Author"
+                  }),
+                  coding({
+                    system: SYSTEM.US_CORE_PROVENANCE_PARTICIPANT_TYPE,
+                    code: "transmitter",
+                    display: "Transmitter"
+                  })
+                ])
+              )
+            ])
+          ),
+          prop("who", reference(practitioner)),
+          prop("onBehalfOf", reference(organization))
+        ])
+      ])
+    )
+  );
+  return complex(props);
+}
 function generateDiagnosticReport(options = {}) {
   const { seed = 0, subject = "Patient/syn-patient-1", results = [], usCore = true } = options;
   const rng = createRng(seed);
@@ -1452,6 +1579,41 @@ function fhirCorpus(options) {
   return makeCorpus(seed, artifacts);
 }
 
-export { EXAMPLE_ALLERGENS, EXAMPLE_ALLERGY_MANIFESTATIONS, EXAMPLE_CONDITIONS, EXAMPLE_DIAGNOSTIC_REPORTS, EXAMPLE_ENCOUNTER_CLASSES, EXAMPLE_ENCOUNTER_TYPES, EXAMPLE_ETHNICITY_CATEGORIES, EXAMPLE_LAB_OBSERVATIONS, EXAMPLE_MEDICATIONS, EXAMPLE_PROCEDURES, EXAMPLE_RACE_CATEGORIES, EXAMPLE_VACCINES, EXAMPLE_VITAL_SIGNS, SYSTEM, US_CORE_BIRTHSEX_EXTENSION, US_CORE_ETHNICITY_EXTENSION, US_CORE_PROFILE, US_CORE_RACE_EXTENSION, bool, buildComposition, codeableConcept, coding, dec, fhirCorpus, fhirPatientIdentity, generateAllergyIntolerance, generateBundle, generateCondition, generateDiagnosticReport, generateEncounter, generateImmunization, generateMedicationRequest, generateObservationLab, generatePatient, generateProcedure, generateVitalSign, meta, mrnIdentifier, narrative, prop, reference, roundTrip, str, toFhirDate };
+// src/fhir/coverage.ts
+var GENERATORS = Object.freeze({
+  "us-core-allergyintolerance": (seed) => generateAllergyIntolerance({ seed }),
+  "us-core-condition-problems-health-concerns": (seed) => generateCondition({ seed }),
+  "us-core-diagnosticreport-lab": (seed) => generateDiagnosticReport({ seed }),
+  "us-core-encounter": (seed) => generateEncounter({ seed }),
+  "us-core-immunization": (seed) => generateImmunization({ seed }),
+  "us-core-medicationrequest": (seed) => generateMedicationRequest({ seed }),
+  "us-core-observation-lab": (seed) => generateObservationLab({ seed }),
+  "us-core-patient": (seed) => generatePatient({ seed, profile: "us-core" }),
+  "us-core-procedure": (seed) => generateProcedure({ seed }),
+  "us-core-provenance": (seed) => generateProvenance({ seed }),
+  "us-core-vital-signs": (seed) => generateVitalSign({ seed })
+});
+var COVERAGE = Object.freeze(
+  US_CORE_ADOPTED_PROFILES.map(
+    (profile) => Object.freeze({
+      profile,
+      canonical: `${US_CORE_PROFILE_BASE}${profile}`,
+      generated: GENERATORS[profile] !== void 0
+    })
+  )
+);
+function usCoreCoverage() {
+  return COVERAGE;
+}
+function generateUsCoreProfile(options) {
+  const profile = resolveKind(US_CORE_ADOPTED_PROFILES, options.profile);
+  const generate = GENERATORS[profile];
+  if (generate === void 0) {
+    throw new SynthError(SYNTH_FATAL_CODES.SYNTH_PROFILE_NOT_GENERATED);
+  }
+  return generate(options.seed ?? 0);
+}
+
+export { EXAMPLE_ALLERGENS, EXAMPLE_ALLERGY_MANIFESTATIONS, EXAMPLE_CONDITIONS, EXAMPLE_DIAGNOSTIC_REPORTS, EXAMPLE_ENCOUNTER_CLASSES, EXAMPLE_ENCOUNTER_TYPES, EXAMPLE_ETHNICITY_CATEGORIES, EXAMPLE_LAB_OBSERVATIONS, EXAMPLE_MEDICATIONS, EXAMPLE_PROCEDURES, EXAMPLE_RACE_CATEGORIES, EXAMPLE_VACCINES, EXAMPLE_VITAL_SIGNS, SYSTEM, US_CORE_ADOPTED_PROFILES, US_CORE_BIRTHSEX_EXTENSION, US_CORE_ETHNICITY_EXTENSION, US_CORE_PROFILE, US_CORE_PROFILE_BASE, US_CORE_RACE_EXTENSION, bool, buildComposition, codeableConcept, coding, dec, fhirCorpus, fhirPatientIdentity, generateAllergyIntolerance, generateBundle, generateCondition, generateDiagnosticReport, generateEncounter, generateImmunization, generateMedicationRequest, generateObservationLab, generatePatient, generateProcedure, generateProvenance, generateUsCoreProfile, generateVitalSign, meta, mrnIdentifier, narrative, prop, reference, roundTrip, str, toFhirDate, usCoreCoverage };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map