Lexicon Garden

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.

Repository @hats.health did:plc:uvvhtareovj2oaregs7vsibv not from the namespace authority
Details · query
Kindquery
Authorityhats.health
Indexed
Compare Edit in builder → Fork →
cid bafyreicrbr3zeynw5l3yia764behqn4moba4hbpysjquz6rnrlpiunz5ky

Checks

Valid
  • unlimited-string defs.main.parameters.properties.reasonNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.option.properties.accessNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.option.properties.idNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "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.",
      "errors": [
        {
          "description": "The reason code is not one the coordinator accepts.",
          "name": "InvalidReason"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "options": {
              "items": {
                "ref": "#option",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "options"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "reason": {
            "description": "HL7 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"
            ],
            "type": "string"
          }
        },
        "required": [
          "reason"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "option": {
      "description": "One menu item: read or write access to one space of the patient's, identified without naming the patient.",
      "properties": {
        "access": {
          "description": "Read is a space credential; write is the space host tracking the requester's own repo in the space.",
          "knownValues": [
            "read",
            "write"
          ],
          "type": "string"
        },
        "id": {
          "description": "Identifier to pick this option by in requestAccess.",
          "type": "string"
        },
        "skey": {
          "description": "Space key: the protection level.",
          "format": "record-key",
          "knownValues": [
            "n",
            "r",
            "v",
            "42cfrpart2"
          ],
          "type": "string"
        },
        "spaceType": {
          "description": "Space type, e.g. health.hats.records.allergies.",
          "format": "nsid",
          "type": "string"
        }
      },
      "required": [
        "id",
        "spaceType",
        "skey",
        "access"
      ],
      "type": "object"
    }
  },
  "id": "health.hats.listAccessOptions",
  "lexicon": 1
}