fhir-data-utils-ts 0.2.4 → 0.3.2

package/dist/group-r5.d.ts

@@ -0,0 +1,121 @@
+/**
+ * Browser-safe FHIR R5 Group contract for research-team descriptions.
+ *
+ * Group membership is descriptive. It never grants authorization, permission
+ * or a SMART scope; those decisions remain separate Consent and credential
+ * contracts.
+ *
+ * @see https://hl7.org/fhir/R5/group.html
+ * @see https://hl7.org/fhir/R5/group-search.html
+ */
+export declare const GroupR5Version: "5.0.0";
+export declare const GroupR5TypeSystem: "http://hl7.org/fhir/group-type";
+export declare const GroupR5TypeCodes: readonly ["person", "animal", "practitioner", "device", "careteam", "healthcareservice", "location", "organization", "relatedperson", "specimen"];
+export type GroupR5TypeCode = (typeof GroupR5TypeCodes)[number];
+export declare const GroupR5MembershipSystem: "http://hl7.org/fhir/group-membership-basis";
+export declare const GroupR5MembershipCodes: readonly ["definitional", "enumerated"];
+export type GroupR5MembershipCode = (typeof GroupR5MembershipCodes)[number];
+export declare const GroupR5Bindings: Readonly<{
+    readonly type: Readonly<{
+        valueSet: "http://hl7.org/fhir/ValueSet/group-type";
+        strength: "required";
+    }>;
+    readonly membership: Readonly<{
+        valueSet: "http://hl7.org/fhir/ValueSet/group-membership-basis";
+        strength: "required";
+    }>;
+}>;
+export type GroupSearchParameterType = 'composite' | 'reference' | 'string' | 'token';
+export type GroupR5SearchParameter = Readonly<{
+    code: string;
+    type: GroupSearchParameterType;
+    expression: string;
+    components: readonly string[];
+}>;
+/** Exact resource-specific SearchParameters published by FHIR R5 5.0.0. */
+export declare const GroupR5SearchParameterCatalog: readonly GroupR5SearchParameter[];
+/** Canonical Group flat-claim names. Never repeat these storage keys as literals. */
+export declare const GroupClaim: Readonly<{
+    readonly Characteristic: "Group.characteristic";
+    readonly CharacteristicReference: "Group.characteristic-reference";
+    readonly CharacteristicValue: "Group.characteristic-value";
+    readonly Code: "Group.code";
+    readonly Exclude: "Group.exclude";
+    readonly Identifier: "Group.identifier";
+    readonly ManagingEntity: "Group.managing-entity";
+    readonly Member: "Group.member";
+    readonly Membership: "Group.membership";
+    readonly Name: "Group.name";
+    readonly Type: "Group.type";
+    readonly Value: "Group.value";
+}>;
+declare const standardSearchClaims: readonly ("Group.characteristic" | "Group.code" | "Group.identifier" | "Group.membership" | "Group.name" | "Group.type" | "Group.characteristic-reference" | "Group.characteristic-value" | "Group.exclude" | "Group.managing-entity" | "Group.member" | "Group.value")[];
+/** Canonical claims derived only from the official resource-specific catalogue. */
+export declare const GroupFlatClaimCatalog: Readonly<{
+    standardSearch: readonly ("Group.characteristic" | "Group.code" | "Group.identifier" | "Group.membership" | "Group.name" | "Group.type" | "Group.characteristic-reference" | "Group.characteristic-value" | "Group.exclude" | "Group.managing-entity" | "Group.member" | "Group.value")[];
+    all: readonly ("Group.characteristic" | "Group.code" | "Group.identifier" | "Group.membership" | "Group.name" | "Group.type" | "Group.characteristic-reference" | "Group.characteristic-value" | "Group.exclude" | "Group.managing-entity" | "Group.member" | "Group.value")[];
+}>;
+export type GroupR5SearchClaim = (typeof standardSearchClaims)[number];
+export type GroupR5SearchClaims = Readonly<Partial<Record<GroupR5SearchClaim, readonly string[]>>>;
+export type GroupR5FlatClaimsResource = Readonly<{
+    resourceType: 'Group';
+    id: string;
+    meta: Readonly<{
+        claims: Readonly<Record<string, readonly string[]>>;
+    }>;
+}>;
+export type GroupR5Reference = Readonly<{
+    reference: string;
+    type?: string;
+    display?: string;
+}>;
+export type GroupR5Period = Readonly<{
+    start?: string;
+    end?: string;
+}>;
+export type GroupPractitionerRoleMember = Readonly<{
+    entity: Readonly<{
+        reference: `PractitionerRole/${string}`;
+        type: 'PractitionerRole';
+        display?: string;
+    }>;
+    period?: GroupR5Period;
+    inactive?: boolean;
+}>;
+export type GroupR5ResearchTeam = Readonly<Record<string, unknown> & {
+    resourceType: 'Group';
+    id?: string;
+    type: 'practitioner';
+    membership: 'enumerated';
+    member: readonly GroupPractitionerRoleMember[];
+}>;
+/**
+ * Normalizes the members used by an enumerated professional research team.
+ * Every entity is a native PractitionerRole reference; a Practitioner or an
+ * employee identifier cannot substitute for the registered role assignment.
+ */
+export declare function normalizeGroupPractitionerRoleMembers(input: unknown): readonly GroupPractitionerRoleMember[];
+/**
+ * Normalizes the Group profile used to describe an explicit professional
+ * ResearchStudy team. This data is descriptive and authorization-shaped
+ * properties are rejected at every depth.
+ */
+export declare function normalizeGroupR5ResearchTeam(input: unknown): GroupR5ResearchTeam;
+/**
+ * Projects all populated official resource-specific R5 Group SearchParameters
+ * into flat `resource.meta.claims`. A referenced characteristic is indexed by
+ * `characteristic-reference`, not as the token-valued `value` parameter.
+ *
+ * @see https://hl7.org/fhir/R5/group-search.html
+ */
+export declare function projectGroupR5SearchClaims(input: unknown): GroupR5SearchClaims;
+/** Projects native-shaped Group input to the claims-only GW persistence shape. */
+export declare function projectGroupR5FlatClaimsResource(input: unknown): GroupR5FlatClaimsResource;
+/** Projects one correlated claims-only GW resource per PractitionerRole member. */
+export declare function projectGroupPractitionerRoleMemberFlatClaimResources(input: Readonly<{
+    groupId: string;
+    members: unknown;
+}>): readonly GroupR5FlatClaimsResource[];
+/** Validates and freezes a claims-only Group GW resource. */
+export declare function normalizeGroupR5FlatClaimsResource(input: unknown): GroupR5FlatClaimsResource;
+export {};

