@cosyte/synth 0.0.1

package/dist/fhir/index.d.cts

@@ -0,0 +1,772 @@
+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-OLz3zAc-.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-DeXcnCSK.cjs';
+
+/**
+ * Synthetic FHIR R4 **`Patient`** generation — the anchor of the US Core clinical spine. Built through
+ * `@cosyte/fhir`'s model constructors, every identity field drawn from the
+ * synthetic-safety providers. In `us-core` mode the resource claims US Core Patient via
+ * `meta.profile`, satisfies its required elements (`identifier` + `system` + `value`, `name`, `gender`),
+ * and carries the must-support race / ethnicity / birthsex extensions.
+ *
+ * @module
+ */
+
+/** Options for {@link generatePatient}. */
+interface GeneratePatientOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /**
+     * The profile posture. `"base"` (default) emits a spec-clean base-R4 `Patient`; `"us-core"` adds the
+     * US Core `meta.profile` and the race/ethnicity/birthsex must-support extensions (the required
+     * elements — identifier/name/gender — are always present).
+     */
+    readonly profile?: "base" | "us-core";
+}
+/**
+ * Generate a spec-clean synthetic FHIR R4 `Patient` (base or US Core), built through `@cosyte/fhir`.
+ *
+ * @param options - Seed and profile posture. See {@link GeneratePatientOptions}.
+ * @returns The `Patient` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generatePatient } from "@cosyte/synth/fhir";
+ * import { serializeResource } from "@cosyte/fhir";
+ * const patient = generatePatient({ seed: 42, profile: "us-core" });
+ * serializeResource(patient);
+ * ```
+ */
+declare function generatePatient(options?: GeneratePatientOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`Condition`** generation — a US Core "Problems and Health Concerns" problem-list
+ * item. Built through `@cosyte/fhir`; the `code` comes from the license-clean SNOMED
+ * example pool, the `subject` from a supplied or derived synthetic Patient reference.
+ *
+ * @module
+ */
+
+/** Options for {@link generateCondition}. */
+interface GenerateConditionOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `subject` reference (e.g. `"Patient/syn-patient-1"` or a `urn:uuid:` fullUrl). */
+    readonly subject?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core `Condition` (problem-list item), built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, subject reference, and US Core posture. See {@link GenerateConditionOptions}.
+ * @returns The `Condition` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateCondition } from "@cosyte/synth/fhir";
+ * const condition = generateCondition({ seed: 7, subject: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateCondition(options?: GenerateConditionOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`Observation`** generation — US Core Laboratory Result and US Core Vital Signs. Built
+ * through `@cosyte/fhir`; `code` and the measured `valueQuantity` come from
+ * the license-clean LOINC/UCUM example pool, `subject` from a supplied or derived Patient reference.
+ * The measured value is drawn from the seeded generator within a structurally-sane band — it implies no
+ * real measurement.
+ *
+ * @module
+ */
+
+/** Options for {@link generateObservationLab} / {@link generateVitalSign}. */
+interface GenerateObservationOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `subject` reference (e.g. `"Patient/syn-patient-1"` or a `urn:uuid:` fullUrl). */
+    readonly subject?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core **Laboratory Result** `Observation`.
+ *
+ * @param options - Seed, subject reference, US Core posture. See {@link GenerateObservationOptions}.
+ * @returns The `Observation` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateObservationLab } from "@cosyte/synth/fhir";
+ * const obs = generateObservationLab({ seed: 3, subject: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateObservationLab(options?: GenerateObservationOptions): FhirComplex;
+/**
+ * Generate a spec-clean synthetic US Core **Vital Signs** `Observation` (a single-value vital such as
+ * heart rate or body weight; `effectiveDateTime` is required by the vital-signs profile).
+ *
+ * @param options - Seed, subject reference, US Core posture. See {@link GenerateObservationOptions}.
+ * @returns The `Observation` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateVitalSign } from "@cosyte/synth/fhir";
+ * const vs = generateVitalSign({ seed: 5, subject: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateVitalSign(options?: GenerateObservationOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`MedicationRequest`** generation — a US Core MedicationRequest with an inline
+ * `medicationCodeableConcept`. Built through `@cosyte/fhir`; the medication comes
+ * from the license-clean RxNorm example pool. US Core invariant `us-core-21` requires a `requester`
+ * whenever `intent = order`, so a synthetic requester reference is always emitted.
+ *
+ * @module
+ */
+
+/** Options for {@link generateMedicationRequest}. */
+interface GenerateMedicationRequestOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `subject` reference (e.g. `"Patient/syn-patient-1"` or a `urn:uuid:` fullUrl). */
+    readonly subject?: string;
+    /** The `requester` reference. Defaults to a synthetic `Practitioner` reference. */
+    readonly requester?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core `MedicationRequest`, built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, subject/requester references, US Core posture.
+ * @returns The `MedicationRequest` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateMedicationRequest } from "@cosyte/synth/fhir";
+ * const mr = generateMedicationRequest({ seed: 9, subject: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateMedicationRequest(options?: GenerateMedicationRequestOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`Encounter`** generation — a US Core Encounter. Built through `@cosyte/fhir`'s model
+ * constructors; `class` and `type` come from the
+ * license-clean v3-ActCode / SNOMED example pools, `subject` from a supplied or derived synthetic
+ * Patient reference. The required elements (`status`, `class`, `type`, `subject`) are always present.
+ *
+ * @module
+ */
+
+/** Options for {@link generateEncounter}. */
+interface GenerateEncounterOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `subject` reference (e.g. `"Patient/syn-patient-1"` or a `urn:uuid:` fullUrl). */
+    readonly subject?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core `Encounter`, built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, subject reference, and US Core posture. See {@link GenerateEncounterOptions}.
+ * @returns The `Encounter` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateEncounter } from "@cosyte/synth/fhir";
+ * const encounter = generateEncounter({ seed: 11, subject: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateEncounter(options?: GenerateEncounterOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`Immunization`** generation — a US Core Immunization. Built through `@cosyte/fhir`;
+ * `vaccineCode` comes from the license-clean CVX example
+ * pool, `patient` from a supplied or derived synthetic Patient reference. The required elements
+ * (`status`, `vaccineCode`, `patient`, `occurrenceDateTime`) are always present.
+ *
+ * @module
+ */
+
+/** Options for {@link generateImmunization}. */
+interface GenerateImmunizationOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `patient` reference (e.g. `"Patient/syn-patient-1"` or a `urn:uuid:` fullUrl). */
+    readonly patient?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core `Immunization`, built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, patient reference, and US Core posture. See {@link GenerateImmunizationOptions}.
+ * @returns The `Immunization` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateImmunization } from "@cosyte/synth/fhir";
+ * const imm = generateImmunization({ seed: 13, patient: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateImmunization(options?: GenerateImmunizationOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`AllergyIntolerance`** generation — a US Core AllergyIntolerance. Built through
+ * `@cosyte/fhir`; the allergen `code` and reaction
+ * `manifestation` come from the license-clean RxNorm/SNOMED example pools, `patient` from a supplied or
+ * derived synthetic Patient reference. `clinicalStatus` + `verificationStatus` are emitted together so
+ * the base `ait-1`/`ait-2` invariants hold; the required `code` and `patient` are always present.
+ *
+ * @module
+ */
+
+/** Options for {@link generateAllergyIntolerance}. */
+interface GenerateAllergyIntoleranceOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `patient` reference (e.g. `"Patient/syn-patient-1"` or a `urn:uuid:` fullUrl). */
+    readonly patient?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core `AllergyIntolerance`, built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, patient reference, and US Core posture. See
+ *   {@link GenerateAllergyIntoleranceOptions}.
+ * @returns The `AllergyIntolerance` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateAllergyIntolerance } from "@cosyte/synth/fhir";
+ * const allergy = generateAllergyIntolerance({ seed: 15, patient: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateAllergyIntolerance(options?: GenerateAllergyIntoleranceOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`Procedure`** generation — a US Core Procedure. Built through `@cosyte/fhir`; the
+ * `code` comes from the license-clean SNOMED procedure
+ * example pool (never CPT), `subject` from a supplied or derived synthetic Patient
+ * reference. The required elements (`status`, `code`, `subject`) plus the must-support
+ * `performedDateTime` are always present.
+ *
+ * @module
+ */
+
+/** Options for {@link generateProcedure}. */
+interface GenerateProcedureOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `subject` reference (e.g. `"Patient/syn-patient-1"` or a `urn:uuid:` fullUrl). */
+    readonly subject?: string;
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core `Procedure`, built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, subject reference, and US Core posture. See {@link GenerateProcedureOptions}.
+ * @returns The `Procedure` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateProcedure } from "@cosyte/synth/fhir";
+ * const procedure = generateProcedure({ seed: 17, subject: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateProcedure(options?: GenerateProcedureOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`DiagnosticReport`** generation — the US Core DiagnosticReport Profile for
+ * Laboratory Results Reporting. Built through `@cosyte/fhir`;
+ * the report `code` comes from the license-clean LOINC example pool, `subject` from a supplied or
+ * derived synthetic Patient reference. The required `category` carries the profile's mandated `LAB`
+ * slice, and `effectiveDateTime` + `issued` are always present so the `us-core-8`/`us-core-9`
+ * invariants hold for a `final` report. Optional `result` references wire the report to its
+ * `Observation`s (used by the `document` Bundle).
+ *
+ * @module
+ */
+
+/** Options for {@link generateDiagnosticReport}. */
+interface GenerateDiagnosticReportOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The `subject` reference (e.g. `"Patient/syn-patient-1"` or a `urn:uuid:` fullUrl). */
+    readonly subject?: string;
+    /** `result` references to the report's `Observation`s (empty ⇒ omitted). */
+    readonly results?: readonly string[];
+    /** Whether to claim US Core via `meta.profile`. Defaults to `true`. */
+    readonly usCore?: boolean;
+}
+/**
+ * Generate a spec-clean synthetic US Core Laboratory `DiagnosticReport`, built through `@cosyte/fhir`.
+ *
+ * @param options - Seed, subject, result references, US Core posture. See
+ *   {@link GenerateDiagnosticReportOptions}.
+ * @returns The `DiagnosticReport` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateDiagnosticReport } from "@cosyte/synth/fhir";
+ * const report = generateDiagnosticReport({ seed: 19, subject: "Patient/syn-patient-1" });
+ * ```
+ */
+declare function generateDiagnosticReport(options?: GenerateDiagnosticReportOptions): FhirComplex;
+
+/**
+ * Synthetic FHIR R4 **`Bundle`** generation — a self-contained `collection`,
+ * `transaction`, or `document` Bundle assembling a synthetic US Core `Patient` and its full clinical
+ * spine (`Condition`, lab + vital-sign `Observation`s, `MedicationRequest`, `Encounter`,
+ * `Immunization`, `AllergyIntolerance`, `Procedure`, `DiagnosticReport`), wired by `urn:uuid:`
+ * `fullUrl`s so every intra-bundle reference resolves. Built through `@cosyte/fhir`. The `document`
+ * shape prepends the FHIR-mandated `Composition` (invariant `bdl-11`) and a synthetic
+ * `Organization` author/custodian, and carries the required `identifier` + `timestamp` (`bdl-9`/`bdl-10`).
+ *
+ * @module
+ */
+
+/** The Bundle shapes `@cosyte/synth` supports. */
+type FhirBundleType = "collection" | "transaction" | "document";
+/** Options for {@link generateBundle}. */
+interface GenerateBundleOptions {
+    /** The seed (deterministic). Defaults to `0`. */
+    readonly seed?: number;
+    /** The Bundle shape. Defaults to `"collection"`. */
+    readonly type?: FhirBundleType;
+}
+/**
+ * Generate a spec-clean synthetic FHIR `Bundle` (`collection`, `transaction`, or `document`) built
+ * through `@cosyte/fhir`, containing a US Core `Patient` and its full clinical spine wired by
+ * `urn:uuid:` references so every reference resolves in-bundle.
+ *
+ * @param options - Seed and Bundle shape. See {@link GenerateBundleOptions}.
+ * @returns The `Bundle` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { generateBundle } from "@cosyte/synth/fhir";
+ * const bundle = generateBundle({ seed: 42, type: "document" });
+ * ```
+ */
+declare function generateBundle(options?: GenerateBundleOptions): FhirComplex;
+/** A FHIR resource kind the {@link fhirCorpus} can generate. */
+type FhirResourceKind = "Patient" | "USCorePatient" | "Condition" | "ObservationLab" | "VitalSign" | "MedicationRequest" | "Encounter" | "Immunization" | "AllergyIntolerance" | "Procedure" | "DiagnosticReport" | "Bundle" | "DocumentBundle";
+/** Options for {@link fhirCorpus}. */
+interface FhirCorpusOptions {
+    /** The seed for the whole corpus (deterministic). */
+    readonly seed: number;
+    /** How many resources to generate. Defaults to `1`. */
+    readonly count?: number;
+    /** The resource kinds to cycle through. Defaults to the full US Core clinical spine + a Bundle. */
+    readonly mix?: readonly FhirResourceKind[];
+}
+/**
+ * Build a reproducible {@link Corpus} of spec-clean FHIR resources across the supported kinds. Each
+ * resource is generated from a distinct sub-seed derived from the corpus seed and round-tripped through
+ * `@cosyte/fhir`; the per-artifact `warnings` record the validator's non-informational findings (empty
+ * ⇒ spec-clean, no US Core profiles supplied). Pass US Core `StructureDefinition`s to a per-resource
+ * {@link roundTrip} call to additionally assert profile conformance (BYO — none is bundled).
+ *
+ * @param options - Seed, count, and the resource mix. See {@link FhirCorpusOptions}.
+ * @returns A deep-frozen {@link Corpus}.
+ * @example
+ * ```ts
+ * import { fhirCorpus } from "@cosyte/synth/fhir";
+ * const corpus = fhirCorpus({ seed: 42, count: 6 });
+ * corpus.artifacts.every((a) => a.warnings.length === 0); // spec-clean (structural)
+ * ```
+ */
+declare function fhirCorpus(options: FhirCorpusOptions): Corpus;
+
+/**
+ * Synthetic FHIR R4 **`Composition`** generation — the mandatory first resource of a `document` Bundle
+ * (FHIR invariant `bdl-11`), built through `@cosyte/fhir`.
+ * A Composition is a base-R4 resource (US Core 6.1.0 defines no Composition profile), so it is grounded
+ * against base FHIR R4; every reference it carries (`subject`, `author`, `custodian`, section `entry`s)
+ * is an in-bundle `urn:uuid:` fullUrl so the document is self-contained and its references resolve.
+ *
+ * @module
+ */
+
+/** A document section: a LOINC section code, a human title, and the entry references it summarizes. */
+interface CompositionSection {
+    /** The LOINC section code. */
+    readonly code: string;
+    /** The section's human title / display. */
+    readonly title: string;
+    /** In-bundle `urn:uuid:` references to the resources the section summarizes. */
+    readonly entries: readonly string[];
+}
+/** Inputs for {@link buildComposition}. */
+interface BuildCompositionInput {
+    /** The `subject` reference (the patient's in-bundle fullUrl). */
+    readonly subject: string;
+    /** The `author` + `custodian` reference (an in-bundle Organization fullUrl). */
+    readonly organization: string;
+    /** The document date (`YYYY-MM-DD`). */
+    readonly date: string;
+    /** The document sections. */
+    readonly sections: readonly CompositionSection[];
+}
+/**
+ * Build a spec-clean synthetic base-R4 `Composition` for a `document` Bundle, through `@cosyte/fhir`.
+ *
+ * @param rng - The seeded generator (for the resource id).
+ * @param input - Subject/organization references, date, and sections. See {@link BuildCompositionInput}.
+ * @returns The `Composition` resource model (a `FhirComplex`).
+ * @example
+ * ```ts
+ * import { createRng } from "@cosyte/synth";
+ * import { buildComposition } from "@cosyte/synth/fhir";
+ * // buildComposition(createRng(1), { subject, organization, date: "2020-01-01", sections: [] });
+ * ```
+ */
+declare function buildComposition(rng: Rng, input: BuildCompositionInput): FhirComplex;
+
+/**
+ * The **round-trip-through-the-parser harness** for FHIR — the headline gate for the synthetic-fixture
+ * generator. A generated resource is "spec-clean" only if `@cosyte/fhir` — not
+ * `@cosyte/synth`'s own opinion — reads it back, validates it, and re-serializes it byte-identically.
+ * This harness serializes a generated resource, parses it back, validates it (optionally against
+ * supplied US Core / vendor `StructureDefinition`s), and re-serializes, reporting what the parser found
+ * so a false "spec-clean" claim cannot hide.
+ *
+ * `@cosyte/synth` bundles **no** profile content: to validate US Core conformance, a caller supplies
+ * the `StructureDefinition`s via {@link RoundTripOptions.profiles} — exactly the content-free posture of
+ * `@cosyte/fhir.validateResource({ profiles })`.
+ *
+ * @module
+ */
+
+/** Options for {@link roundTrip}. */
+interface RoundTripOptions {
+    /**
+     * US Core / vendor profiles (`StructureDefinition`s) to validate against. **None is bundled** — a
+     * caller supplies them (BYO), matching `@cosyte/fhir`'s content-free posture.
+     */
+    readonly profiles?: readonly StructureDefinition[];
+}
+/** The verdict of one round-trip through `@cosyte/fhir`. */
+interface RoundTripResult {
+    /** The serialized FHIR JSON text (the parser's own conservative emit). */
+    readonly content: string;
+    /**
+     * The validation issue codes at `error`/`fatal` severity (empty ⇒ valid). `information`/`warning`
+     * findings (e.g. `MUST_SUPPORT_ABSENT`, `INVARIANT_UNCHECKED`, base `dom-6`) are advisory and are
+     * excluded here — they never make a resource invalid.
+     */
+    readonly errors: readonly string[];
+    /** All non-informational issue codes (errors **and** warnings), for the `Corpus` artifact record. */
+    readonly warnings: readonly string[];
+    /** Whether re-serializing the re-parsed resource is byte-identical to `content`. */
+    readonly byteStable: boolean;
+    /** Whether `@cosyte/fhir.validateResource` reported no `error`/`fatal` findings. */
+    readonly valid: boolean;
+    /** `true` iff the artifact is spec-clean: **valid** (zero errors) **and** byte-stable. */
+    readonly specClean: boolean;
+}
+/**
+ * Round-trip a generated FHIR resource through serialize → parse → validate → serialize and report the
+ * verdict. A spec-clean artifact validates with **zero errors** and re-serializes byte-identically.
+ *
+ * @param resource - The resource model to check (typically from a `generate*` function).
+ * @param options - Optional US Core / vendor profiles to validate against. See {@link RoundTripOptions}.
+ * @returns The {@link RoundTripResult}.
+ * @example
+ * ```ts
+ * import { generatePatient, roundTrip } from "@cosyte/synth/fhir";
+ * const { specClean, errors } = roundTrip(generatePatient({ seed: 1 }));
+ * // specClean === true, errors.length === 0
+ * ```
+ */
+declare function roundTrip(resource: FhirComplex, options?: RoundTripOptions): RoundTripResult;
+
+/**
+ * Shared FHIR model-construction helpers — the small vocabulary every resource generator uses
+ * to build **through `@cosyte/fhir`'s own model constructors** (`complex` / `list` / `primitive` /
+ * `decimal`). A generated resource is a `FhirComplex` tree assembled here and serialized by
+ * `@cosyte/fhir`'s conservative writer, so it is **spec-clean by construction** — the same mechanism
+ * that makes the parser's emit side spec-clean. Nothing here hand-writes JSON
+ * bytes.
+ *
+ * Identity fields (`name`, `identifier`, `birthDate`, `telecom`, `address`) are minted from the
+ * synthetic-safety providers in `../safe`, so no value a resource carries can be real or plausibly-real
+ * PHI. The `fhirPatientIdentity` bundle draws them in a **fixed order** for the
+ * reproducibility contract.
+ *
+ * @module
+ */
+
+/** A named FHIR property (`{ name, value }`) — the shape `complex` consumes. */
+type Prop = {
+    readonly name: string;
+    readonly value: FhirNode;
+};
+/**
+ * Build a named FHIR property.
+ *
+ * @param name - The property name.
+ * @param value - The property's node value.
+ * @returns A {@link Prop}.
+ * @example
+ * ```ts
+ * import { prop, str } from "@cosyte/synth/fhir";
+ * prop("gender", str("female"));
+ * ```
+ */
+declare function prop(name: string, value: FhirNode): Prop;
+/**
+ * A `string`/`code`/`uri`/`date` primitive leaf.
+ *
+ * @param value - The lexical string value.
+ * @returns A primitive `FhirNode`.
+ * @example
+ * ```ts
+ * import { str } from "@cosyte/synth/fhir";
+ * str("final");
+ * ```
+ */
+declare function str(value: string): FhirNode;
+/**
+ * A `decimal` primitive leaf, precision-preserving via `@cosyte/fhir`'s string-backed `FhirDecimal`.
+ *
+ * @param raw - The exact decimal lexical form (never routed through a JS `number`).
+ * @returns A primitive `FhirNode`.
+ * @example
+ * ```ts
+ * import { dec } from "@cosyte/synth/fhir";
+ * dec("6.3");
+ * ```
+ */
+declare function dec(raw: string): FhirNode;
+/**
+ * A `boolean` primitive leaf.
+ *
+ * @param value - The boolean value.
+ * @returns A primitive `FhirNode`.
+ * @example
+ * ```ts
+ * import { bool } from "@cosyte/synth/fhir";
+ * bool(true);
+ * ```
+ */
+declare function bool(value: boolean): FhirNode;
+/**
+ * A single `Coding` element (`system` + `code` + `display`).
+ *
+ * @param concept - The coding's `system`, `code`, and `display`.
+ * @returns A `Coding` `FhirComplex`.
+ * @example
+ * ```ts
+ * import { coding } from "@cosyte/synth/fhir";
+ * coding({ system: "http://loinc.org", code: "2345-7", display: "Glucose" });
+ * ```
+ */
+declare function coding(concept: {
+    system: string;
+    code: string;
+    display: string;
+}): FhirComplex;
+/**
+ * A `CodeableConcept` wrapping a single `Coding`.
+ *
+ * @param concept - The coding's `system`, `code`, and `display`.
+ * @returns A `CodeableConcept` `FhirComplex`.
+ * @example
+ * ```ts
+ * import { codeableConcept } from "@cosyte/synth/fhir";
+ * codeableConcept({ system: "http://snomed.info/sct", code: "59621000", display: "Essential hypertension" });
+ * ```
+ */
+declare function codeableConcept(concept: {
+    system: string;
+    code: string;
+    display: string;
+}): FhirComplex;
+/**
+ * A literal `Reference` element (`{ reference: "<Type>/<id>" }` or a `urn:uuid:` fullUrl).
+ *
+ * @param ref - The reference string.
+ * @returns A `Reference` `FhirComplex`.
+ * @example
+ * ```ts
+ * import { reference } from "@cosyte/synth/fhir";
+ * reference("Patient/syn-patient-1");
+ * ```
+ */
+declare function reference(ref: string): FhirComplex;
+/**
+ * A generated `Narrative` (`text`) with `status: "generated"` and an XHTML `div` carrying only
+ * synthetic text — satisfies the base `dom-6` best-practice constraint so a generated resource is
+ * robust as well as valid. The `div` is XHTML-namespaced and carries no markup beyond a paragraph, so
+ * it round-trips byte-for-byte through `@cosyte/fhir`'s codec.
+ *
+ * @param text - The plain synthetic summary text (no PHI — it is composed from synthetic values).
+ * @returns A `Narrative` `FhirComplex`.
+ * @example
+ * ```ts
+ * import { narrative } from "@cosyte/synth/fhir";
+ * narrative("Synthetic patient summary.");
+ * ```
+ */
+declare function narrative(text: string): FhirComplex;
+/**
+ * A `meta.profile` element pinning the resource to one or more canonical profile URLs (US Core
+ * conformance is claimed via `meta.profile`). No version is pinned, so validating against any supplied
+ * version of the named profile never raises a version-mismatch.
+ *
+ * @param profiles - The canonical profile URLs to claim.
+ * @returns A `meta` `FhirComplex`.
+ * @example
+ * ```ts
+ * import { meta, US_CORE_PROFILE } from "@cosyte/synth/fhir";
+ * meta([US_CORE_PROFILE.PATIENT]);
+ * ```
+ */
+declare function meta(profiles: readonly string[]): FhirComplex;
+/** A synthetic FHIR patient identity — every field drawn from `../safe`. */
+interface FhirPatientIdentity {
+    /** A synthetic resource `id` (a seeded UUID) — never a real record key. */
+    readonly id: string;
+    /** Name from the shipped fake-name pool. */
+    readonly person: SyntheticName;
+    /** Medical-record identifier scoped to the synthetic assigning authority. */
+    readonly mrn: SyntheticIdentifier;
+    /** Date of birth as a FHIR `date` (`YYYY-MM-DD`) from the seeded generator. */
+    readonly birthDate: string;
+    /** FHIR administrative-gender code. */
+    readonly gender: "male" | "female";
+    /** Synthetic postal address (reserved non-real ZIP). */
+    readonly address: SyntheticAddress;
+    /** Reserved `555-01xx` phone number. */
+    readonly phone: string;
+    /** Synthetic email at a reserved (`example.*`) domain. */
+    readonly email: string;
+}
+/**
+ * Reformat a `YYYYMMDD` synthetic date (from `safe.dateYmd`) as a FHIR `date` (`YYYY-MM-DD`).
+ *
+ * @param ymd - The `YYYYMMDD` date string.
+ * @returns The `YYYY-MM-DD` FHIR date string.
+ * @example
+ * ```ts
+ * import { toFhirDate } from "@cosyte/synth/fhir";
+ * toFhirDate("19700131"); // "1970-01-31"
+ * ```
+ */
+declare function toFhirDate(ymd: string): string;
+/**
+ * Mint a complete synthetic {@link FhirPatientIdentity}. Every value comes from a synthetic-safety
+ * provider — no code path here can return a real or plausibly-real identifier. The draw
+ * order is fixed (id → name → MRN → DOB → gender → address → phone → email) so the same seed yields the
+ * same identity.
+ *
+ * @param rng - The seeded generator.
+ * @returns A synthetic {@link FhirPatientIdentity}.
+ * @example
+ * ```ts
+ * import { createRng } from "@cosyte/synth";
+ * // const id = fhirPatientIdentity(createRng(1)); // id.person, id.mrn, …
+ * ```
+ */
+declare function fhirPatientIdentity(rng: Rng): FhirPatientIdentity;
+/**
+ * The US Core Patient `identifier` element for a synthetic MRN — `type` (`MR`), the synthetic
+ * assigning-authority OID as `system`, and the synthetic value. Satisfies US Core Patient's required
+ * `identifier.system` + `identifier.value`.
+ *
+ * @param mrn - The synthetic identifier from `safe.identifier`.
+ * @returns An `Identifier` `FhirComplex`.
+ * @example
+ * ```ts
+ * import { createRng, safe } from "@cosyte/synth";
+ * import { mrnIdentifier } from "@cosyte/synth/fhir";
+ * mrnIdentifier(safe.identifier(createRng(1), "MR"));
+ * ```
+ */
+declare function mrnIdentifier(mrn: SyntheticIdentifier): FhirComplex;
+
+/**
+ * US Core + base-FHIR **canonical URLs and code-system identifiers** — the facts `@cosyte/synth` needs
+ * to emit US-Core-conformant resources, and nothing more.
+ *
+ * **Content-free, exactly like `@cosyte/fhir`.** These are *identifiers* — canonical URLs and code
+ * `system` URIs — not the copyrighted terminology tables or the profile `StructureDefinition` content
+ * they name. `@cosyte/synth` bundles **no** US Core IG: a consumer who wants to *validate* generated
+ * output against US Core supplies the `StructureDefinition`s themselves (BYO), exactly as
+ * `@cosyte/fhir.validateResource({ profiles })` requires. What is encoded here is only which canonical
+ * URL a resource's `meta.profile` claims and which `system` a coding carries — public facts.
+ *
+ * The URLs target **US Core 6.1.0** (the USCDI v3 / ONC HTI-1 §170.315(g)(10) anchor, FHIR R4 4.0.1),
+ * grounded firsthand against the published IG (`hl7.org/fhir/us/core/STU6.1`) — the same version the
+ * test corpus validates against.
+ *
+ * @module
+ */
+/** The canonical `meta.profile` URLs for the US Core 6.1.0 profiles `@cosyte/synth` generates. */
+declare const US_CORE_PROFILE: Readonly<{
+    /** US Core Patient. */
+    readonly PATIENT: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient";
+    /** US Core Condition (Problems and Health Concerns). */
+    readonly CONDITION: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns";
+    /** US Core Laboratory Result Observation. */
+    readonly OBSERVATION_LAB: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab";
+    /** US Core Vital Signs (derived from the base FHIR vital-signs profile). */
+    readonly VITAL_SIGNS: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs";
+    /** US Core MedicationRequest. */
+    readonly MEDICATION_REQUEST: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest";
+    /** US Core Encounter. */
+    readonly ENCOUNTER: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter";
+    /** US Core DiagnosticReport Profile for Laboratory Results Reporting. */
+    readonly DIAGNOSTIC_REPORT_LAB: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab";
+    /** US Core Immunization. */
+    readonly IMMUNIZATION: "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization";
+    /** US Core AllergyIntolerance. */
+    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";
+}>;
+/** 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). */
+declare const US_CORE_ETHNICITY_EXTENSION = "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity";
+/** The US Core `us-core-birthsex` extension URL (a Patient must-support extension). */
+declare const US_CORE_BIRTHSEX_EXTENSION = "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex";
+/**
+ * The code-system `system` URIs the generators reference. Public identity URIs (HL7-published),
+ * never the code-system *content* — no SNOMED/LOINC/RxNorm table is bundled.
+ */
+declare const SYSTEM: Readonly<{
+    /** FHIR `administrative-gender` (`Patient.gender`). */
+    readonly ADMINISTRATIVE_GENDER: "http://hl7.org/fhir/administrative-gender";
+    /** HL7 Terminology `observation-category`. */
+    readonly OBSERVATION_CATEGORY: "http://terminology.hl7.org/CodeSystem/observation-category";
+    /** HL7 Terminology `condition-category`. */
+    readonly CONDITION_CATEGORY: "http://terminology.hl7.org/CodeSystem/condition-category";
+    /** HL7 Terminology `condition-clinical`. */
+    readonly CONDITION_CLINICAL: "http://terminology.hl7.org/CodeSystem/condition-clinical";
+    /** HL7 Terminology `condition-ver-status`. */
+    readonly CONDITION_VER_STATUS: "http://terminology.hl7.org/CodeSystem/condition-ver-status";
+    /** HL7 v2 `0203` identifier-type (`Identifier.type.coding.code` = `MR`). */
+    readonly IDENTIFIER_TYPE: "http://terminology.hl7.org/CodeSystem/v2-0203";
+    /** OMB race & ethnicity category system (US Core race/ethnicity `ombCategory`). */
+    readonly OMB_RACE_ETHNICITY: "urn:oid:2.16.840.1.113883.6.238";
+    /** LOINC — `Observation.code` (lab + vital-signs). */
+    readonly LOINC: "http://loinc.org";
+    /** SNOMED CT — `Condition.code`. */
+    readonly SNOMED: "http://snomed.info/sct";
+    /** RxNorm — `MedicationRequest.medicationCodeableConcept` + an allergen substance. */
+    readonly RXNORM: "http://www.nlm.nih.gov/research/umls/rxnorm";
+    /** UCUM — `Quantity.system` for units of measure. */
+    readonly UCUM: "http://unitsofmeasure.org";
+    /** CVX (CDC vaccine administered) — `Immunization.vaccineCode`. */
+    readonly CVX: "http://hl7.org/fhir/sid/cvx";
+    /** HL7 v3 `ActCode` — `Encounter.class`. */
+    readonly V3_ACT_CODE: "http://terminology.hl7.org/CodeSystem/v3-ActCode";
+    /** HL7 v2 `0074` diagnostic-service-section — `DiagnosticReport.category` (`LAB`). */
+    readonly DIAGNOSTIC_SERVICE_SECTION: "http://terminology.hl7.org/CodeSystem/v2-0074";
+    /** HL7 Terminology `allergyintolerance-clinical` — `AllergyIntolerance.clinicalStatus`. */
+    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";
+}>;
+/** 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 };