vet-data-utils-ts 0.5.0 → 0.5.1

package/README.md

@@ -16,6 +16,13 @@ be attributed to the wrong party. A party classifier describes an organization
 category; it never represents Consent or CRUDS authorization. See
 [`docs/research-study-r5-contract.md`](docs/research-study-r5-contract.md).
 
+ResearchStudy professional teams use native FHIR R5 Group resources from
+`vet-data-utils-ts/group`: required type and membership codes, the exact twelve
+resource-specific SearchParameters, canonical flat claim projection and
+enumerated PractitionerRole member normalization. Group membership is
+descriptive and never carries authorization, permission or scope. See
+[`docs/group-r5-contract.md`](docs/group-r5-contract.md).
+
 Reusable Communication screens receive immutable workflow presets from
 `vet-data-utils-ts/communication`. The research-agreement screen is fixed to
 FHIR `notification` plus HL7 v3 ActReason `HRESCH` and does not expose a topic

package/dist/group.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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[];
+declare const standardSearchClaims: readonly `Group.${string}`[];
+/** Canonical claims derived only from the official resource-specific catalogue. */
+export declare const GroupFlatClaimCatalog: Readonly<{
+    standardSearch: readonly `Group.${string}`[];
+    all: readonly `Group.${string}`[];
+}>;
+export type GroupR5SearchClaim = (typeof standardSearchClaims)[number];
+export type GroupR5SearchClaims = Readonly<Partial<Record<GroupR5SearchClaim, 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;
+export {};

package/dist/group.js

@@ -0,0 +1,227 @@
+/**
+ * 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))'),
+]);
+const standardSearchClaims = Object.freeze(GroupR5SearchParameterCatalog.map(parameter => `Group.${parameter.code}`));
+/** 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, 'Group.characteristic', characteristicCodes);
+    addClaim(claims, 'Group.characteristic-reference', characteristics.flatMap(item => referenceTokens(item.valueReference)));
+    addClaim(claims, 'Group.characteristic-value', characteristics.flatMap(item => conceptTokens(item.code).flatMap(code => characteristicTokenValues(item).map(value => `${code}$${value}`))));
+    addClaim(claims, 'Group.code', conceptTokens(input.code));
+    addClaim(claims, 'Group.exclude', characteristics.flatMap(item => typeof item.exclude === 'boolean' ? [String(item.exclude)] : []));
+    addClaim(claims, 'Group.identifier', identifierTokens(input.identifier));
+    addClaim(claims, 'Group.managing-entity', referenceTokens(input.managingEntity));
+    addClaim(claims, 'Group.member', normalizeRecords(input.member, 'group_members_invalid').flatMap(item => referenceTokens(item.entity)));
+    addClaim(claims, 'Group.membership', [input.membership]);
+    addClaim(claims, 'Group.name', strings(input.name));
+    addClaim(claims, 'Group.type', [input.type]);
+    addClaim(claims, 'Group.value', characteristicValues);
+    return 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);
+}

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * from './clinical-terminology.js';
 export * from './digital-twin.js';
 export * from './emergency.js';
 export * from './financial.js';
+export * from './group.js';
 export * from './iso-jurisdictions.js';
 export * from './organization-application.js';
 export * from './research-study.js';

package/dist/index.js

@@ -5,6 +5,7 @@ export * from './clinical-terminology.js';
 export * from './digital-twin.js';
 export * from './emergency.js';
 export * from './financial.js';
+export * from './group.js';
 export * from './iso-jurisdictions.js';
 export * from './organization-application.js';
 export * from './research-study.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-data-utils-ts",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Browser-safe governed VetChain data contracts",
   "license": "Apache-2.0",
   "author": "Connecting Solution & Applications Ltd",
@@ -36,6 +36,10 @@
       "types": "./dist/financial.d.ts",
       "default": "./dist/financial.js"
     },
+    "./group": {
+      "types": "./dist/group.d.ts",
+      "default": "./dist/group.js"
+    },
     "./iso-jurisdictions": {
       "types": "./dist/iso-jurisdictions.d.ts",
       "default": "./dist/iso-jurisdictions.js"