package/dist/group-r5.js

@@ -0,0 +1,301 @@
+/**
+ * Browser-safe FHIR R5 Group contract for research-team descriptions.
+ *
+ * Group membership is descriptive. It never grants authorization, permission
+ * or a SMART scope; those decisions remain separate Consent and credential
+ * contracts.
+ *
+ * @see https://hl7.org/fhir/R5/group.html
+ * @see https://hl7.org/fhir/R5/group-search.html
+ */
+export const GroupR5Version = '5.0.0';
+export const GroupR5TypeSystem = 'http://hl7.org/fhir/group-type';
+export const GroupR5TypeCodes = Object.freeze([
+    'person',
+    'animal',
+    'practitioner',
+    'device',
+    'careteam',
+    'healthcareservice',
+    'location',
+    'organization',
+    'relatedperson',
+    'specimen',
+]);
+export const GroupR5MembershipSystem = 'http://hl7.org/fhir/group-membership-basis';
+export const GroupR5MembershipCodes = Object.freeze(['definitional', 'enumerated']);
+export const GroupR5Bindings = Object.freeze({
+    type: Object.freeze({
+        valueSet: 'http://hl7.org/fhir/ValueSet/group-type',
+        strength: 'required',
+    }),
+    membership: Object.freeze({
+        valueSet: 'http://hl7.org/fhir/ValueSet/group-membership-basis',
+        strength: 'required',
+    }),
+});
+const searchParameter = (code, type, expression, components = []) => Object.freeze({
+    code,
+    type,
+    expression,
+    components: Object.freeze([...components]),
+});
+/** Exact resource-specific SearchParameters published by FHIR R5 5.0.0. */
+export const GroupR5SearchParameterCatalog = Object.freeze([
+    searchParameter('characteristic', 'token', 'Group.characteristic.code'),
+    searchParameter('characteristic-reference', 'reference', '(Group.characteristic.value.ofType(Reference))'),
+    searchParameter('characteristic-value', 'composite', 'Group.characteristic', [
+        'http://hl7.org/fhir/SearchParameter/Group-characteristic',
+        'http://hl7.org/fhir/SearchParameter/Group-value',
+    ]),
+    searchParameter('code', 'token', 'Group.code'),
+    searchParameter('exclude', 'token', 'Group.characteristic.exclude'),
+    searchParameter('identifier', 'token', 'Group.identifier'),
+    searchParameter('managing-entity', 'reference', 'Group.managingEntity'),
+    searchParameter('member', 'reference', 'Group.member.entity'),
+    searchParameter('membership', 'token', 'Group.membership'),
+    searchParameter('name', 'string', 'Group.name'),
+    searchParameter('type', 'token', 'Group.type'),
+    searchParameter('value', 'token', '(Group.characteristic.value.ofType(CodeableConcept)) | (Group.characteristic.value.ofType(boolean))'),
+]);
+/** Canonical Group flat-claim names. Never repeat these storage keys as literals. */
+export const GroupClaim = Object.freeze({
+    Characteristic: 'Group.characteristic',
+    CharacteristicReference: 'Group.characteristic-reference',
+    CharacteristicValue: 'Group.characteristic-value',
+    Code: 'Group.code',
+    Exclude: 'Group.exclude',
+    Identifier: 'Group.identifier',
+    ManagingEntity: 'Group.managing-entity',
+    Member: 'Group.member',
+    Membership: 'Group.membership',
+    Name: 'Group.name',
+    Type: 'Group.type',
+    Value: 'Group.value',
+});
+const standardSearchClaims = Object.freeze(Object.values(GroupClaim));
+/** Canonical claims derived only from the official resource-specific catalogue. */
+export const GroupFlatClaimCatalog = Object.freeze({
+    standardSearch: standardSearchClaims,
+    all: standardSearchClaims,
+});
+/**
+ * Normalizes the members used by an enumerated professional research team.
+ * Every entity is a native PractitionerRole reference; a Practitioner or an
+ * employee identifier cannot substitute for the registered role assignment.
+ */
+export function normalizeGroupPractitionerRoleMembers(input) {
+    if (!Array.isArray(input))
+        throw new TypeError('group_members_invalid');
+    return Object.freeze(input.map((value, index) => {
+        if (!isRecord(value) || containsAuthorizationProperty(value)) {
+            throw new TypeError(containsAuthorizationProperty(value) ? 'group_authorization_property_forbidden' : `group_member_${index}_invalid`);
+        }
+        if (!isRecord(value.entity))
+            throw new TypeError(`group_member_${index}_practitioner_role_reference_invalid`);
+        const reference = optionalString(value.entity.reference);
+        const declaredType = optionalString(value.entity.type);
+        if (!reference || !/^PractitionerRole\/[A-Za-z0-9.-]{1,64}$/.test(reference) || (declaredType && declaredType !== 'PractitionerRole')) {
+            throw new TypeError(`group_member_${index}_practitioner_role_reference_invalid`);
+        }
+        const display = optionalString(value.entity.display);
+        const period = value.period === undefined ? undefined : normalizePeriod(value.period, index);
+        if (value.inactive !== undefined && typeof value.inactive !== 'boolean') {
+            throw new TypeError(`group_member_${index}_inactive_invalid`);
+        }
+        return Object.freeze({
+            entity: Object.freeze({
+                reference: reference,
+                type: 'PractitionerRole',
+                ...(display ? { display } : {}),
+            }),
+            ...(period ? { period } : {}),
+            ...(value.inactive !== undefined ? { inactive: value.inactive } : {}),
+        });
+    }));
+}
+/**
+ * Normalizes the Group profile used to describe an explicit professional
+ * ResearchStudy team. This data is descriptive and authorization-shaped
+ * properties are rejected at every depth.
+ */
+export function normalizeGroupR5ResearchTeam(input) {
+    if (!isRecord(input) || input.resourceType !== 'Group')
+        throw new TypeError('group_resource_invalid');
+    if (containsAuthorizationProperty(input))
+        throw new TypeError('group_authorization_property_forbidden');
+    if (input.type !== 'practitioner')
+        throw new TypeError('group_research_team_type_invalid');
+    if (input.membership !== 'enumerated')
+        throw new TypeError('group_research_team_membership_invalid');
+    const member = normalizeGroupPractitionerRoleMembers(input.member);
+    return Object.freeze({ ...input, type: 'practitioner', membership: 'enumerated', member });
+}
+/**
+ * Projects all populated official resource-specific R5 Group SearchParameters
+ * into flat `resource.meta.claims`. A referenced characteristic is indexed by
+ * `characteristic-reference`, not as the token-valued `value` parameter.
+ *
+ * @see https://hl7.org/fhir/R5/group-search.html
+ */
+export function projectGroupR5SearchClaims(input) {
+    if (!isRecord(input) || input.resourceType !== 'Group')
+        throw new TypeError('group_resource_invalid');
+    if (containsAuthorizationProperty(input))
+        throw new TypeError('group_authorization_property_forbidden');
+    if (!GroupR5TypeCodes.includes(input.type))
+        throw new TypeError('group_type_invalid');
+    if (!GroupR5MembershipCodes.includes(input.membership)) {
+        throw new TypeError('group_membership_invalid');
+    }
+    const characteristics = normalizeRecords(input.characteristic, 'group_characteristic_invalid');
+    const characteristicCodes = characteristics.flatMap(item => conceptTokens(item.code));
+    const characteristicValues = characteristics.flatMap(characteristicTokenValues);
+    const claims = {};
+    addClaim(claims, GroupClaim.Characteristic, characteristicCodes);
+    addClaim(claims, GroupClaim.CharacteristicReference, characteristics.flatMap(item => referenceTokens(item.valueReference)));
+    addClaim(claims, GroupClaim.CharacteristicValue, characteristics.flatMap(item => conceptTokens(item.code).flatMap(code => characteristicTokenValues(item).map(value => `${code}$${value}`))));
+    addClaim(claims, GroupClaim.Code, conceptTokens(input.code));
+    addClaim(claims, GroupClaim.Exclude, characteristics.flatMap(item => typeof item.exclude === 'boolean' ? [String(item.exclude)] : []));
+    addClaim(claims, GroupClaim.Identifier, identifierTokens(input.identifier));
+    addClaim(claims, GroupClaim.ManagingEntity, referenceTokens(input.managingEntity));
+    addClaim(claims, GroupClaim.Member, normalizeRecords(input.member, 'group_members_invalid').flatMap(item => referenceTokens(item.entity)));
+    addClaim(claims, GroupClaim.Membership, [input.membership]);
+    addClaim(claims, GroupClaim.Name, strings(input.name));
+    addClaim(claims, GroupClaim.Type, [input.type]);
+    addClaim(claims, GroupClaim.Value, characteristicValues);
+    return Object.freeze(claims);
+}
+/** Projects native-shaped Group input to the claims-only GW persistence shape. */
+export function projectGroupR5FlatClaimsResource(input) {
+    if (!isRecord(input) || input.resourceType !== 'Group')
+        throw new TypeError('group_resource_invalid');
+    const id = fhirId(input.id, 'group_flat_resource_invalid');
+    if (Array.isArray(input.member) && input.member.length > 0)
+        throw new TypeError('group_members_require_separate_resources');
+    return normalizeGroupR5FlatClaimsResource({
+        resourceType: 'Group',
+        id,
+        meta: { claims: projectGroupR5SearchClaims(input) },
+    });
+}
+/** Projects one correlated claims-only GW resource per PractitionerRole member. */
+export function projectGroupPractitionerRoleMemberFlatClaimResources(input) {
+    const id = fhirId(input.groupId, 'group_flat_resource_invalid');
+    const members = normalizeGroupPractitionerRoleMembers(input.members);
+    return Object.freeze(members.map(member => normalizeGroupR5FlatClaimsResource({
+        resourceType: 'Group',
+        id,
+        meta: {
+            claims: projectGroupR5SearchClaims({
+                resourceType: 'Group',
+                id,
+                type: 'practitioner',
+                membership: 'enumerated',
+                member: [member],
+            }),
+        },
+    })));
+}
+/** Validates and freezes a claims-only Group GW resource. */
+export function normalizeGroupR5FlatClaimsResource(input) {
+    if (!isRecord(input)
+        || input.resourceType !== 'Group'
+        || Object.keys(input).some(key => !['resourceType', 'id', 'meta'].includes(key))) {
+        throw new TypeError('group_flat_resource_invalid');
+    }
+    const id = fhirId(input.id, 'group_flat_resource_invalid');
+    if (!isRecord(input.meta) || !isRecord(input.meta.claims))
+        throw new TypeError('group_flat_resource_invalid');
+    const claims = {};
+    for (const [name, rawValues] of Object.entries(input.meta.claims)) {
+        if (!GroupFlatClaimCatalog.all.includes(name)
+            || !Array.isArray(rawValues)
+            || rawValues.length === 0
+            || rawValues.some(value => typeof value !== 'string' || !value.trim())) {
+            throw new TypeError('group_flat_claim_invalid');
+        }
+        claims[name] = Object.freeze(rawValues.map(value => value.trim()));
+    }
+    return Object.freeze({ resourceType: 'Group', id, meta: Object.freeze({ claims: Object.freeze(claims) }) });
+}
+function addClaim(claims, name, values) {
+    const normalized = [...new Set(values.flatMap(value => strings(value)))];
+    if (normalized.length > 0)
+        claims[name] = Object.freeze(normalized);
+}
+function identifierTokens(value) {
+    return normalizeRecords(value, 'group_identifier_invalid').flatMap(identifier => {
+        const system = optionalString(identifier.system);
+        const identifierValue = optionalString(identifier.value);
+        return identifierValue ? [`${system ? `${system}|` : ''}${identifierValue}`] : [];
+    });
+}
+function conceptTokens(value) {
+    if (!isRecord(value))
+        return [];
+    const coding = normalizeRecords(value.coding, 'group_coding_invalid').flatMap(item => {
+        const system = optionalString(item.system);
+        const code = optionalString(item.code);
+        return code ? [`${system ? `${system}|` : ''}${code}`] : [];
+    });
+    return coding.length > 0 ? coding : strings(value.text);
+}
+function characteristicTokenValues(value) {
+    if (typeof value.valueBoolean === 'boolean')
+        return [String(value.valueBoolean)];
+    return conceptTokens(value.valueCodeableConcept);
+}
+function referenceTokens(value) {
+    return isRecord(value) ? strings(value.reference) : [];
+}
+function normalizeRecords(value, error) {
+    if (value === undefined)
+        return [];
+    if (!Array.isArray(value) || !value.every(isRecord))
+        throw new TypeError(error);
+    return value;
+}
+function normalizePeriod(value, index) {
+    if (!isRecord(value))
+        throw new TypeError(`group_member_${index}_period_invalid`);
+    const start = optionalString(value.start);
+    const end = optionalString(value.end);
+    if (!start && !end)
+        throw new TypeError(`group_member_${index}_period_invalid`);
+    if ((start && !isFhirDateTime(start)) || (end && !isFhirDateTime(end))) {
+        throw new TypeError(`group_member_${index}_period_invalid`);
+    }
+    if (start && end && Date.parse(end) < Date.parse(start))
+        throw new TypeError(`group_member_${index}_period_invalid`);
+    return Object.freeze({ ...(start ? { start } : {}), ...(end ? { end } : {}) });
+}
+function containsAuthorizationProperty(value, seen = new WeakSet()) {
+    if (!value || typeof value !== 'object')
+        return false;
+    if (seen.has(value))
+        return false;
+    seen.add(value);
+    if (Array.isArray(value))
+        return value.some(item => containsAuthorizationProperty(item, seen));
+    return Object.entries(value).some(([name, nested]) => ['authorization', 'permission', 'scope'].includes(name) || containsAuthorizationProperty(nested, seen));
+}
+function strings(value) {
+    const normalized = optionalString(value);
+    return normalized ? [normalized] : [];
+}
+function optionalString(value) {
+    return typeof value === 'string' && value.trim() ? value.trim() : undefined;
+}
+function isFhirDateTime(value) {
+    return /^\d{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12]\d|3[01])(?:T.+)?)?)?$/.test(value);
+}
+function isRecord(value) {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+}
+function fhirId(value, error) {
+    const id = optionalString(value);
+    if (!id || !/^[A-Za-z0-9.-]{1,64}$/.test(id))
+        throw new TypeError(error);
+    return id;
+}

