fhir-data-utils-ts 0.6.5 → 0.6.7

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Unreleased
 
+- Export data-only, coverage-excluded authoring schemas for the six minimum IPS
+  resource families used by shared Personal and Professional forms:
+  AllergyIntolerance, MedicationStatement, Immunization, Condition, Procedure
+  and Observation. Every field reuses its owning flat-claim catalog, records
+  the terminology-enabled source-text claims and remains neutral between human
+  and veterinary subjects.
+  Bind every schema to its canonical section in the shared IPS all-sections
+  document so portals can update the Composition without duplicating LOINC
+  section codes.
+
 - Recover neutral SHC and EU DGC QR prefix classification from the later UHC
   data-utility lineage, with exported repository-safe `*.data.ts` examples.
   Recognition explicitly provides no decoding, verification or authorization.

package/dist/data/index.d.ts

@@ -3,3 +3,4 @@ export * from './appointment-communication.data.js';
 export * from './encounter-transfer.data.js';
 export * from './ips-all-sections.data.js';
 export * from './health-credential-qr.data.js';
+export * from './ips-clinical-artifact-schemas.data.js';

package/dist/data/index.js

@@ -3,3 +3,4 @@ export * from './appointment-communication.data.js';
 export * from './encounter-transfer.data.js';
 export * from './ips-all-sections.data.js';
 export * from './health-credential-qr.data.js';
+export * from './ips-clinical-artifact-schemas.data.js';

package/dist/data/ips-all-sections.data.d.ts

@@ -1,4 +1,13 @@
 /** Repository-safe synthetic IPS document used by portal demos and visual tests. */
+/** Primary IPS section placement for the minimum shared clinical authoring forms. */
+export declare const FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE: Readonly<{
+    readonly Condition: "11450-4";
+    readonly AllergyIntolerance: "48765-2";
+    readonly MedicationStatement: "10160-0";
+    readonly Immunization: "11369-6";
+    readonly Procedure: "47519-4";
+    readonly Observation: "8716-3";
+}>;
 /**
  * Complete synthetic IPS screen fixture.
  *

package/dist/data/ips-all-sections.data.js

@@ -20,6 +20,15 @@ const sectionDefinitions = Object.freeze([
     ['10162-6', 'Pregnancy history', 'Observation', 'Not pregnant'],
     ['18776-5', 'Plan of care', 'CarePlan', 'Emergency follow-up plan'],
 ]);
+/** Primary IPS section placement for the minimum shared clinical authoring forms. */
+export const FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE = Object.freeze({
+    Condition: sectionDefinitions[0][0],
+    AllergyIntolerance: sectionDefinitions[1][0],
+    MedicationStatement: sectionDefinitions[2][0],
+    Immunization: sectionDefinitions[3][0],
+    Procedure: sectionDefinitions[5][0],
+    Observation: sectionDefinitions[7][0],
+});
 function concept(text, code) {
     return { text, coding: [{ system: SNOMED_SYSTEM, code, display: text }] };
 }

package/dist/data/ips-clinical-artifact-schemas.data.d.ts

@@ -0,0 +1,26 @@
+export declare const FhirIpsClinicalArtifactTypes: Readonly<{
+    readonly AllergyIntolerance: "AllergyIntolerance";
+    readonly MedicationStatement: "MedicationStatement";
+    readonly Immunization: "Immunization";
+    readonly Condition: "Condition";
+    readonly Procedure: "Procedure";
+    readonly Observation: "Observation";
+}>;
+export type FhirIpsClinicalArtifactType = typeof FhirIpsClinicalArtifactTypes[keyof typeof FhirIpsClinicalArtifactTypes];
+export type FhirIpsClinicalArtifactSchema = Readonly<{
+    resourceType: FhirIpsClinicalArtifactType;
+    sectionCode: string;
+    requiredClaims: readonly string[];
+    optionalClaims: readonly string[];
+    /** Source-text claims for which a user may explicitly confirm a terminology candidate. */
+    terminologyTextClaims: readonly string[];
+}>;
+/**
+ * Minimum reusable IPS authoring surface for Personal and Professional portals.
+ *
+ * These data-only schemas contain claim keys, not UI labels, authorization or
+ * transport policy. Human and veterinary portals use the same core resource
+ * contracts; a veterinary terminology adapter may additionally receive the
+ * subject taxonomy without changing the stored FHIR claim names.
+ */
+export declare const FHIR_IPS_CLINICAL_ARTIFACT_SCHEMAS: Readonly<Record<FhirIpsClinicalArtifactType, FhirIpsClinicalArtifactSchema>>;

