Lexicon Garden

health.hats.institution.endRole

An administrator ends someone's role at their institution, when the person didn't choose to go, or records a leaving by revoking the credential. The node writes the ended PractitionerRole, pointing its forward where the administrator says, and a Provenance naming the administrator. Authenticated as the administrator (service auth), who must hold institution.administrator there.

Repository @hats.health did:plc:uvvhtareovj2oaregs7vsibv namespace authority
Details · procedure
Kindprocedure
Authorityinstitution.hats.health
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

forward

string · did

Whom requests for them go to now: a colleague's DID, or the institution's own. The ended role's endpoint.

institution

requiredstring · did

The institution, by its DID.

practitioner

requiredstring · did

Whose role ends.

Output

application/json

endedAt

requiredstring · datetime

role

requiredstring · at-uri

The ended PractitionerRole, which stays published with its end date.

Errors

NotAdministrator

The caller holds no institution.administrator role in force there.

NoRole

The person holds no role there to end.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • health.hats.institution.leaveRole

    procedure

    A clinician leaves an institution: their role there ends now. It's their own act, honored at once, since giving up a role only removes access; an administrator revokes the role credential after. The institution's node writes the ended PractitionerRole and a Provenance naming the clinician. Authenticated as the clinician (service auth).

  • health.hats.revokeAccess

    procedure not from the namespace authority

    End every grant the caller has given one grantee. The space host asks the coordinator before issuing each space credential, so the grantee gets no new credential from then on; a credential already issued lasts until it expires. Authenticated as the patient (service auth).

  • app.didpic.admin.revokeRole

    procedure

    Revoke a role.

  • pub.chive.governance.revokeRole

    procedure

    Revoke a user's governance role. Only accessible to administrators. Also revokes any active delegation.