CheckDataAccessRequest

Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.

HealthcareFHIRHL7v2DICOMMedical ImagingDe-IdentificationInteroperabilityCloud

Properties

Name Type Description
consentList object Optional. Specific Consents to evaluate the access request against. These Consents must have the same `user_id` as the evaluated User data mapping, must exist in the current `consent_store`, and have
dataId string Required. The unique identifier of the resource to check access for. This identifier must correspond to a User data mapping in the given consent store.
requestAttributes object The values of request attributes associated with this access request.
responseView string Optional. The view for CheckDataAccessResponse. If unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or `FALSE`.
View JSON Schema on GitHub

JSON Schema

CheckDataAccessRequest.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CheckDataAccessRequest",
  "description": "Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.",
  "properties": {
    "consentList": {
      "$ref": "#/components/schemas/ConsentList",
      "description": "Optional. Specific Consents to evaluate the access request against. These Consents must have the same `user_id` as the evaluated User data mapping, must exist in the current `consent_store`, and have a `state` of either `ACTIVE` or `DRAFT`. A maximum of 100 Consents can be provided here. If no selection is specified, the access request is evaluated against all `ACTIVE` unexpired Consents with the same `user_id` as the evaluated User data mapping."
    },
    "dataId": {
      "description": "Required. The unique identifier of the resource to check access for. This identifier must correspond to a User data mapping in the given consent store.",
      "type": "string"
    },
    "requestAttributes": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "The values of request attributes associated with this access request.",
      "type": "object"
    },
    "responseView": {
      "description": "Optional. The view for CheckDataAccessResponse. If unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or `FALSE`.",
      "enum": [
        "RESPONSE_VIEW_UNSPECIFIED",
        "BASIC",
        "FULL"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/CheckDataAccessRequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.