gdc-common-utils-ts 1.23.0 → 1.24.0

package/dist/constants/data-capabilities.js

@@ -0,0 +1,126 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+// Always create JSDoc, do not use strings inline in keys nor values, use types instead, and reuse the data test examples.
+/**
+ * Canonical operation vocabulary for data authorization.
+ *
+ * This axis answers:
+ * - what the actor wants to do with the data
+ *
+ * Keep this separate from actor/workflow capabilities such as
+ * `HostingDisableHost` or `IndividualBootstrap`.
+ */
+export const DataCapabilityActions = Object.freeze({
+    View: 'View',
+    Create: 'Create',
+    Update: 'Update',
+    Send: 'Send',
+    Search: 'Search',
+    Index: 'Index',
+    Purge: 'Purge',
+});
+/**
+ * Canonical semantic domains for data authorization.
+ *
+ * This axis answers:
+ * - which business or clinical domain the data belongs to
+ *
+ * Important modeling rule:
+ * - a `Bundle` of `Appointment` data is not equivalent to a `Bundle` of
+ *   `Health`, `Veterinary`, `Research`, or `Insurance` data
+ * - the real authorization decision depends on the semantic domain carried by
+ *   the payload, not just on the FHIR envelope or transport shape
+ */
+export const DataCapabilityDomains = Object.freeze({
+    Appointment: 'Appointment',
+    Health: 'Health',
+    Veterinary: 'Veterinary',
+    Research: 'Research',
+    Insurance: 'Insurance',
+    Billing: 'Billing',
+    Identity: 'Identity',
+    Consent: 'Consent',
+});
+/**
+ * Canonical representation or transport vocabulary for data authorization.
+ *
+ * This axis answers:
+ * - how the data is represented or exchanged technically
+ *
+ * A `Bundle` is only the FHIR container or exchange envelope.
+ * Authorization must still look at the semantic domain of the contained data.
+ */
+export const DataCapabilityRepresentations = Object.freeze({
+    Bundle: 'Bundle',
+    Resource: 'Resource',
+    DocumentReference: 'DocumentReference',
+    Attachment: 'Attachment',
+    Claims: 'Claims',
+    Invoice: 'Invoice',
+    Communication: 'Communication',
+});
+/**
+ * Builds the canonical string key for one data capability descriptor.
+ */
+export function buildDataCapabilityKey(input) {
+    return `${input.action}.${input.representation}.${input.domain}`;
+}
+/**
+ * Parses one canonical string capability back into its structured form.
+ */
+export function parseDataCapabilityKey(input) {
+    const [action, representation, domain, ...rest] = String(input || '').trim().split('.');
+    if (rest.length > 0)
+        return undefined;
+    if (!Object.values(DataCapabilityActions).includes(action))
+        return undefined;
+    if (!Object.values(DataCapabilityRepresentations).includes(representation))
+        return undefined;
+    if (!Object.values(DataCapabilityDomains).includes(domain))
+        return undefined;
+    return {
+        action: action,
+        representation: representation,
+        domain: domain,
+    };
+}
+/**
+ * Reference examples kept in code so authorization discussions do not get lost
+ * in docs or chat history.
+ */
+export const ExampleDataCapabilities = Object.freeze({
+    CreateBundleAppointment: buildDataCapabilityKey({
+        action: DataCapabilityActions.Create,
+        representation: DataCapabilityRepresentations.Bundle,
+        domain: DataCapabilityDomains.Appointment,
+    }),
+    SendBundleAppointment: buildDataCapabilityKey({
+        action: DataCapabilityActions.Send,
+        representation: DataCapabilityRepresentations.Bundle,
+        domain: DataCapabilityDomains.Appointment,
+    }),
+    ViewResourceHealth: buildDataCapabilityKey({
+        action: DataCapabilityActions.View,
+        representation: DataCapabilityRepresentations.Resource,
+        domain: DataCapabilityDomains.Health,
+    }),
+    ViewBundleHealth: buildDataCapabilityKey({
+        action: DataCapabilityActions.View,
+        representation: DataCapabilityRepresentations.Bundle,
+        domain: DataCapabilityDomains.Health,
+    }),
+    SendDocumentReferenceInsurance: buildDataCapabilityKey({
+        action: DataCapabilityActions.Send,
+        representation: DataCapabilityRepresentations.DocumentReference,
+        domain: DataCapabilityDomains.Insurance,
+    }),
+    ViewInvoiceBilling: buildDataCapabilityKey({
+        action: DataCapabilityActions.View,
+        representation: DataCapabilityRepresentations.Invoice,
+        domain: DataCapabilityDomains.Billing,
+    }),
+    SearchBundleResearch: buildDataCapabilityKey({
+        action: DataCapabilityActions.Search,
+        representation: DataCapabilityRepresentations.Bundle,
+        domain: DataCapabilityDomains.Research,
+    }),
+});

