health.hats.listGrants
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.
Details · query
| Kind | query |
|---|---|
| Authority | hats.health |
| Indexed |
Query
query · GET#grant
objectOne request's grants and where they stand. The caller is the patient or the grantee.
Properties
answeredAt
string · datetimeWhen the patient approved or declined the request.
expiresAt
string · datetimegrant
string · at-uriThe grant record in the patient's audit space that backs an approval.
The request's identifier, as listRequests and answerRequest use it.
institution
stringThe institution the grantee acts for, as the registry names it.
HL7 PurposeOfUse code the request was made under.
reasonText
stringWhat the requester said beside the code: for break-glass, why the patient couldn't be asked.
revokedAt
string · datetimeWhen the patient revoked the approval.
role
stringThe grantee's NUCC Health Care Provider Taxonomy code, from the provider registry.
knownValues: pending | granted | declined | revoked | expired
#space
objectSimilar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
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.
-
Approve or decline one waiting request. Approving names the grant record the patient wrote to their health.hats.audit.log space and how long it lasts; the coordinator then grants exactly what was picked, until then. Authenticated as the patient (service auth).
-
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).
-
health.hats.provider.grant
recordA provider grant: a FHIR R4 Consent under the HATS profile (one flat provision: actor, class, code, securityLabel, action, purpose, period). Stored in the patient's health.hats.audit.log space. Counts only with an attestation from the patient or an act circle member; a grant carrying V counts only with the patient's own.
-
Asks the caller made, as a patient, and was asked, as a clinician, newest first. Service auth, so each caller sees only their own.