gdc-common-utils-ts 1.20.1 → 1.21.0

package/README.md

@@ -123,7 +123,7 @@ The `convert` export exposes resource-specific FHIR R4 conversion helpers such a
 
 - `medicationStatementFlatToFhirR4`
 - `medicationStatementFhirR4ToFlat`
-- `observationFlatToFhirR4`
+- `observationFromFlatToFhirR4`
 - `documentReferenceFlatToFhirR4`
 - `compositionFlatToFhirR4`
 
@@ -132,7 +132,7 @@ Example:
 ```ts
 import {
   medicationStatementFlatToFhirR4,
-  observationFhirR4ToFlat,
+  observationToFlatFhirR4,
 } from 'gdc-common-utils-ts/convert';
 ```
 

package/dist/claims/claims-helpers-related-person.d.ts

@@ -6,3 +6,17 @@ export declare function addRelatedPersonClaimList(claims: RelatedPersonInteroper
 export declare function removeRelatedPersonClaimList(claims: RelatedPersonInteroperableClaims, claimKey: string, values: string | readonly string[]): RelatedPersonInteroperableClaims;
 export declare function getRelatedPersonIdentifier(claims: RelatedPersonInteroperableClaims): string;
 export declare function setRelatedPersonIdentifier(claims: RelatedPersonInteroperableClaims, value: string): RelatedPersonInteroperableClaims;
+/**
+ * Returns the current active flag as a boolean when present.
+ *
+ * Interoperability note:
+ * some callers persist the flag as a real boolean while others may carry the
+ * transport value as `"true"` / `"false"`. This helper normalizes both
+ * shapes.
+ */
+export declare function getRelatedPersonActive(claims: RelatedPersonInteroperableClaims): boolean | undefined;
+/**
+ * Sets the canonical active flag used by the current `RelatedPerson` lifecycle
+ * helpers.
+ */
+export declare function setRelatedPersonActive(claims: RelatedPersonInteroperableClaims, value: boolean): RelatedPersonInteroperableClaims;

package/dist/claims/claims-helpers-related-person.js

@@ -18,3 +18,31 @@ export function getRelatedPersonIdentifier(claims) {
 export function setRelatedPersonIdentifier(claims, value) {
     return { ...claims, [RelatedPersonClaim.Identifier]: normalizeClaimScalar(value) };
 }
+/**
+ * Returns the current active flag as a boolean when present.
+ *
+ * Interoperability note:
+ * some callers persist the flag as a real boolean while others may carry the
+ * transport value as `"true"` / `"false"`. This helper normalizes both
+ * shapes.
+ */
+export function getRelatedPersonActive(claims) {
+    const value = claims[RelatedPersonClaim.Active];
+    if (typeof value === 'boolean')
+        return value;
+    if (typeof value === 'string') {
+        const normalized = value.trim().toLowerCase();
+        if (normalized === 'true')
+            return true;
+        if (normalized === 'false')
+            return false;
+    }
+    return undefined;
+}
+/**
+ * Sets the canonical active flag used by the current `RelatedPerson` lifecycle
+ * helpers.
+ */
+export function setRelatedPersonActive(claims, value) {
+    return { ...claims, [RelatedPersonClaim.Active]: value };
+}

package/dist/constants/Schemas.d.ts

@@ -22,11 +22,13 @@ export type Section = typeof Section[keyof typeof Section];
 export declare const Format: {
     readonly SCHEMA: "org.schema";
     readonly FHIR_API: "org.hl7.fhir.api";
+    readonly FHIR_R4: "org.hl7.fhir.r4";
 };
 export type Format = typeof Format[keyof typeof Format];
 export declare const Resource: {
     readonly PERSON: "Person";
     readonly RELATED_PERSON: "RelatedPerson";
+    readonly LICENSE: "License";
     readonly EMPLOYEE: "Employee";
     readonly EMPLOYEE_ROLE: "EmployeeRole";
     readonly PRACTITIONER: "Practitioner";
@@ -40,6 +42,7 @@ export declare const JobAction: {
     readonly BATCH: "_batch";
     readonly CREATE: "_create";
     readonly DISCOVERY: "_discovery";
+    readonly SEARCH: "_search";
 };
 export type JobAction = typeof JobAction[keyof typeof JobAction];
 export declare const knownDomainsReversed: readonly ["org.schema", "org.hl7.fhir", "org.ilo.isco", "net.openid"];

package/dist/constants/Schemas.js

@@ -23,10 +23,12 @@ export const Section = {
 export const Format = {
     SCHEMA: 'org.schema',
     FHIR_API: 'org.hl7.fhir.api',
+    FHIR_R4: 'org.hl7.fhir.r4',
 };
 export const Resource = {
     PERSON: 'Person',
     RELATED_PERSON: 'RelatedPerson',
+    LICENSE: 'License',
     EMPLOYEE: 'Employee',
     EMPLOYEE_ROLE: 'EmployeeRole',
     PRACTITIONER: 'Practitioner',
@@ -39,6 +41,7 @@ export const JobAction = {
     BATCH: '_batch',
     CREATE: '_create',
     DISCOVERY: '_discovery',
+    SEARCH: '_search',
 };
 export const knownDomainsReversed = [
     'org.schema',

package/dist/constants/fhir-code-systems.d.ts

@@ -6,6 +6,7 @@
  */
 export declare const FhirCodeSystems: Readonly<{
     readonly Loinc: "http://loinc.org";
+    readonly SnomedCt: "http://snomed.info/sct";
     readonly Ucum: "http://unitsofmeasure.org";
     readonly CommunicationCategory: "http://terminology.hl7.org/CodeSystem/communication-category";
     readonly ObservationCategory: "http://terminology.hl7.org/CodeSystem/observation-category";

package/dist/constants/fhir-code-systems.js

@@ -6,6 +6,7 @@
  */
 export const FhirCodeSystems = Object.freeze({
     Loinc: 'http://loinc.org',
+    SnomedCt: 'http://snomed.info/sct',
     Ucum: 'http://unitsofmeasure.org',
     CommunicationCategory: 'http://terminology.hl7.org/CodeSystem/communication-category',
     ObservationCategory: 'http://terminology.hl7.org/CodeSystem/observation-category',

package/dist/constants/index.d.ts

@@ -15,6 +15,7 @@ export * from './healthcare';
 export * from './permission-templates';
 export * from './vital-signs';
 export * from './network';
+export * from './observation-category';
 export * from './sectors';
 export * from './smart';
 export * from './permission-templates';
@@ -23,3 +24,5 @@ export * from './urn';
 export * from './verifiable-credentials';
 export * from './identity-gender';
 export * from './identity-identifiers';
+export * from './individual-sections';
+export * from './lifecycle';

package/dist/constants/index.js

@@ -15,6 +15,7 @@ export * from './healthcare.js';
 export * from './permission-templates.js';
 export * from './vital-signs.js';
 export * from './network.js';
+export * from './observation-category.js';
 export * from './sectors.js';
 export * from './smart.js';
 export * from './permission-templates.js';
@@ -23,3 +24,5 @@ export * from './urn.js';
 export * from './verifiable-credentials.js';
 export * from './identity-gender.js';
 export * from './identity-identifiers.js';
+export * from './individual-sections.js';
+export * from './lifecycle.js';

package/dist/constants/individual-sections.d.ts

@@ -0,0 +1,210 @@
+export type IndividualSectionDescriptor = Readonly<{
+    code: string;
+    attributeValue: string;
+    titleEn: string;
+}>;
+export declare const IndividualSectionSystems: Readonly<{
+    readonly Logical: "urn:gdc:individual-section";
+}>;
+export declare const IndividualLogicalSections: Readonly<{
+    readonly Composition: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Communications: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Consents: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Appointments: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Encounters: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Documents: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Observations: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly DiagnosticReports: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly RelatedPersons: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Coverage: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+}>;
+export declare const IndividualClinicalSections: Readonly<{
+    readonly AllergiesAndIntolerances: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Conditions: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Immunizations: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Medications: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Procedures: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly VitalSigns: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+}>;
+export declare const IndividualAllSections: Readonly<{
+    readonly AllergiesAndIntolerances: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Conditions: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Immunizations: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Medications: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Procedures: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly VitalSigns: Readonly<{
+        system: typeof import("..").LOINC_SYSTEM_URL;
+        code: string;
+        attributeValue: string;
+        claim: string;
+        i18nKey: `org.loinc.${string}`;
+        titleEn?: string;
+    }>;
+    readonly Composition: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Communications: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Consents: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Appointments: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Encounters: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Documents: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Observations: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly DiagnosticReports: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly RelatedPersons: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+    readonly Coverage: Readonly<{
+        code: string;
+        attributeValue: string;
+        titleEn: string;
+    }>;
+}>;

package/dist/constants/individual-sections.js

@@ -0,0 +1,35 @@
+import { HealthcareCoreSections } from './healthcare.js';
+function defineSection(code, titleEn) {
+    return Object.freeze({
+        code,
+        attributeValue: `urn:gdc:individual-section|${code}`,
+        titleEn,
+    });
+}
+export const IndividualSectionSystems = Object.freeze({
+    Logical: 'urn:gdc:individual-section',
+});
+export const IndividualLogicalSections = Object.freeze({
+    Composition: defineSection('composition', 'Individual composition index'),
+    Communications: defineSection('communications', 'Communications'),
+    Consents: defineSection('consents', 'Consents'),
+    Appointments: defineSection('appointments', 'Appointments'),
+    Encounters: defineSection('encounters', 'Encounters'),
+    Documents: defineSection('documents', 'Documents'),
+    Observations: defineSection('observations', 'Observations'),
+    DiagnosticReports: defineSection('diagnostic-reports', 'Diagnostic reports'),
+    RelatedPersons: defineSection('related-persons', 'Related persons'),
+    Coverage: defineSection('coverage', 'Coverage'),
+});
+export const IndividualClinicalSections = Object.freeze({
+    AllergiesAndIntolerances: HealthcareCoreSections.AllergiesAndIntolerances,
+    Conditions: HealthcareCoreSections.ProblemList,
+    Immunizations: HealthcareCoreSections.Immunizations,
+    Medications: HealthcareCoreSections.HistoryOfMedicationUse,
+    Procedures: HealthcareCoreSections.Procedures,
+    VitalSigns: HealthcareCoreSections.VitalSigns,
+});
+export const IndividualAllSections = Object.freeze({
+    ...IndividualLogicalSections,
+    ...IndividualClinicalSections,
+});

package/dist/constants/lifecycle.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Shared interoperability contexts reused by examples, readers, and SDK
+ * adapters so they do not re-hardcode protocol-family strings inline.
+ */
+export declare const InteroperableContext: Readonly<{
+    readonly FhirApi: "org.hl7.fhir.api";
+    readonly FhirR4: "org.hl7.fhir.r4";
+    readonly Schema: "org.schema";
+}>;
+/**
+ * Stable request type ids reused by lifecycle examples and SDK runtime
+ * adapters for the currently deployed GW CORE contract.
+ */
+export declare const LifecycleRequestType: Readonly<{
+    readonly RelatedPersonDisable: "RelatedPerson-disable-request-v1.0";
+    readonly RelatedPersonPurge: "RelatedPerson-purge-request-v1.0";
+}>;

package/dist/constants/lifecycle.js

@@ -0,0 +1,18 @@
+import { Format } from './Schemas.js';
+/**
+ * Shared interoperability contexts reused by examples, readers, and SDK
+ * adapters so they do not re-hardcode protocol-family strings inline.
+ */
+export const InteroperableContext = Object.freeze({
+    FhirApi: Format.FHIR_API,
+    FhirR4: Format.FHIR_R4,
+    Schema: Format.SCHEMA,
+});
+/**
+ * Stable request type ids reused by lifecycle examples and SDK runtime
+ * adapters for the currently deployed GW CORE contract.
+ */
+export const LifecycleRequestType = Object.freeze({
+    RelatedPersonDisable: 'RelatedPerson-disable-request-v1.0',
+    RelatedPersonPurge: 'RelatedPerson-purge-request-v1.0',
+});

package/dist/constants/observation-category.d.ts

@@ -0,0 +1,72 @@
+export type CodingDescriptor = Readonly<{
+    system: string;
+    code: string;
+    display?: string;
+    claim: string;
+}>;
+/**
+ * Canonical `Observation.category` descriptors.
+ *
+ * Source:
+ * - HL7 Terminology Observation Category code system:
+ *   https://terminology.hl7.org/7.1.0/CodeSystem-observation-category.html
+ *
+ * Keep category in `Observation.category`.
+ * Do not store category codes in `Observation.value-concept-*`.
+ */
+export declare const ObservationCategoryCodes: Readonly<{
+    readonly SocialHistory: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+    readonly VitalSigns: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+    readonly Imaging: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+    readonly Laboratory: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+    readonly Procedure: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+    readonly Survey: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+    readonly Exam: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+    readonly Therapy: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+    readonly Activity: Readonly<{
+        system: string;
+        code: string;
+        display?: string;
+        claim: string;
+    }>;
+}>;

package/dist/constants/observation-category.js

@@ -0,0 +1,30 @@
+import { FhirCodeSystems } from './fhir-code-systems.js';
+function defineCoding(system, code, display) {
+    return Object.freeze({
+        system,
+        code,
+        display,
+        claim: `${system}|${code}`,
+    });
+}
+/**
+ * Canonical `Observation.category` descriptors.
+ *
+ * Source:
+ * - HL7 Terminology Observation Category code system:
+ *   https://terminology.hl7.org/7.1.0/CodeSystem-observation-category.html
+ *
+ * Keep category in `Observation.category`.
+ * Do not store category codes in `Observation.value-concept-*`.
+ */
+export const ObservationCategoryCodes = Object.freeze({
+    SocialHistory: defineCoding(FhirCodeSystems.ObservationCategory, 'social-history', 'Social History'),
+    VitalSigns: defineCoding(FhirCodeSystems.ObservationCategory, 'vital-signs', 'Vital Signs'),
+    Imaging: defineCoding(FhirCodeSystems.ObservationCategory, 'imaging', 'Imaging'),
+    Laboratory: defineCoding(FhirCodeSystems.ObservationCategory, 'laboratory', 'Laboratory'),
+    Procedure: defineCoding(FhirCodeSystems.ObservationCategory, 'procedure', 'Procedure'),
+    Survey: defineCoding(FhirCodeSystems.ObservationCategory, 'survey', 'Survey'),
+    Exam: defineCoding(FhirCodeSystems.ObservationCategory, 'exam', 'Exam'),
+    Therapy: defineCoding(FhirCodeSystems.ObservationCategory, 'therapy', 'Therapy'),
+    Activity: defineCoding(FhirCodeSystems.ObservationCategory, 'activity', 'Activity'),
+});

package/dist/constants/schemaorg.d.ts

@@ -124,6 +124,10 @@ export declare enum ClaimsIndividualProductSchemaorg {
     serialNumber = "org.schema.IndividualProduct.serialNumber"
 }
 export declare enum ClaimsOrderSchemaorg {
+    acceptedOfferIdentifier = "org.schema.Order.acceptedOffer.identifier",
+    partOfInvoice = "org.schema.Order.partOfInvoice",
+    paymentMethod = "org.schema.Order.paymentMethod",
+    paymentUrl = "org.schema.Order.paymentUrl",
     orderedItemServiceType = "org.schema.Order.orderedItem.serviceType"
 }
 /** For Employees (and Employee Role, but no PII) and customers / related persons.

package/dist/constants/schemaorg.js

@@ -131,6 +131,10 @@ export var ClaimsIndividualProductSchemaorg;
 })(ClaimsIndividualProductSchemaorg || (ClaimsIndividualProductSchemaorg = {}));
 export var ClaimsOrderSchemaorg;
 (function (ClaimsOrderSchemaorg) {
+    ClaimsOrderSchemaorg["acceptedOfferIdentifier"] = "org.schema.Order.acceptedOffer.identifier";
+    ClaimsOrderSchemaorg["partOfInvoice"] = "org.schema.Order.partOfInvoice";
+    ClaimsOrderSchemaorg["paymentMethod"] = "org.schema.Order.paymentMethod";
+    ClaimsOrderSchemaorg["paymentUrl"] = "org.schema.Order.paymentUrl";
     ClaimsOrderSchemaorg["orderedItemServiceType"] = "org.schema.Order.orderedItem.serviceType";
 })(ClaimsOrderSchemaorg || (ClaimsOrderSchemaorg = {}));
 /** For Employees (and Employee Role, but no PII) and customers / related persons.

package/dist/constants/vital-signs.d.ts

@@ -1,20 +1,5 @@
-export type CodingDescriptor = Readonly<{
-    system: string;
-    code: string;
-    display?: string;
-    claim: string;
-}>;
-/**
- * Canonical `Observation.category` descriptors for vital-sign observations.
- */
-export declare const ObservationCategoryCodes: Readonly<{
-    readonly VitalSigns: Readonly<{
-        system: string;
-        code: string;
-        display?: string;
-        claim: string;
-    }>;
-}>;
+export { ObservationCategoryCodes } from './observation-category';
+export type { CodingDescriptor } from './observation-category';
 /**
  * Canonical LOINC descriptors for the currently supported Vital Signs.
  */

package/dist/constants/vital-signs.js

@@ -1,4 +1,5 @@
 import { FhirCodeSystems } from './fhir-code-systems.js';
+export { ObservationCategoryCodes } from './observation-category.js';
 function defineCoding(system, code, display) {
     return Object.freeze({
         system,
@@ -7,12 +8,6 @@ function defineCoding(system, code, display) {
         claim: `${system}|${code}`,
     });
 }
-/**
- * Canonical `Observation.category` descriptors for vital-sign observations.
- */
-export const ObservationCategoryCodes = Object.freeze({
-    VitalSigns: defineCoding(FhirCodeSystems.ObservationCategory, 'vital-signs', 'Vital Signs'),
-});
 /**
  * Canonical LOINC descriptors for the currently supported Vital Signs.
  */

package/dist/convert/convert-observation.d.ts

@@ -1,3 +1,21 @@
 import type { FhirResource, FlatClaims } from './convert-shared';
-export declare function observationFlatToFhirR4(claims: FlatClaims): FhirResource;
-export declare function observationFhirR4ToFlat(resource: FhirResource): FlatClaims;
+/**
+ * Converts flat editable Observation claims into a FHIR R4 Observation.
+ *
+ * Naming convention:
+ * - place the concrete FHIR version suffix at the end of the helper name
+ * - prefer `observationFromFlatToFhirR4` / `observationToFlatFhirR4`
+ * - avoid `observationFhirR4ToFlat`
+ */
+export declare function observationFromFlatToFhirR4(claims: FlatClaims): FhirResource;
+/**
+ * Converts a FHIR R4 Observation into the flat editable claims contract.
+ *
+ * `Observation.category` stays in `Observation.category`.
+ * Coded result values belong in `Observation.value-concept-*`.
+ */
+export declare function observationToFlatFhirR4(resource: FhirResource): FlatClaims;
+/** @deprecated Prefer `observationFromFlatToFhirR4`. */
+export declare const observationFlatToFhirR4: typeof observationFromFlatToFhirR4;
+/** @deprecated Prefer `observationToFlatFhirR4`. */
+export declare const observationFhirR4ToFlat: typeof observationToFlatFhirR4;