package/dist/imaging-types.d.ts

@@ -0,0 +1,30 @@
+/** Type-only DICOMDIR tree contract recovered from the retired UHC package. */
+export interface DicomDirectoryNode {
+    id: string;
+    uid: string;
+    key: string;
+    expanded?: boolean;
+}
+export interface DicomDirectoryPatient extends DicomDirectoryNode {
+    value: string;
+    children?: DicomDirectoryStudy[];
+}
+export interface DicomDirectoryStudy extends DicomDirectoryNode {
+    description: string;
+    numberOfSeries?: number;
+    numberOfInstances?: number;
+    value: string;
+    children?: DicomDirectorySeries[];
+}
+export interface DicomDirectorySeries extends DicomDirectoryNode {
+    description: string;
+    number: number;
+    value: string;
+    children?: DicomDirectoryInstance[];
+}
+export interface DicomDirectoryInstance extends DicomDirectoryNode {
+    number: number;
+    path: string;
+    sopClassUID: string;
+    value: string;
+}

package/dist/imaging-types.js

@@ -0,0 +1 @@
+export {};

package/dist/immunization-flat-claims.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from `fhir-data-utils-ts/builders/immunization`. */
+export * from './builders/immunization-graph.js';

package/dist/immunization-flat-claims.js

@@ -0,0 +1,2 @@
+/** @deprecated Import from `fhir-data-utils-ts/builders/immunization`. */
+export * from './builders/immunization-graph.js';

