An access unit is a tenant-scoped, business-level access target: for example, a door, gate, area, group, or logical access point. It lets your application model the access it intends to grant without exposing PACS-specific identifiers throughout its workflows.
An access unit has a name, an eligibility value (identity, visitor, or any), and optionally one or more PACS mappings. An ICAP access unit can map to relevant access targets in connected PACSs.
Create and map access units
Create an access unit before assigning it. If your tenant uses PACS integration, discover the remote access units from the registered PACS and configure the mapping using the returned identifiers. Do not assume one ICAP access unit maps to only one PACS target.
Keep names meaningful to administrators—such as “HQ level 3” rather than a remote device code—and keep your system's business grouping outside individual PACS naming conventions.
Grant access
-
Assign access to an identity through
/identity/{identityId}/accessUnit. -
Assign temporary access to a visit through
/visit/{visitId}/accessUnit. -
List all current use of an access unit through
/accessUnit/{accessUnitId}/assignment.
An identity assignment requires an access unit eligible for identity or any. A visit assignment requires visitor or any. The access unit's eligibleFor value is chosen on creation; create a different unit if a different eligibility is needed.
Assignments express intended state; a configured PACS may process them asynchronously. See PACS integration.
Lifecycle
Access units are versioned. PATCH and remove operations require If-Match; remove any dependent assignments deliberately before retiring a unit. Use the API contract for endpoint details and concurrency for update behavior.
Removing an access unit soft-deletes the unit and its remaining active assignments. It does not delete the related identities, visits, or remote PACS access unit. After a failed removal, check both the unit and its assignments before retrying; do not infer that a failed request left all relationships unchanged. See Errors and retry behavior.