Class ReadAccessLogResponse.Builder
- Enclosing class:
ReadAccessLogResponse
-
Method Summary
Modifier and TypeMethodDescriptionaction(ReadAccessLogResponseAction action) action(Optional<ReadAccessLogResponseAction> action) What the caller did:read(single fetch),list,lookup,search, orrag.additionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) auditDisposition(String auditDisposition) auditDisposition(Optional<String> auditDisposition) The retention disposition this row was recorded under:retain,retain-redacted, ordelete.build()callerKeyId(String callerKeyId) callerKeyId(Optional<String> callerKeyId) The credential (API key / scoped token key id) that performed the read — the actor.Identifier of the nested client/patient the read was scoped to, when applicable.The app context the read occurred in (the data-partition axis).When the read occurred / the row was recorded (ISO-8601 UTC).from(ReadAccessLogResponse other) Unique identifier for this read-access row.recipientRef(String recipientRef) recipientRef(Optional<String> recipientRef) Reserved for future use — not yet populated, so this is currently always null.resourceId(String resourceId) resourceId(Optional<String> resourceId) The accessed record/document id (opaque).resourceType(String resourceType) resourceType(Optional<String> resourceType) The accessed resource's type: a record schema type name, or one ofdocument,search, orrag.retainUntil(String retainUntil) retainUntil(Optional<String> retainUntil) The earliest this row may be disposed of, recorded at write time (ISO-8601 UTC).revealedSensitive(Boolean revealedSensitive) revealedSensitive(Optional<Boolean> revealedSensitive) True only if at least one sensitive field was actually returned unmasked in this read — not merely that the caller's token carried scope to read sensitive fields.Identifier of the data subject whose PHI was read.subjectType(ReadAccessLogResponseSubjectType subjectType) subjectType(Optional<ReadAccessLogResponseSubjectType> subjectType) The kind of subject whose PHI was read:user,client, ororg.
-
Method Details
-
from
-
id
Unique identifier for this read-access row.
-
id
-
contextId
The app context the read occurred in (the data-partition axis).
-
contextId
-
subjectType
public ReadAccessLogResponse.Builder subjectType(Optional<ReadAccessLogResponseSubjectType> subjectType) The kind of subject whose PHI was read:
user,client, ororg. -
subjectType
-
subjectId
Identifier of the data subject whose PHI was read.
-
subjectId
-
clientId
Identifier of the nested client/patient the read was scoped to, when applicable.
-
clientId
-
callerKeyId
The credential (API key / scoped token key id) that performed the read — the actor.
-
callerKeyId
-
action
What the caller did:
read(single fetch),list,lookup,search, orrag. -
action
-
resourceType
The accessed resource's type: a record schema type name, or one of
document,search, orrag. -
resourceType
-
resourceId
The accessed record/document id (opaque). Never the payload or looked-up value.
-
resourceId
-
revealedSensitive
True only if at least one sensitive field was actually returned unmasked in this read — not merely that the caller's token carried scope to read sensitive fields. The revealed value itself is never recorded.
-
revealedSensitive
-
auditDisposition
The retention disposition this row was recorded under:
retain,retain-redacted, ordelete. -
auditDisposition
-
retainUntil
The earliest this row may be disposed of, recorded at write time (ISO-8601 UTC). Advisory only — it is not an automatic expiry. Null when no retention floor applies.
-
retainUntil
-
recipientRef
Reserved for future use — not yet populated, so this is currently always null. When implemented, it will record the basis for the access (e.g. treatment, payment, operations, or an external disclosure) to support a §164.528 accounting.
-
recipientRef
-
createdAt
When the read occurred / the row was recorded (ISO-8601 UTC).
-
createdAt
-
build
-
additionalProperty
-
additionalProperties
-