XIG: CapabilityStatement/ConsentClientCapabilities

FHIR IG Statistics: CapabilityStatement/ConsentClientCapabilities

Package	hl7.fhir.us.consent-management
Type	CapabilityStatement
Id	ConsentClientCapabilities
FHIR Version	R4
Source	http://hl7.org/fhir/us/consent-management/https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.html
URL	http://hl7.org/fhir/us/consent-management/CapabilityStatement/ConsentClientCapabilities
Version	0.1.0
Status	active
Date	2025-01-01
Name	ConsentClient
Title	Consent Client Capabilities
Realm	us
Authority	hl7
Description	Capabilities required for a client system filing and review consents.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
file-consent	File a Consent

StructureDefinition
FASTConsent	FASTConsent
fileConsentParameters	File Consent Operation Parameters

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement ConsentClientCapabilities

Consent Client Capabilities

Implementation Guide Version: 0.1.0
FHIR Version: 4.0.1
Supported Formats: json, xml
Supported Patch Formats:
Published on: 2025-01-01
Published by: HL7 International / Community Based Collaborative Care

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: `client`

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	S	U	C	Searches	`_include`	`_revinclude`	Operations
Parameters	http://hl7.org/fhir/us/consent-management/StructureDefinition/fileConsentParameters								`$File Consent`
Consent	http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent	y	y			actor, organization, patient, status, scope

Resource Conformance: supported Parameters

Base System Profile
File Consent Operation Parameters

Profile Conformance
SHALL

Reference Policy

Interaction summary

Extended Operations

Conformance	Operation	Documentation
SHALL	$File Consent

Resource Conformance: supported Consent

Base System Profile
FASTConsent

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports search-type, read.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	actor	`reference`
SHALL	organization	`reference`
SHALL	patient	`reference`
SHALL	status	`token`
SHALL	scope	`token`

Source

{
  "resourceType": "CapabilityStatement",
  "id": "ConsentClientCapabilities",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cbcc"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/consent-management/CapabilityStatement/ConsentClientCapabilities",
  "version": "0.1.0",
  "name": "ConsentClient",
  "title": "Consent Client Capabilities",
  "status": "active",
  "experimental": false,
  "date": "2025-01-01",
  "publisher": "HL7 International / Community Based Collaborative Care",
  "contact": [
    {
      "name": "HL7 International / Community Based Collaborative Care",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/cbcc"
        }
      ]
    }
  ],
  "description": "Capabilities required for a client system filing and review consents.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "mode": "client",
      "resource": [
        {
          "type": "Parameters",
          "profile": "http://hl7.org/fhir/us/consent-management/StructureDefinition/fileConsentParameters",
          "operation": [
            {
              "name": "File Consent",
              "definition": "http://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent"
            }
          ]
        },
        {
          "type": "Consent",
          "profile": "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent",
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "read"
            }
          ],
          "searchParam": [
            {
              "name": "actor",
              "type": "reference"
            },
            {
              "name": "organization",
              "type": "reference"
            },
            {
              "name": "patient",
              "type": "reference"
            },
            {
              "name": "status",
              "type": "token"
            },
            {
              "name": "scope",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}