package/dist/data/ips-clinical-artifact-schemas.data.js

@@ -0,0 +1,68 @@
+// Copyright 2026 Connecting Solution & Applications Ltd under the Apache License, Version 2.0.
+import { AllergyIntoleranceClaim } from '../claims/allergy-intolerance-claims.js';
+import { ConditionClaim } from '../claims/condition-claims.js';
+import { ImmunizationClaim } from '../claims/immunization-claims.js';
+import { MedicationStatementClaim } from '../claims/medication-statement-claims.js';
+import { ProcedureClaim } from '../claims/procedure-claims.js';
+import { ObservationClaim } from '../observation-claims.js';
+import { FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE } from './ips-all-sections.data.js';
+export const FhirIpsClinicalArtifactTypes = Object.freeze({
+    AllergyIntolerance: 'AllergyIntolerance',
+    MedicationStatement: 'MedicationStatement',
+    Immunization: 'Immunization',
+    Condition: 'Condition',
+    Procedure: 'Procedure',
+    Observation: 'Observation',
+});
+/**
+ * Minimum reusable IPS authoring surface for Personal and Professional portals.
+ *
+ * These data-only schemas contain claim keys, not UI labels, authorization or
+ * transport policy. Human and veterinary portals use the same core resource
+ * contracts; a veterinary terminology adapter may additionally receive the
+ * subject taxonomy without changing the stored FHIR claim names.
+ */
+export const FHIR_IPS_CLINICAL_ARTIFACT_SCHEMAS = Object.freeze({
+    [FhirIpsClinicalArtifactTypes.AllergyIntolerance]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.AllergyIntolerance,
+        sectionCode: FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE.AllergyIntolerance,
+        requiredClaims: Object.freeze([AllergyIntoleranceClaim.CodeText, AllergyIntoleranceClaim.ClinicalStatus]),
+        optionalClaims: Object.freeze([AllergyIntoleranceClaim.Code, AllergyIntoleranceClaim.CodeDisplay, AllergyIntoleranceClaim.Category, AllergyIntoleranceClaim.VerificationStatus, AllergyIntoleranceClaim.Criticality, AllergyIntoleranceClaim.OnsetDateTime, AllergyIntoleranceClaim.Recorder]),
+        terminologyTextClaims: Object.freeze([AllergyIntoleranceClaim.CodeText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.MedicationStatement]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.MedicationStatement,
+        sectionCode: FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE.MedicationStatement,
+        requiredClaims: Object.freeze([MedicationStatementClaim.CodeText, MedicationStatementClaim.Status]),
+        optionalClaims: Object.freeze([MedicationStatementClaim.Code, MedicationStatementClaim.CodeDisplay, MedicationStatementClaim.Category, MedicationStatementClaim.Effective, MedicationStatementClaim.DosageInstruction, MedicationStatementClaim.DosageRoute, MedicationStatementClaim.TimingFrequency, MedicationStatementClaim.TimingPeriod, MedicationStatementClaim.TimingPeriodUnit, MedicationStatementClaim.Note]),
+        terminologyTextClaims: Object.freeze([MedicationStatementClaim.CodeText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.Immunization]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.Immunization,
+        sectionCode: FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE.Immunization,
+        requiredClaims: Object.freeze([ImmunizationClaim.VaccineCodeText, ImmunizationClaim.Status]),
+        optionalClaims: Object.freeze([ImmunizationClaim.VaccineCode, ImmunizationClaim.VaccineCodeDisplay, ImmunizationClaim.Date, ImmunizationClaim.LotNumber, ImmunizationClaim.DoseSequence, ImmunizationClaim.Manufacturer, ImmunizationClaim.Performer, ImmunizationClaim.Location, ImmunizationClaim.Route, ImmunizationClaim.RouteDisplay, ImmunizationClaim.Site, ImmunizationClaim.SiteDisplay, ImmunizationClaim.Series, ImmunizationClaim.TargetDisease, ImmunizationClaim.TargetDiseaseText, ImmunizationClaim.TargetDiseaseDisplay, ImmunizationClaim.ReactionDate, ImmunizationClaim.Note]),
+        terminologyTextClaims: Object.freeze([ImmunizationClaim.VaccineCodeText, ImmunizationClaim.TargetDiseaseText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.Condition]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.Condition,
+        sectionCode: FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE.Condition,
+        requiredClaims: Object.freeze([ConditionClaim.CodeText, ConditionClaim.ClinicalStatus]),
+        optionalClaims: Object.freeze([ConditionClaim.Code, ConditionClaim.CodeDisplay, ConditionClaim.Category, ConditionClaim.VerificationStatus, ConditionClaim.Severity, ConditionClaim.OnsetDateTime, ConditionClaim.RecordedDate, ConditionClaim.Asserter, ConditionClaim.Recorder]),
+        terminologyTextClaims: Object.freeze([ConditionClaim.CodeText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.Procedure]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.Procedure,
+        sectionCode: FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE.Procedure,
+        requiredClaims: Object.freeze([ProcedureClaim.CodeText, ProcedureClaim.Status]),
+        optionalClaims: Object.freeze([ProcedureClaim.Code, ProcedureClaim.CodeDisplay, ProcedureClaim.Date, ProcedureClaim.Performer, ProcedureClaim.Location, ProcedureClaim.BodySite, ProcedureClaim.ReasonCode, ProcedureClaim.ReasonReference, ProcedureClaim.Note]),
+        terminologyTextClaims: Object.freeze([ProcedureClaim.CodeText]),
+    }),
+    [FhirIpsClinicalArtifactTypes.Observation]: Object.freeze({
+        resourceType: FhirIpsClinicalArtifactTypes.Observation,
+        sectionCode: FHIR_IPS_PRIMARY_AUTHORING_SECTION_CODE_BY_RESOURCE_TYPE.Observation,
+        requiredClaims: Object.freeze([ObservationClaim.Category, ObservationClaim.CodeText, ObservationClaim.Status]),
+        optionalClaims: Object.freeze([ObservationClaim.Code, ObservationClaim.CodeDisplay, ObservationClaim.Date, ObservationClaim.EffectiveDateTime, ObservationClaim.Performer, ObservationClaim.Method, ObservationClaim.Specimen, ObservationClaim.Device, ObservationClaim.ValueQuantityNumber, ObservationClaim.ValueQuantityUnit, ObservationClaim.ValueString, ObservationClaim.ValueConcept, ObservationClaim.ReferenceRangeLowNumber, ObservationClaim.ReferenceRangeHighNumber, ObservationClaim.ReferenceRangeUnit, ObservationClaim.ReferenceRangeText, ObservationClaim.Note]),
+        terminologyTextClaims: Object.freeze([ObservationClaim.CodeText]),
+    }),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fhir-data-utils-ts",
-  "version": "0.6.5",
+  "version": "0.6.7",
   "description": "FHIR-version-neutral flat-claim and SearchParameter data utilities",
   "license": "Apache-2.0",
   "type": "module",