FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.us.consent-management
Resource TypeCapabilityStatement
IdCapabilityStatement-ConsentClientCapabilities.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.html
URLhttp://hl7.org/fhir/us/consent-management/CapabilityStatement/ConsentClientCapabilities
Version1.0.0-ballot
Statusactive
Date2025-01-01
NameConsentClient
TitleConsent Client Capabilities
Realmus
Authorityhl7
DescriptionCapabilities required for a client system filing and review consents.
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
file-consentFile a Consent
record-disclosureRecordDisclosure
revoke-consentRevoke a Consent
SearchParameter
fast-auditevent-consentFASTAuditEventConsent
fast-consent-controllerFASTConsentController
fast-consent-granteeFASTConsentGrantee
fast-consent-managerFASTConsentManager
fast-consent-organizationIdFASTConsentOrganizationId
fast-consent-patientIdFASTConsentPatientId
StructureDefinition
FASTConsentFASTConsent
FASTConsentAuditEventFASTConsentAuditEvent
FASTSubscriptionFASTSubscription

Narrative

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

Generated Narrative: CapabilityStatement ConsentClientCapabilities

Consent Client Capabilities

  • Implementation Guide Version: 1.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • 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

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 TypeProfileRSUCDSearches_include_revincludeOperations
AuditEventSupported Profiles
  FASTConsentAuditEvent		yypatient, consent$recordDisclosure
ConsentSupported Profiles
  FASTConsent		yycontroller, date, grantee, manager, organizationId, patient, patientId, scope, status$fileConsent, $revokeConsent
SubscriptionSupported Profiles
  FASTSubscription		yyy

Resource Conformance: supported AuditEvent

Core FHIR Resource
AuditEvent
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

FASTConsentAuditEvent

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLconsentreference
 
Extended Operations
ConformanceOperationDocumentation
SHALL$recordDisclosure

Resource Conformance: supported Consent

Core FHIR Resource
Consent
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

FASTConsent

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcontrollerreference
SHALLdatedate
SHALLgranteereference
SHALLmanagerreference
SHALLorganizationIdtoken
SHALLpatientreference
SHALLpatientIdtoken
SHALLscopetoken
SHALLstatustoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$fileConsent
SHALL$revokeConsent

Resource Conformance: supported Subscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary
  • Supports create, update, delete.

Supported Profiles

FASTSubscription

Source1

{
  "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": "1.0.0-ballot",
  "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/homehealth"
        }
      ]
    }
  ],
  "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": "AuditEvent",
          "supportedProfile": [
            "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsentAuditEvent"
          ],
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "read"
            }
          ],
          "searchParam": [
            {
              "name": "patient",
              "type": "reference"
            },
            {
              "name": "consent",
              "definition": "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-auditevent-consent",
              "type": "reference"
            }
          ],
          "operation": [
            {
              "name": "recordDisclosure",
              "definition": "http://hl7.org/fhir/us/consent-management/OperationDefinition/record-disclosure"
            }
          ]
        },
        {
          "type": "Consent",
          "supportedProfile": [
            "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"
          ],
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "read"
            }
          ],
          "searchParam": [
            {
              "name": "controller",
              "definition": "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-controller",
              "type": "reference"
            },
            {
              "name": "date",
              "type": "date"
            },
            {
              "name": "grantee",
              "definition": "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-grantee",
              "type": "reference"
            },
            {
              "name": "manager",
              "definition": "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-manager",
              "type": "reference"
            },
            {
              "name": "organizationId",
              "definition": "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-organizationId",
              "type": "token"
            },
            {
              "name": "patient",
              "type": "reference"
            },
            {
              "name": "patientId",
              "definition": "http://hl7.org/fhir/us/consent-management/SearchParameter/fast-consent-patientId",
              "type": "token"
            },
            {
              "name": "scope",
              "type": "token"
            },
            {
              "name": "status",
              "type": "token"
            }
          ],
          "operation": [
            {
              "name": "fileConsent",
              "definition": "http://hl7.org/fhir/us/consent-management/OperationDefinition/file-consent"
            },
            {
              "name": "revokeConsent",
              "definition": "http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical",
              "valueCanonical": "http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic"
            }
          ],
          "type": "Subscription",
          "supportedProfile": [
            "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTSubscription"
          ],
          "interaction": [
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            }
          ]
        }
      ]
    }
  ]
}