package/dist/immunization-reminder-plan.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from `fhir-data-utils-ts/builders/immunization`. */
+export * from './builders/immunization-reminders.js';

package/dist/immunization-reminder-plan.js

@@ -0,0 +1,2 @@
+/** @deprecated Import from `fhir-data-utils-ts/builders/immunization`. */
+export * from './builders/immunization-reminders.js';

package/dist/index.d.ts

@@ -3,3 +3,22 @@ export * from './coding-review-flat-claims.js';
 export * from './search-parameters.js';
 export * from './observation-claims.js';
 export * from './vital-sign-observations.js';
+export * from './claims/index.js';
+export * from './claim-helpers/index.js';
+export * from './converters/index.js';
+export * from './fhir-types.js';
+export * from './fhir-values.js';
+export * from './fhir-search-parameters.js';
+export * from './search-models/index.js';
+export * from './fhir-bundle.js';
+export * from './terminology-models/index.js';
+export * from './constants/index.js';
+export * from './clinical-terminology.js';
+export * from './immunization-flat-claims.js';
+export * from './immunization-reminder-plan.js';
+export * from './builders/index.js';
+export * from './group-r5.js';
+export * from './research-study-r5.js';
+export * from './fhir-tokens.js';
+export * from './related-person.js';
+export * from './imaging-types.js';

package/dist/index.js

@@ -3,3 +3,22 @@ export * from './coding-review-flat-claims.js';
 export * from './search-parameters.js';
 export * from './observation-claims.js';
 export * from './vital-sign-observations.js';
+export * from './claims/index.js';
+export * from './claim-helpers/index.js';
+export * from './converters/index.js';
+export * from './fhir-types.js';
+export * from './fhir-values.js';
+export * from './fhir-search-parameters.js';
+export * from './search-models/index.js';
+export * from './fhir-bundle.js';
+export * from './terminology-models/index.js';
+export * from './constants/index.js';
+export * from './clinical-terminology.js';
+export * from './immunization-flat-claims.js';
+export * from './immunization-reminder-plan.js';
+export * from './builders/index.js';
+export * from './group-r5.js';
+export * from './research-study-r5.js';
+export * from './fhir-tokens.js';
+export * from './related-person.js';
+export * from './imaging-types.js';