package/dist/constants/index.d.ts

@@ -1,6 +1,7 @@
 export * from './actor-session';
 export * from './communication';
 export * from './cryptography';
+export * from './data-capabilities';
 export * from './dataspace-discovery';
 export * from './dataspace-protocol';
 export * from './device';

package/dist/constants/index.js

@@ -1,6 +1,7 @@
 export * from './actor-session.js';
 export * from './communication.js';
 export * from './cryptography.js';
+export * from './data-capabilities.js';
 export * from './dataspace-discovery.js';
 export * from './dataspace-protocol.js';
 export * from './device.js';

package/dist/constants/lifecycle.d.ts

@@ -14,4 +14,7 @@ export declare const InteroperableContext: Readonly<{
 export declare const LifecycleRequestType: Readonly<{
     readonly RelatedPersonDisable: "RelatedPerson-disable-request-v1.0";
     readonly RelatedPersonPurge: "RelatedPerson-purge-request-v1.0";
+    readonly TenantEnable: "Organization-enable-request-v1.0";
+    readonly TenantDisable: "Organization-disable-request-v1.0";
+    readonly TenantPurge: "Organization-purge-request-v1.0";
 }>;

package/dist/constants/lifecycle.js

@@ -15,4 +15,7 @@ export const InteroperableContext = Object.freeze({
 export const LifecycleRequestType = Object.freeze({
     RelatedPersonDisable: 'RelatedPerson-disable-request-v1.0',
     RelatedPersonPurge: 'RelatedPerson-purge-request-v1.0',
+    TenantEnable: 'Organization-enable-request-v1.0',
+    TenantDisable: 'Organization-disable-request-v1.0',
+    TenantPurge: 'Organization-purge-request-v1.0',
 });

package/dist/constants/service-capabilities.d.ts

@@ -3,6 +3,13 @@
  * `org.schema.Service.serviceType`.
  */
 export declare const ServiceCapability: {
+    /**
+     * Hosting/operator capability to manage hosted tenant organizations.
+     *
+     * This is the canonical service authorization that allows a hosting operator
+     * to activate, disable, and purge hosted legal organizations.
+     */
+    readonly OrganizationRegistryProvider: "organization/Organization.cruds";
     readonly IndexReader: "organization/Composition.rs";
     readonly IndexProvider: "organization/Composition.cruds";
     readonly DigitalTwinReader: "organization/ResearchSubject.rs";
@@ -14,6 +21,7 @@ export type ServiceCapabilityValue = typeof ServiceCapability[keyof typeof Servi
  * values.
  */
 export declare const ServiceCapabilityKind: {
+    readonly OrganizationRegistry: "organization/organization";
     readonly Indexing: "organization/composition";
     readonly DigitalTwin: "organization/researchsubject";
 };
@@ -22,6 +30,7 @@ export type ServiceCapabilityKindValue = typeof ServiceCapabilityKind[keyof type
  * @deprecated Legacy serviceType values accepted for backward compatibility.
  */
 export declare const DeprecatedServiceCapabilityToken: {
+    readonly OrganizationRegistryProvider: "organization-registry.cruds";
     readonly IndexReader: "indexing.rs";
     readonly IndexProvider: "indexing.cruds";
     readonly DigitalTwinReader: "digitaltwin.rs";
@@ -35,10 +44,15 @@ export type DeprecatedServiceCapabilityTokenValue = typeof DeprecatedServiceCapa
  * `ServiceCapabilityToken`.
  */
 export declare const ServiceCapabilityToken: {
+    readonly OrganizationRegistryProvider: "organization/Organization.cruds";
     readonly IndexReader: "organization/Composition.rs";
     readonly IndexProvider: "organization/Composition.cruds";
     readonly DigitalTwinReader: "organization/ResearchSubject.rs";
     readonly DigitalTwinProvider: "organization/ResearchSubject.cruds";
+    /**
+     * @deprecated Prefer `OrganizationRegistryProvider`.
+     */
+    readonly OrganizationRegistryCruds: "organization/Organization.cruds";
     /**
      * @deprecated Prefer `IndexReader`.
      */
@@ -55,6 +69,12 @@ export declare const ServiceCapabilityToken: {
      * @deprecated Prefer `DigitalTwinProvider`.
      */
     readonly DigitalTwinCruds: "organization/ResearchSubject.cruds";
+    /**
+     * @deprecated Prefer `ServiceCapability.OrganizationRegistryProvider`.
+     * Legacy persisted value kept for compatibility while external payloads
+     * still emit `organization-registry.cruds`.
+     */
+    readonly LegacyOrganizationRegistryProvider: "organization-registry.cruds";
     /**
      * @deprecated Prefer `ServiceCapability.IndexReader`.
      * Legacy persisted value kept for compatibility while external payloads

package/dist/constants/service-capabilities.js

@@ -5,6 +5,13 @@
  * `org.schema.Service.serviceType`.
  */
 export const ServiceCapability = {
+    /**
+     * Hosting/operator capability to manage hosted tenant organizations.
+     *
+     * This is the canonical service authorization that allows a hosting operator
+     * to activate, disable, and purge hosted legal organizations.
+     */
+    OrganizationRegistryProvider: 'organization/Organization.cruds',
     IndexReader: 'organization/Composition.rs',
     IndexProvider: 'organization/Composition.cruds',
     DigitalTwinReader: 'organization/ResearchSubject.rs',
@@ -15,6 +22,7 @@ export const ServiceCapability = {
  * values.
  */
 export const ServiceCapabilityKind = {
+    OrganizationRegistry: 'organization/organization',
     Indexing: 'organization/composition',
     DigitalTwin: 'organization/researchsubject',
 };
@@ -22,6 +30,7 @@ export const ServiceCapabilityKind = {
  * @deprecated Legacy serviceType values accepted for backward compatibility.
  */
 export const DeprecatedServiceCapabilityToken = {
+    OrganizationRegistryProvider: 'organization-registry.cruds',
     IndexReader: 'indexing.rs',
     IndexProvider: 'indexing.cruds',
     DigitalTwinReader: 'digitaltwin.rs',
@@ -34,10 +43,15 @@ export const DeprecatedServiceCapabilityToken = {
  * `ServiceCapabilityToken`.
  */
 export const ServiceCapabilityToken = {
+    OrganizationRegistryProvider: ServiceCapability.OrganizationRegistryProvider,
     IndexReader: ServiceCapability.IndexReader,
     IndexProvider: ServiceCapability.IndexProvider,
     DigitalTwinReader: ServiceCapability.DigitalTwinReader,
     DigitalTwinProvider: ServiceCapability.DigitalTwinProvider,
+    /**
+     * @deprecated Prefer `OrganizationRegistryProvider`.
+     */
+    OrganizationRegistryCruds: ServiceCapability.OrganizationRegistryProvider,
     /**
      * @deprecated Prefer `IndexReader`.
      */
@@ -54,6 +68,12 @@ export const ServiceCapabilityToken = {
      * @deprecated Prefer `DigitalTwinProvider`.
      */
     DigitalTwinCruds: ServiceCapability.DigitalTwinProvider,
+    /**
+     * @deprecated Prefer `ServiceCapability.OrganizationRegistryProvider`.
+     * Legacy persisted value kept for compatibility while external payloads
+     * still emit `organization-registry.cruds`.
+     */
+    LegacyOrganizationRegistryProvider: DeprecatedServiceCapabilityToken.OrganizationRegistryProvider,
     /**
      * @deprecated Prefer `ServiceCapability.IndexReader`.
      * Legacy persisted value kept for compatibility while external payloads
@@ -80,10 +100,12 @@ export const ServiceCapabilityToken = {
     LegacyDigitalTwinProvider: DeprecatedServiceCapabilityToken.DigitalTwinProvider,
 };
 const CANONICAL_SERVICE_CAPABILITY_BY_VALUE = new Map([
+    [String(ServiceCapability.OrganizationRegistryProvider).toLowerCase(), ServiceCapability.OrganizationRegistryProvider],
     [String(ServiceCapability.IndexReader).toLowerCase(), ServiceCapability.IndexReader],
     [String(ServiceCapability.IndexProvider).toLowerCase(), ServiceCapability.IndexProvider],
     [String(ServiceCapability.DigitalTwinReader).toLowerCase(), ServiceCapability.DigitalTwinReader],
     [String(ServiceCapability.DigitalTwinProvider).toLowerCase(), ServiceCapability.DigitalTwinProvider],
+    [String(DeprecatedServiceCapabilityToken.OrganizationRegistryProvider).toLowerCase(), ServiceCapability.OrganizationRegistryProvider],
     [String(DeprecatedServiceCapabilityToken.IndexReader).toLowerCase(), ServiceCapability.IndexReader],
     [String(DeprecatedServiceCapabilityToken.IndexProvider).toLowerCase(), ServiceCapability.IndexProvider],
     [String(DeprecatedServiceCapabilityToken.DigitalTwinReader).toLowerCase(), ServiceCapability.DigitalTwinReader],
@@ -167,6 +189,7 @@ export function hasServiceCapabilityKind(value, family) {
  */
 export function isProviderServiceCapability(value) {
     const normalized = normalizeServiceCapability(value);
-    return normalized === ServiceCapability.IndexProvider
+    return normalized === ServiceCapability.OrganizationRegistryProvider
+        || normalized === ServiceCapability.IndexProvider
         || normalized === ServiceCapability.DigitalTwinProvider;
 }

package/dist/examples/consent-access.d.ts

@@ -1,6 +1,6 @@
 import { ClaimConsent, type ConsentRule } from '../models/consent-rule';
 import { EXAMPLE_EMAIL_PROFESSIONAL, EXAMPLE_EMAIL_RELATED_PERSON } from './shared';
-export declare const EXAMPLE_INDIVIDUAL_DID_WEB: "did:web:api.acme.org:individual:123";
+export declare const EXAMPLE_INDIVIDUAL_DID_WEB: string;
 export declare const EXAMPLE_PROVIDER_ORGANIZATION_DID_WEB: "did:web:hospital.acme.org";
 export { EXAMPLE_EMAIL_PROFESSIONAL, EXAMPLE_EMAIL_RELATED_PERSON };
 export declare const EXAMPLE_CONSENT_ACCESS_JURISDICTION: "ES";
@@ -8,7 +8,7 @@ export declare const EXAMPLE_CONSENT_ACCESS_JURISDICTION: "ES";
  * Legacy compatibility aliases kept so older docs/tests/imports continue to work
  * while the canonical variable names converge.
  */
-export declare const EXAMPLE_CONSENT_ACCESS_SUBJECT: "did:web:api.acme.org:individual:123";
+export declare const EXAMPLE_CONSENT_ACCESS_SUBJECT: string;
 export declare const EXAMPLE_CONSENT_ACCESS_PROVIDER_DID: "did:web:hospital.acme.org";
 export declare const EXAMPLE_CONSENT_ACCESS_PROVIDER_EMAIL: "doctor.oncall@example.org";
 export declare const EXAMPLE_CONSENT_ACCESS_RELATED_PERSON_EMAIL: "parent.guardian@example.org";

package/dist/examples/ica-activation-proof.d.ts

@@ -25,12 +25,20 @@ export declare const EXAMPLE_PRESENTATION_AUDIENCE_HOST_ID: "host:node-operator-
 export declare const EXAMPLE_ORGANIZATION_TAX_ID: "ESB00112233";
 export declare const EXAMPLE_REPRESENTATIVE_ROLE_CODE: "RESPRSN";
 export declare const EXAMPLE_ORGANIZATION_ID: "ESB00112233";
+export declare const EXAMPLE_ACTIVATION_AUTHORIZED_CATEGORY: "health-care";
+export declare const EXAMPLE_ACTIVATION_AUTHORIZED_SERVICE_TYPE: "organization/Composition.cruds";
+export declare const EXAMPLE_HOST_ACTIVATION_AUTHORIZED_CATEGORY: "system";
+export declare const EXAMPLE_HOST_ACTIVATION_AUTHORIZED_SERVICE_TYPE: "organization/Organization.cruds";
 export declare const EXAMPLE_ORG_ACTIVATION_ORGANIZATION_CREDENTIAL: Readonly<{
     '@context': string[];
     type: ("VerifiableCredential" | "OrganizationCredential")[];
     credentialSubject: {
         id: "ESB00112233";
         taxID: "ESB00112233";
+        makesOffer: {
+            category: "health-care";
+            serviceType: "organization/Composition.cruds";
+        };
     };
 }>;
 export declare const EXAMPLE_ORG_ACTIVATION_LEGAL_REPRESENTATIVE_CREDENTIAL: Readonly<{

package/dist/examples/ica-activation-proof.js

@@ -2,6 +2,8 @@
 // Always create JSDoc, do not use strings inline in keys nor values, use types instead, and reuse the data test examples.
 import { ActivationCredentialTypes, W3cCredentialContexts, W3cCredentialTypes, } from '../constants/verifiable-credentials.js';
 import { UrnPrefixes } from '../constants/urn.js';
+import { ServiceCapability } from '../constants/service-capabilities.js';
+import { DataspaceSectors } from '../constants/sectors.js';
 /**
  * Shared synthetic ICA activation-proof fixtures reused by docs/tests.
  *
@@ -29,6 +31,10 @@ export const EXAMPLE_PRESENTATION_AUDIENCE_HOST_ID = 'host:node-operator-es';
 export const EXAMPLE_ORGANIZATION_TAX_ID = 'ESB00112233';
 export const EXAMPLE_REPRESENTATIVE_ROLE_CODE = 'RESPRSN';
 export const EXAMPLE_ORGANIZATION_ID = EXAMPLE_ORGANIZATION_TAX_ID;
+export const EXAMPLE_ACTIVATION_AUTHORIZED_CATEGORY = DataspaceSectors.HealthCare;
+export const EXAMPLE_ACTIVATION_AUTHORIZED_SERVICE_TYPE = ServiceCapability.IndexProvider;
+export const EXAMPLE_HOST_ACTIVATION_AUTHORIZED_CATEGORY = 'system';
+export const EXAMPLE_HOST_ACTIVATION_AUTHORIZED_SERVICE_TYPE = ServiceCapability.OrganizationRegistryProvider;
 export const EXAMPLE_ORG_ACTIVATION_ORGANIZATION_CREDENTIAL = Object.freeze({
     '@context': [W3cCredentialContexts.V2, 'https://schema.org'],
     type: [
@@ -38,6 +44,10 @@ export const EXAMPLE_ORG_ACTIVATION_ORGANIZATION_CREDENTIAL = Object.freeze({
     credentialSubject: {
         id: EXAMPLE_ORGANIZATION_ID,
         taxID: EXAMPLE_ORGANIZATION_TAX_ID,
+        makesOffer: {
+            category: EXAMPLE_ACTIVATION_AUTHORIZED_CATEGORY,
+            serviceType: EXAMPLE_ACTIVATION_AUTHORIZED_SERVICE_TYPE,
+        },
     },
 });
 export const EXAMPLE_ORG_ACTIVATION_LEGAL_REPRESENTATIVE_CREDENTIAL = Object.freeze({

package/dist/examples/individual-controller.d.ts

@@ -60,7 +60,7 @@ export declare const EXAMPLE_CONSENT_GRANT_INPUT: {
     readonly subjectDid: "did:web:subject.example";
 };
 export declare const EXAMPLE_LIVE_CONSENT_GRANT_INPUT: {
-    readonly subjectDid: "did:web:api.acme.org:individual:123";
+    readonly subjectDid: string;
     readonly actor: {
         readonly identifier: "did:web:api.acme.org";
     };

package/dist/examples/lifecycle.d.ts

@@ -12,6 +12,9 @@ export declare const EXAMPLE_LIFECYCLE_OPERATIONS: {
 };
 export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_REQUEST_TYPE: "Family-disable-request-v1.0";
 export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_REQUEST_TYPE: "Family-purge-request-v1.0";
+export declare const EXAMPLE_TENANT_ENABLE_REQUEST_TYPE: "Organization-enable-request-v1.0";
+export declare const EXAMPLE_TENANT_DISABLE_REQUEST_TYPE: "Organization-disable-request-v1.0";
+export declare const EXAMPLE_TENANT_PURGE_REQUEST_TYPE: "Organization-purge-request-v1.0";
 /**
  * Shared placeholder values used by copy/paste examples.
  *

package/dist/examples/lifecycle.js

@@ -1,5 +1,6 @@
 // Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
 import { ClaimsOrganizationSchemaorg, ClaimsPersonSchemaorg, } from '../constants/schemaorg.js';
+import { LifecycleRequestType } from '../constants/lifecycle.js';
 import { ClaimConsent } from '../models/consent-rule.js';
 import { IndividualOrganizationLifecycleDraft, IndividualOrganizationLifecycleOperations, } from '../utils/individual-organization-lifecycle.js';
 import { EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL, EXAMPLE_EMAIL_CONTROLLER_ORG, EXAMPLE_CLINICAL_SECTION_ALLERGIES, EXAMPLE_CONSENT_PURPOSE_TREATMENT, EXAMPLE_HEALTHCARE_ACTOR_ROLE_PHYSICIAN, EXAMPLE_JURISDICTION, EXAMPLE_SECTOR, EXAMPLE_TENANT_IDENTIFIER, } from './shared.js';
@@ -17,6 +18,9 @@ export const EXAMPLE_LIFECYCLE_OPERATIONS = {
 };
 export const EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_REQUEST_TYPE = 'Family-disable-request-v1.0';
 export const EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_REQUEST_TYPE = 'Family-purge-request-v1.0';
+export const EXAMPLE_TENANT_ENABLE_REQUEST_TYPE = LifecycleRequestType.TenantEnable;
+export const EXAMPLE_TENANT_DISABLE_REQUEST_TYPE = LifecycleRequestType.TenantDisable;
+export const EXAMPLE_TENANT_PURGE_REQUEST_TYPE = LifecycleRequestType.TenantPurge;
 /**
  * Shared placeholder values used by copy/paste examples.
  *

package/dist/examples/professional.d.ts

@@ -10,7 +10,7 @@ export declare const EXAMPLE_OPENID_SMART_TOKEN_INPUT: {
     readonly scopes: readonly [string];
     readonly smartTokenKind: "openid-smart";
     readonly clientId: "device-1";
-    readonly subjectDid: "did:web:api.acme.org:individual:123";
+    readonly subjectDid: string;
 };
 export declare const EXAMPLE_SMART_PRESENTATION_SUBMISSION: {
     readonly id: "ps-001";

package/dist/examples/related-person.d.ts

@@ -14,8 +14,8 @@ export declare const EXAMPLE_RELATED_PERSON_DISPLAY_NAME: "Jose Example";
 export declare const EXAMPLE_RELATED_PERSON_DISABLE_INPUT: {
     readonly memberClaims: {
         readonly '@context': "org.hl7.fhir.api";
-        readonly "RelatedPerson.identifier": "rel-001";
-        readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+        readonly "RelatedPerson.identifier.value": "rel-001";
+        readonly "RelatedPerson.patient": string;
         readonly "RelatedPerson.telecom": "mailto:parent.guardian@example.org";
         readonly "RelatedPerson.relationship": "v3-RoleCode|RESPRSN";
     };
@@ -50,8 +50,8 @@ export declare const EXAMPLE_RELATED_PERSON_DISABLE_BUNDLE_ENTRY: {
     readonly meta: {
         readonly claims: {
             readonly '@context': "org.hl7.fhir.api";
-            readonly "RelatedPerson.identifier": "rel-001";
-            readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+            readonly "RelatedPerson.identifier.value": "rel-001";
+            readonly "RelatedPerson.patient": string;
             readonly "RelatedPerson.telecom": "mailto:parent.guardian@example.org";
             readonly "RelatedPerson.relationship": "v3-RoleCode|RESPRSN";
         };
@@ -84,8 +84,8 @@ export declare const EXAMPLE_RELATED_PERSON_DISABLE_BUNDLE_PAYLOAD: {
             readonly meta: {
                 readonly claims: {
                     readonly '@context': "org.hl7.fhir.api";
-                    readonly "RelatedPerson.identifier": "rel-001";
-                    readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+                    readonly "RelatedPerson.identifier.value": "rel-001";
+                    readonly "RelatedPerson.patient": string;
                     readonly "RelatedPerson.telecom": "mailto:parent.guardian@example.org";
                     readonly "RelatedPerson.relationship": "v3-RoleCode|RESPRSN";
                 };
@@ -125,8 +125,8 @@ export declare const EXAMPLE_RELATED_PERSON_PURGE_BUNDLE_ENTRY: {
     readonly meta: {
         readonly claims: {
             readonly '@context': "org.hl7.fhir.api";
-            readonly "RelatedPerson.identifier": "rel-001";
-            readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+            readonly "RelatedPerson.identifier.value": "rel-001";
+            readonly "RelatedPerson.patient": string;
             readonly "RelatedPerson.telecom": "mailto:parent.guardian@example.org";
             readonly "RelatedPerson.relationship": "v3-RoleCode|RESPRSN";
         };
@@ -157,8 +157,8 @@ export declare const EXAMPLE_RELATED_PERSON_PURGE_BUNDLE_PAYLOAD: {
             readonly meta: {
                 readonly claims: {
                     readonly '@context': "org.hl7.fhir.api";
-                    readonly "RelatedPerson.identifier": "rel-001";
-                    readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+                    readonly "RelatedPerson.identifier.value": "rel-001";
+                    readonly "RelatedPerson.patient": string;
                     readonly "RelatedPerson.telecom": "mailto:parent.guardian@example.org";
                     readonly "RelatedPerson.relationship": "v3-RoleCode|RESPRSN";
                 };
@@ -195,7 +195,7 @@ export declare const EXAMPLE_RELATED_PERSON_UPSERT_BUNDLE_PAYLOAD: {
                 readonly resourceType: "RelatedPerson";
                 readonly id: "grandfather-001";
                 readonly patient: {
-                    readonly reference: "did:web:api.acme.org:individual:123";
+                    readonly reference: string;
                 };
                 readonly relationship: readonly [{
                     readonly text: "Grandfather";
@@ -218,7 +218,7 @@ export declare const EXAMPLE_RELATED_PERSON_PAYLOAD: {
                 readonly resourceType: "RelatedPerson";
                 readonly id: "grandfather-001";
                 readonly patient: {
-                    readonly reference: "did:web:api.acme.org:individual:123";
+                    readonly reference: string;
                 };
                 readonly relationship: readonly [{
                     readonly text: "Grandfather";
@@ -252,7 +252,7 @@ export declare const EXAMPLE_RELATED_PERSON_FHIR_RESOURCE: {
     }];
     readonly active: true;
     readonly patient: {
-        readonly reference: "did:web:api.acme.org:individual:123";
+        readonly reference: string;
     };
     readonly relationship: readonly [{
         readonly coding: readonly [{
@@ -278,8 +278,8 @@ export declare const EXAMPLE_RELATED_PERSON_LIST_RECORD_ACTIVE: {
         readonly meta: {
             readonly claims: {
                 readonly '@context': "org.hl7.fhir.api";
-                readonly "RelatedPerson.identifier": "rel-001";
-                readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+                readonly "RelatedPerson.identifier.value": "rel-001";
+                readonly "RelatedPerson.patient": string;
                 readonly "RelatedPerson.telecom": "mailto:parent.guardian@example.org";
                 readonly "RelatedPerson.relationship": "v3-RoleCode|RESPRSN";
                 readonly "RelatedPerson.name": "Jose Example";
@@ -299,8 +299,8 @@ export declare const EXAMPLE_RELATED_PERSON_LIST_RECORD_INACTIVE: {
         readonly meta: {
             readonly claims: {
                 readonly '@context': "org.hl7.fhir.api";
-                readonly "RelatedPerson.identifier": "urn:uuid:related-person-002";
-                readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+                readonly "RelatedPerson.identifier.value": "urn:uuid:related-person-002";
+                readonly "RelatedPerson.patient": string;
                 readonly "RelatedPerson.telecom": "mailto:caregiver.two@example.org";
                 readonly "RelatedPerson.relationship": "http://terminology.hl7.org/CodeSystem/v3-RoleCode|NMTH";
                 readonly "RelatedPerson.name": "Maria Example";
@@ -322,8 +322,8 @@ export declare const EXAMPLE_RELATED_PERSON_LIST_RESPONSE_BODY: {
                 readonly meta: {
                     readonly claims: {
                         readonly '@context': "org.hl7.fhir.api";
-                        readonly "RelatedPerson.identifier": "rel-001";
-                        readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+                        readonly "RelatedPerson.identifier.value": "rel-001";
+                        readonly "RelatedPerson.patient": string;
                         readonly "RelatedPerson.telecom": "mailto:parent.guardian@example.org";
                         readonly "RelatedPerson.relationship": "v3-RoleCode|RESPRSN";
                         readonly "RelatedPerson.name": "Jose Example";
@@ -342,8 +342,8 @@ export declare const EXAMPLE_RELATED_PERSON_LIST_RESPONSE_BODY: {
                 readonly meta: {
                     readonly claims: {
                         readonly '@context': "org.hl7.fhir.api";
-                        readonly "RelatedPerson.identifier": "urn:uuid:related-person-002";
-                        readonly "RelatedPerson.patient": "did:web:api.acme.org:individual:123";
+                        readonly "RelatedPerson.identifier.value": "urn:uuid:related-person-002";
+                        readonly "RelatedPerson.patient": string;
                         readonly "RelatedPerson.telecom": "mailto:caregiver.two@example.org";
                         readonly "RelatedPerson.relationship": "http://terminology.hl7.org/CodeSystem/v3-RoleCode|NMTH";
                         readonly "RelatedPerson.name": "Maria Example";

package/dist/examples/related-person.js

@@ -21,7 +21,7 @@ export const EXAMPLE_RELATED_PERSON_DISPLAY_NAME = EXAMPLE_RELATED_PERSON_ACTIVE
 export const EXAMPLE_RELATED_PERSON_DISABLE_INPUT = {
     memberClaims: {
         '@context': EXAMPLE_INTEROPERABLE_CONTEXT_FHIR_API,
-        [RelatedPersonClaim.Identifier]: EXAMPLE_RELATED_PERSON_IDENTIFIER,
+        [RelatedPersonClaim.IdentifierValue]: EXAMPLE_RELATED_PERSON_IDENTIFIER,
         [RelatedPersonClaim.Patient]: EXAMPLE_SUBJECT_DID,
         [RelatedPersonClaim.Telecom]: `mailto:${EXAMPLE_EMAIL_RELATED_PERSON}`,
         [RelatedPersonClaim.Relationship]: EXAMPLE_RELATED_PERSON_ROLE,
@@ -34,8 +34,8 @@ export const EXAMPLE_RELATED_PERSON_DISABLE_INPUT = {
  */
 export const EXAMPLE_RELATED_PERSON_DISABLE_LIFECYCLE_RESOURCE = createInteroperableResourceOperationEditor()
     .setResourceType(EXAMPLE_RELATED_PERSON_RESOURCE_TYPE)
-    .setIdentifierClaimKey(RelatedPersonClaim.Identifier)
-    .setBusinessIdentifier(EXAMPLE_RELATED_PERSON_DISABLE_INPUT.memberClaims[RelatedPersonClaim.Identifier])
+    .setIdentifierClaimKey(RelatedPersonClaim.IdentifierValue)
+    .setBusinessIdentifier(EXAMPLE_RELATED_PERSON_DISABLE_INPUT.memberClaims[RelatedPersonClaim.IdentifierValue])
     .setClaims({ ...EXAMPLE_RELATED_PERSON_DISABLE_INPUT.memberClaims })
     .setLifecycleStatus(InteroperableLifecycleStatuses.Inactive)
     .buildLifecycleResource();
@@ -66,8 +66,8 @@ export const EXAMPLE_RELATED_PERSON_DISABLE_BUNDLE_PAYLOAD = {
 };
 export const EXAMPLE_RELATED_PERSON_PURGE_LIFECYCLE_RESOURCE = createInteroperableResourceOperationEditor()
     .setResourceType(EXAMPLE_RELATED_PERSON_RESOURCE_TYPE)
-    .setIdentifierClaimKey(RelatedPersonClaim.Identifier)
-    .setBusinessIdentifier(EXAMPLE_RELATED_PERSON_DISABLE_INPUT.memberClaims[RelatedPersonClaim.Identifier])
+    .setIdentifierClaimKey(RelatedPersonClaim.IdentifierValue)
+    .setBusinessIdentifier(EXAMPLE_RELATED_PERSON_DISABLE_INPUT.memberClaims[RelatedPersonClaim.IdentifierValue])
     .setClaims({ ...EXAMPLE_RELATED_PERSON_DISABLE_INPUT.memberClaims })
     .setLifecycleStatus(InteroperableLifecycleStatuses.Purged)
     .buildLifecycleResource();
@@ -152,7 +152,7 @@ export const EXAMPLE_RELATED_PERSON_LIST_RECORD_ACTIVE = {
         meta: {
             claims: {
                 '@context': EXAMPLE_INTEROPERABLE_CONTEXT_FHIR_API,
-                [RelatedPersonClaim.Identifier]: EXAMPLE_RELATED_PERSON_IDENTIFIER,
+                [RelatedPersonClaim.IdentifierValue]: EXAMPLE_RELATED_PERSON_IDENTIFIER,
                 [RelatedPersonClaim.Patient]: EXAMPLE_SUBJECT_DID,
                 [RelatedPersonClaim.Telecom]: `mailto:${EXAMPLE_EMAIL_RELATED_PERSON}`,
                 [RelatedPersonClaim.Relationship]: EXAMPLE_RELATED_PERSON_ROLE,
@@ -173,7 +173,7 @@ export const EXAMPLE_RELATED_PERSON_LIST_RECORD_INACTIVE = {
         meta: {
             claims: {
                 '@context': EXAMPLE_INTEROPERABLE_CONTEXT_FHIR_API,
-                [RelatedPersonClaim.Identifier]: EXAMPLE_RELATED_PERSON_INACTIVE_IDENTIFIER,
+                [RelatedPersonClaim.IdentifierValue]: EXAMPLE_RELATED_PERSON_INACTIVE_IDENTIFIER,
                 [RelatedPersonClaim.Patient]: EXAMPLE_SUBJECT_DID,
                 [RelatedPersonClaim.Telecom]: `mailto:${EXAMPLE_RELATED_PERSON_INACTIVE_EMAIL}`,
                 [RelatedPersonClaim.Relationship]: EXAMPLE_RELATED_PERSON_INACTIVE_RELATIONSHIP,