health.hats.listAccessOptions
The menu: what the caller may ask for under a reason. Built only from policy (the requester's role and institution, from authentication, and the reason), never from any patient, so it is the same for every patient.
Details · query
| Kind | query |
|---|---|
| Authority | hats.health |
| Indexed |
Query
query · GETParameters
query stringHL7 PurposeOfUse code, in the code system's case. Matched exactly: a policy for ETREAT does not cover ERTREAT or BTG.
knownValues: TREAT | ETREAT | ERTREAT | BTG
Errors
InvalidReason
The reason code is not one the coordinator accepts.
#option
objectOne menu item: read or write access to one space of the patient's, identified without naming the patient.
Properties
Read is a space credential; write is the space host tracking the requester's own repo in the space.
knownValues: read | write
Identifier to pick this option by in requestAccess.
Space key: the protection level.
knownValues: n | r | v | 42cfrpart2
Space type, e.g. health.hats.records.allergies.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Pick options from the menu for one patient. The coordinator decides by policy and returns, per pick, the space address or pending while a patient or circle approval is outstanding. It never says whether a space holds records; the requester learns that by syncing. Authenticated as the clinician (service auth) and the institution node (client attestation).
-
The requests waiting on the caller: access asked for their own spaces that policy leaves to them. Authenticated as the patient (service auth), so each patient sees only their own.
-
Grants the caller gave, as a patient, and grants the caller holds, as a grantee: one entry per request, newest first. Authenticated by service auth, so each caller sees only their own.