vet-data-utils-ts 0.4.12 → 0.5.1

package/README.md

@@ -8,6 +8,21 @@ Current surfaces cover the canonical animal-card DID, veterinary summary
 sections, animal-only emergency data, pseudonymous DigitalTwin search input and
 veterinary assistant intents.
 
+FHIR R5 ResearchStudy screens consume the exact 25 resource-specific search
+parameters and the separate associated-party projection from
+`vet-data-utils-ts/research-study`. The complete `associatedParty` object stays
+beside each flat projection so repeating roles, periods and classifiers cannot
+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,7 +5,9 @@ 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';
 export * from './sectors.js';
 export * from './veterinary-sections.js';

package/dist/index.js

@@ -5,7 +5,9 @@ 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';
 export * from './sectors.js';
 export * from './veterinary-sections.js';

package/dist/research-study.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Browser-safe FHIR R5 ResearchStudy flat-claim contract.
+ *
+ * The standard catalogue is copied from the R5 SearchParameter definitions,
+ * not inferred from similarly named resource elements. In particular, the
+ * `date` SearchParameter targets `ResearchStudy.period`, not the publication
+ * date element. Associated-party projections are indexed separately because
+ * base R5 defines no ResearchStudy party SearchParameter.
+ *
+ * @see https://hl7.org/fhir/R5/researchstudy.html
+ * @see https://hl7.org/fhir/R5/researchstudy-search.html
+ */
+export declare const ResearchStudyR5Version: "5.0.0";
+/**
+ * Immutable codes defined by the FHIR R5 5.0.0 ResearchStudy party-role code
+ * system. The element binding remains extensible; this catalogue is the closed
+ * set a portal may offer by default, not a validator for every conformant
+ * external Coding.
+ *
+ * @see https://hl7.org/fhir/R5/codesystem-research-study-party-role.html
+ */
+export declare const ResearchStudyR5PartyRoleSystem: "http://hl7.org/fhir/research-study-party-role";
+export declare const ResearchStudyR5PartyRoleCodes: readonly ["sponsor", "lead-sponsor", "sponsor-investigator", "primary-investigator", "collaborator", "funding-source", "general-contact", "recruitment-contact", "sub-investigator", "study-director", "study-chair", "irb"];
+export type ResearchStudyR5PartyRoleCode = (typeof ResearchStudyR5PartyRoleCodes)[number];
+export declare const ResearchStudyAssociatedPartyBindings: Readonly<{
+    readonly role: Readonly<{
+        valueSet: "http://hl7.org/fhir/ValueSet/research-study-party-role";
+        strength: "extensible";
+    }>;
+    readonly classifier: Readonly<{
+        valueSet: "http://hl7.org/fhir/ValueSet/research-study-party-organization-type";
+        strength: "example";
+    }>;
+}>;
+export type ResearchStudySearchParameterType = 'composite' | 'date' | 'number' | 'reference' | 'string' | 'token';
+export type ResearchStudyR5SearchParameter = Readonly<{
+    code: string;
+    type: ResearchStudySearchParameterType;
+    expression: string;
+    components: readonly string[];
+}>;
+/** Exact resource-specific SearchParameters published by FHIR R5 5.0.0. */
+export declare const ResearchStudyR5SearchParameterCatalog: readonly ResearchStudyR5SearchParameter[];
+declare const standardSearchClaims: readonly `ResearchStudy.${string}`[];
+declare const associatedPartyClaims: readonly ["ResearchStudy.associated-party-name", "ResearchStudy.associated-party-role", "ResearchStudy.associated-party-period-start", "ResearchStudy.associated-party-period-end", "ResearchStudy.associated-party-classifier", "ResearchStudy.associated-party-party"];
+/**
+ * Governed flat claims for ResearchStudy.
+ *
+ * `standardSearch` contains only official R5 SearchParameters. The
+ * `associatedParty` list is an explicit operational projection of the R5
+ * backbone element; none of those names is advertised as a standard search
+ * parameter and `classifier` never carries CRUD or authorization policy.
+ */
+export declare const ResearchStudyFlatClaimCatalog: Readonly<{
+    standardSearch: readonly `ResearchStudy.${string}`[];
+    associatedParty: readonly ["ResearchStudy.associated-party-name", "ResearchStudy.associated-party-role", "ResearchStudy.associated-party-period-start", "ResearchStudy.associated-party-period-end", "ResearchStudy.associated-party-classifier", "ResearchStudy.associated-party-party"];
+    all: readonly `ResearchStudy.${string}`[];
+}>;
+export type ResearchStudyCoding = Readonly<{
+    system?: string;
+    code?: string;
+    display?: string;
+}>;
+export type ResearchStudyCodeableConcept = Readonly<{
+    coding?: readonly ResearchStudyCoding[];
+    text?: string;
+}>;
+export type ResearchStudyPeriod = Readonly<{
+    start?: string;
+    end?: string;
+}>;
+export type ResearchStudyAssociatedPartyReferenceType = 'Organization' | 'Practitioner' | 'PractitionerRole';
+export type ResearchStudyAssociatedPartyReference = Readonly<{
+    reference: string;
+    type?: ResearchStudyAssociatedPartyReferenceType;
+    display?: string;
+}>;
+export type ResearchStudyAssociatedParty = Readonly<{
+    name?: string;
+    role: ResearchStudyCodeableConcept;
+    period?: readonly ResearchStudyPeriod[];
+    classifier?: readonly ResearchStudyCodeableConcept[];
+    party?: ResearchStudyAssociatedPartyReference;
+}>;
+export type ResearchStudyAssociatedPartyClaimProjection = Readonly<{
+    /** The complete party is retained beside its derived claims to preserve correlation. */
+    associatedParty: ResearchStudyAssociatedParty;
+    claims: Readonly<Record<(typeof associatedPartyClaims)[number], readonly string[]>>;
+}>;
+export type ResearchStudyR5SearchClaim = (typeof standardSearchClaims)[number];
+export type ResearchStudyR5SearchClaims = Readonly<Partial<Record<ResearchStudyR5SearchClaim, readonly string[]>>>;
+/**
+ * Projects the official resource-specific R5 SearchParameters from one native
+ * ResearchStudy into flat `resource.meta.claims`. Composite values use FHIR's
+ * `$` component separator; associatedParty remains a separate projection and
+ * never becomes authorization data.
+ *
+ * @see https://hl7.org/fhir/R5/researchstudy-search.html
+ */
+export declare function projectResearchStudyR5SearchClaims(input: unknown): ResearchStudyR5SearchClaims;
+/**
+ * Normalizes the R5 `associatedParty[]` backbone without flattening parties
+ * into unrelated parallel arrays. This function validates data shape only; it
+ * does not grant study access or interpret classifier values as permissions.
+ */
+export declare function normalizeResearchStudyAssociatedParties(input: unknown): readonly ResearchStudyAssociatedParty[];
+/**
+ * Produces one flat-claim map per associated party. Keeping the normalized
+ * party beside each map preserves the party/role/period/classifier boundary
+ * required when a later Bundle PATCH changes one party.
+ */
+export declare function projectResearchStudyAssociatedPartyClaims(input: unknown): readonly ResearchStudyAssociatedPartyClaimProjection[];
+export {};

package/dist/research-study.js

@@ -0,0 +1,401 @@
+/**
+ * Browser-safe FHIR R5 ResearchStudy flat-claim contract.
+ *
+ * The standard catalogue is copied from the R5 SearchParameter definitions,
+ * not inferred from similarly named resource elements. In particular, the
+ * `date` SearchParameter targets `ResearchStudy.period`, not the publication
+ * date element. Associated-party projections are indexed separately because
+ * base R5 defines no ResearchStudy party SearchParameter.
+ *
+ * @see https://hl7.org/fhir/R5/researchstudy.html
+ * @see https://hl7.org/fhir/R5/researchstudy-search.html
+ */
+export const ResearchStudyR5Version = '5.0.0';
+/**
+ * Immutable codes defined by the FHIR R5 5.0.0 ResearchStudy party-role code
+ * system. The element binding remains extensible; this catalogue is the closed
+ * set a portal may offer by default, not a validator for every conformant
+ * external Coding.
+ *
+ * @see https://hl7.org/fhir/R5/codesystem-research-study-party-role.html
+ */
+export const ResearchStudyR5PartyRoleSystem = 'http://hl7.org/fhir/research-study-party-role';
+export const ResearchStudyR5PartyRoleCodes = Object.freeze([
+    'sponsor',
+    'lead-sponsor',
+    'sponsor-investigator',
+    'primary-investigator',
+    'collaborator',
+    'funding-source',
+    'general-contact',
+    'recruitment-contact',
+    'sub-investigator',
+    'study-director',
+    'study-chair',
+    'irb',
+]);
+export const ResearchStudyAssociatedPartyBindings = Object.freeze({
+    role: Object.freeze({
+        valueSet: 'http://hl7.org/fhir/ValueSet/research-study-party-role',
+        strength: 'extensible',
+    }),
+    classifier: Object.freeze({
+        valueSet: 'http://hl7.org/fhir/ValueSet/research-study-party-organization-type',
+        strength: 'example',
+    }),
+});
+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 ResearchStudyR5SearchParameterCatalog = Object.freeze([
+    searchParameter('classifier', 'token', 'ResearchStudy.classifier'),
+    searchParameter('condition', 'token', 'ResearchStudy.condition'),
+    searchParameter('date', 'date', 'ResearchStudy.period'),
+    searchParameter('description', 'string', 'ResearchStudy.description'),
+    searchParameter('eligibility', 'reference', 'ResearchStudy.recruitment.eligibility'),
+    searchParameter('focus-code', 'token', 'ResearchStudy.focus.concept'),
+    searchParameter('focus-reference', 'reference', 'ResearchStudy.focus.reference'),
+    searchParameter('identifier', 'token', 'ResearchStudy.identifier'),
+    searchParameter('keyword', 'token', 'ResearchStudy.keyword'),
+    searchParameter('name', 'string', 'ResearchStudy.name'),
+    searchParameter('objective-description', 'string', 'ResearchStudy.objective.description'),
+    searchParameter('objective-type', 'token', 'ResearchStudy.objective.type'),
+    searchParameter('part-of', 'reference', 'ResearchStudy.partOf'),
+    searchParameter('phase', 'token', 'ResearchStudy.phase'),
+    searchParameter('progress-status-state-actual', 'composite', 'ResearchStudy.progressStatus', [
+        'http://hl7.org/fhir/SearchParameter/ResearchStudy-state',
+        'http://hl7.org/fhir/SearchParameter/ResearchStudy-actual',
+    ]),
+    searchParameter('progress-status-state-period', 'composite', 'ResearchStudy.progressStatus', [
+        'http://hl7.org/fhir/SearchParameter/ResearchStudy-state',
+        'http://hl7.org/fhir/SearchParameter/ResearchStudy-period',
+    ]),
+    searchParameter('progress-status-state-period-actual', 'composite', 'ResearchStudy.progressStatus', [
+        'http://hl7.org/fhir/SearchParameter/ResearchStudy-state',
+        'http://hl7.org/fhir/SearchParameter/ResearchStudy-period',
+        'http://hl7.org/fhir/SearchParameter/ResearchStudy-actual',
+    ]),
+    searchParameter('protocol', 'reference', 'ResearchStudy.protocol'),
+    searchParameter('recruitment-actual', 'number', 'ResearchStudy.recruitment.actualNumber'),
+    searchParameter('recruitment-target', 'number', 'ResearchStudy.recruitment.targetNumber'),
+    searchParameter('region', 'token', 'ResearchStudy.region'),
+    searchParameter('site', 'reference', 'ResearchStudy.site'),
+    searchParameter('status', 'token', 'ResearchStudy.status'),
+    searchParameter('study-design', 'token', 'ResearchStudy.studyDesign'),
+    searchParameter('title', 'string', 'ResearchStudy.title'),
+]);
+const standardSearchClaims = Object.freeze(ResearchStudyR5SearchParameterCatalog.map(parameter => `ResearchStudy.${parameter.code}`));
+const associatedPartyClaims = Object.freeze([
+    'ResearchStudy.associated-party-name',
+    'ResearchStudy.associated-party-role',
+    'ResearchStudy.associated-party-period-start',
+    'ResearchStudy.associated-party-period-end',
+    'ResearchStudy.associated-party-classifier',
+    'ResearchStudy.associated-party-party',
+]);
+/**
+ * Governed flat claims for ResearchStudy.
+ *
+ * `standardSearch` contains only official R5 SearchParameters. The
+ * `associatedParty` list is an explicit operational projection of the R5
+ * backbone element; none of those names is advertised as a standard search
+ * parameter and `classifier` never carries CRUD or authorization policy.
+ */
+export const ResearchStudyFlatClaimCatalog = Object.freeze({
+    standardSearch: standardSearchClaims,
+    associatedParty: associatedPartyClaims,
+    all: Object.freeze([...standardSearchClaims, ...associatedPartyClaims]),
+});
+/**
+ * Projects the official resource-specific R5 SearchParameters from one native
+ * ResearchStudy into flat `resource.meta.claims`. Composite values use FHIR's
+ * `$` component separator; associatedParty remains a separate projection and
+ * never becomes authorization data.
+ *
+ * @see https://hl7.org/fhir/R5/researchstudy-search.html
+ */
+export function projectResearchStudyR5SearchClaims(input) {
+    if (!isRecord(input) || input.resourceType !== 'ResearchStudy') {
+        throw new TypeError('research_study_resource_invalid');
+    }
+    const claims = {};
+    addClaim(claims, 'ResearchStudy.classifier', conceptsValue(input.classifier, 'research_study_classifier_invalid'));
+    addClaim(claims, 'ResearchStudy.condition', conceptsValue(input.condition, 'research_study_condition_invalid'));
+    addClaim(claims, 'ResearchStudy.date', periodValues(input.period, 'research_study_period_invalid'));
+    addClaim(claims, 'ResearchStudy.description', strings(input.description));
+    addClaim(claims, 'ResearchStudy.eligibility', references(input.recruitment, 'eligibility'));
+    addClaim(claims, 'ResearchStudy.focus-code', codeableReferences(input.focus, 'concept'));
+    addClaim(claims, 'ResearchStudy.focus-reference', codeableReferences(input.focus, 'reference'));
+    addClaim(claims, 'ResearchStudy.identifier', identifiers(input.identifier));
+    addClaim(claims, 'ResearchStudy.keyword', conceptsValue(input.keyword, 'research_study_keyword_invalid'));
+    addClaim(claims, 'ResearchStudy.name', strings(input.name));
+    addClaim(claims, 'ResearchStudy.objective-description', backboneStrings(input.objective, 'description'));
+    addClaim(claims, 'ResearchStudy.objective-type', backboneConcepts(input.objective, 'type'));
+    addClaim(claims, 'ResearchStudy.part-of', references(input.partOf));
+    addClaim(claims, 'ResearchStudy.phase', conceptsValue(input.phase, 'research_study_phase_invalid'));
+    const progress = progressStatusValues(input.progressStatus);
+    addClaim(claims, 'ResearchStudy.progress-status-state-actual', progress.stateActual);
+    addClaim(claims, 'ResearchStudy.progress-status-state-period', progress.statePeriod);
+    addClaim(claims, 'ResearchStudy.progress-status-state-period-actual', progress.statePeriodActual);
+    addClaim(claims, 'ResearchStudy.protocol', references(input.protocol));
+    addClaim(claims, 'ResearchStudy.recruitment-actual', nestedNumber(input.recruitment, 'actualNumber'));
+    addClaim(claims, 'ResearchStudy.recruitment-target', nestedNumber(input.recruitment, 'targetNumber'));
+    addClaim(claims, 'ResearchStudy.region', conceptsValue(input.region, 'research_study_region_invalid'));
+    addClaim(claims, 'ResearchStudy.site', references(input.site));
+    addClaim(claims, 'ResearchStudy.status', strings(input.status));
+    addClaim(claims, 'ResearchStudy.study-design', conceptsValue(input.studyDesign, 'research_study_design_invalid'));
+    addClaim(claims, 'ResearchStudy.title', strings(input.title));
+    return Object.freeze(claims);
+}
+/**
+ * Normalizes the R5 `associatedParty[]` backbone without flattening parties
+ * into unrelated parallel arrays. This function validates data shape only; it
+ * does not grant study access or interpret classifier values as permissions.
+ */
+export function normalizeResearchStudyAssociatedParties(input) {
+    if (!Array.isArray(input))
+        throw new TypeError('research_study_associated_parties_invalid');
+    return Object.freeze(input.map((value, index) => normalizeAssociatedParty(value, index)));
+}
+/**
+ * Produces one flat-claim map per associated party. Keeping the normalized
+ * party beside each map preserves the party/role/period/classifier boundary
+ * required when a later Bundle PATCH changes one party.
+ */
+export function projectResearchStudyAssociatedPartyClaims(input) {
+    const parties = normalizeResearchStudyAssociatedParties(input);
+    return Object.freeze(parties.map(party => Object.freeze({
+        associatedParty: party,
+        claims: Object.freeze({
+            'ResearchStudy.associated-party-name': Object.freeze(party.name ? [party.name] : []),
+            'ResearchStudy.associated-party-role': Object.freeze(conceptValues([party.role])),
+            'ResearchStudy.associated-party-period-start': Object.freeze((party.period || []).flatMap(period => period.start ? [period.start] : [])),
+            'ResearchStudy.associated-party-period-end': Object.freeze((party.period || []).flatMap(period => period.end ? [period.end] : [])),
+            'ResearchStudy.associated-party-classifier': Object.freeze(conceptValues(party.classifier || [])),
+            'ResearchStudy.associated-party-party': Object.freeze(party.party ? [party.party.reference] : []),
+        }),
+    })));
+}
+function normalizeAssociatedParty(value, index) {
+    if (!isRecord(value))
+        throw new TypeError(`research_study_associated_party_${index}_invalid`);
+    const role = normalizeConcept(value.role, `research_study_associated_party_${index}_role_required`);
+    const name = optionalString(value.name);
+    const period = value.period === undefined
+        ? undefined
+        : normalizePeriods(value.period, index);
+    const classifier = value.classifier === undefined
+        ? undefined
+        : normalizeConcepts(value.classifier, `research_study_associated_party_${index}_classifier_invalid`);
+    const party = value.party === undefined ? undefined : normalizePartyReference(value.party, index);
+    return Object.freeze({
+        ...(name ? { name } : {}),
+        role,
+        ...(period ? { period } : {}),
+        ...(classifier ? { classifier } : {}),
+        ...(party ? { party } : {}),
+    });
+}
+function normalizeConcepts(value, error) {
+    if (!Array.isArray(value))
+        throw new TypeError(error);
+    return Object.freeze(value.map(item => normalizeConcept(item, error)));
+}
+function normalizeConcept(value, error) {
+    if (!isRecord(value))
+        throw new TypeError(error);
+    const text = optionalString(value.text);
+    let coding;
+    if (value.coding !== undefined) {
+        if (!Array.isArray(value.coding))
+            throw new TypeError(error);
+        coding = Object.freeze(value.coding.map(item => normalizeCoding(item, error)));
+    }
+    if (!text && (!coding || coding.length === 0 || !coding.some(item => item.code)))
+        throw new TypeError(error);
+    return Object.freeze({ ...(coding ? { coding } : {}), ...(text ? { text } : {}) });
+}
+function normalizeCoding(value, error) {
+    if (!isRecord(value))
+        throw new TypeError(error);
+    const system = optionalString(value.system);
+    const code = optionalString(value.code);
+    const display = optionalString(value.display);
+    if (!code && !display)
+        throw new TypeError(error);
+    return Object.freeze({ ...(system ? { system } : {}), ...(code ? { code } : {}), ...(display ? { display } : {}) });
+}
+function normalizePeriods(value, index) {
+    if (!Array.isArray(value))
+        throw new TypeError(`research_study_associated_party_${index}_period_invalid`);
+    return Object.freeze(value.map(item => {
+        if (!isRecord(item))
+            throw new TypeError(`research_study_associated_party_${index}_period_invalid`);
+        const start = optionalString(item.start);
+        const end = optionalString(item.end);
+        if (!start && !end)
+            throw new TypeError(`research_study_associated_party_${index}_period_invalid`);
+        if ((start && !isFhirDateTime(start)) || (end && !isFhirDateTime(end))) {
+            throw new TypeError(`research_study_associated_party_${index}_period_invalid`);
+        }
+        if (start && end && Date.parse(end) < Date.parse(start)) {
+            throw new TypeError(`research_study_associated_party_${index}_period_invalid`);
+        }
+        return Object.freeze({ ...(start ? { start } : {}), ...(end ? { end } : {}) });
+    }));
+}
+function normalizePartyReference(value, index) {
+    const error = `research_study_associated_party_${index}_party_reference_invalid`;
+    if (!isRecord(value))
+        throw new TypeError(error);
+    const reference = optionalString(value.reference);
+    const type = optionalString(value.type);
+    const display = optionalString(value.display);
+    if (!reference)
+        throw new TypeError(error);
+    const allowed = ['Organization', 'Practitioner', 'PractitionerRole'];
+    if (type && !allowed.includes(type))
+        throw new TypeError(error);
+    const relativeType = reference.match(/^(Organization|Practitioner|PractitionerRole|[A-Z][A-Za-z]+)\//)?.[1];
+    if (relativeType && !allowed.includes(relativeType))
+        throw new TypeError(error);
+    return Object.freeze({
+        reference,
+        ...(type ? { type: type } : {}),
+        ...(display ? { display } : {}),
+    });
+}
+function conceptValues(concepts) {
+    return concepts.flatMap(concept => {
+        const coded = (concept.coding || []).flatMap(coding => coding.code
+            ? [`${coding.system ? `${coding.system}|` : ''}${coding.code}`]
+            : []);
+        return coded.length > 0 ? coded : concept.text ? [concept.text] : [];
+    });
+}
+function addClaim(claims, name, values) {
+    if (values.length > 0)
+        claims[name] = Object.freeze([...values]);
+}
+function strings(value) {
+    const result = optionalString(value);
+    return result ? [result] : [];
+}
+function conceptsValue(value, error) {
+    if (value === undefined)
+        return [];
+    const concepts = Array.isArray(value)
+        ? normalizeConcepts(value, error)
+        : Object.freeze([normalizeConcept(value, error)]);
+    return conceptValues(concepts);
+}
+function references(value, nestedKey) {
+    let candidate = value;
+    if (nestedKey) {
+        if (!isRecord(value))
+            return [];
+        candidate = value[nestedKey];
+    }
+    if (candidate === undefined)
+        return [];
+    const items = Array.isArray(candidate) ? candidate : [candidate];
+    return items.flatMap(item => isRecord(item) && optionalString(item.reference) ? [String(item.reference).trim()] : []);
+}
+function identifiers(value) {
+    if (value === undefined)
+        return [];
+    if (!Array.isArray(value))
+        throw new TypeError('research_study_identifier_invalid');
+    return value.flatMap(item => {
+        if (!isRecord(item))
+            throw new TypeError('research_study_identifier_invalid');
+        const system = optionalString(item.system);
+        const identifier = optionalString(item.value);
+        return identifier ? [`${system ? `${system}|` : ''}${identifier}`] : [];
+    });
+}
+function periodValues(value, error) {
+    if (value === undefined)
+        return [];
+    if (!isRecord(value))
+        throw new TypeError(error);
+    const start = optionalString(value.start);
+    const end = optionalString(value.end);
+    if ((start && !isFhirDateTime(start)) || (end && !isFhirDateTime(end)))
+        throw new TypeError(error);
+    return [start, end].filter((item) => Boolean(item));
+}
+function codeableReferences(value, key) {
+    if (value === undefined)
+        return [];
+    if (!Array.isArray(value))
+        throw new TypeError('research_study_focus_invalid');
+    return value.flatMap(item => {
+        if (!isRecord(item))
+            throw new TypeError('research_study_focus_invalid');
+        return key === 'concept'
+            ? conceptsValue(item.concept, 'research_study_focus_invalid')
+            : references(item.reference);
+    });
+}
+function backboneStrings(value, key) {
+    if (value === undefined)
+        return [];
+    if (!Array.isArray(value))
+        throw new TypeError('research_study_backbone_invalid');
+    return value.flatMap(item => isRecord(item) ? strings(item[key]) : []);
+}
+function backboneConcepts(value, key) {
+    if (value === undefined)
+        return [];
+    if (!Array.isArray(value))
+        throw new TypeError('research_study_backbone_invalid');
+    return value.flatMap(item => isRecord(item) ? conceptsValue(item[key], 'research_study_backbone_invalid') : []);
+}
+function nestedNumber(value, key) {
+    if (!isRecord(value) || value[key] === undefined)
+        return [];
+    const number = Number(value[key]);
+    if (!Number.isInteger(number) || number < 0)
+        throw new TypeError('research_study_recruitment_invalid');
+    return [String(number)];
+}
+function progressStatusValues(value) {
+    const result = { stateActual: [], statePeriod: [], statePeriodActual: [] };
+    if (value === undefined)
+        return result;
+    if (!Array.isArray(value))
+        throw new TypeError('research_study_progress_status_invalid');
+    for (const item of value) {
+        if (!isRecord(item))
+            throw new TypeError('research_study_progress_status_invalid');
+        const states = conceptsValue(item.state, 'research_study_progress_status_invalid');
+        const dates = periodValues(item.period, 'research_study_progress_status_invalid');
+        const actual = typeof item.actual === 'boolean' ? String(item.actual) : undefined;
+        for (const state of states) {
+            if (actual)
+                result.stateActual.push(`${state}$${actual}`);
+            for (const date of dates) {
+                result.statePeriod.push(`${state}$${date}`);
+                if (actual)
+                    result.statePeriodActual.push(`${state}$${date}$${actual}`);
+            }
+        }
+    }
+    return result;
+}
+function optionalString(value) {
+    const normalized = typeof value === 'string' ? value.trim() : '';
+    return normalized || undefined;
+}
+function isFhirDateTime(value) {
+    return /^\d{4}(?:-\d{2}(?:-\d{2}(?:T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2}))?)?)?$/.test(value)
+        && !Number.isNaN(Date.parse(value));
+}
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vet-data-utils-ts",
-  "version": "0.4.12",
+  "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"
@@ -44,6 +48,10 @@
       "types": "./dist/organization-application.d.ts",
       "default": "./dist/organization-application.js"
     },
+    "./research-study": {
+      "types": "./dist/research-study.d.ts",
+      "default": "./dist/research-study.js"
+    },
     "./sectors": {
       "types": "./dist/sectors.d.ts",
       "default": "./dist/sectors.js"