FHIR IG Statistics: CapabilityStatement/ConsentClientCapabilities
Resources that use this resource
No resources found
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
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 | D | Searches | _include | _revinclude | Operations |
|---|
| AuditEvent | Supported Profiles
FASTConsentAuditEvent | y | y | | | | patient, consent | | | $recordDisclosure |
| Consent | Supported Profiles
FASTConsent | y | y | | | | controller, date, grantee, manager, organizationId, patient, patientId, scope, status | | | $fileConsent, $updateConsent, $revokeConsent |
| Subscription | | | | y | y | y | | | | |
Resource Conformance: supported AuditEvent
Reference Policy
Interaction summary- Supports
search-type, read.
Search Parameters| Conformance | Parameter | Type | Documentation |
|---|
| SHALL | patient | reference | |
| SHALL | consent | reference | |
Resource Conformance: supported Consent
Reference Policy
Interaction summary- Supports
search-type, read.
Resource Conformance: supported Subscription
Reference Policy
Interaction summary- Supports
create, update, delete.
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": "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": "updateConsent",
"definition": "http://hl7.org/fhir/us/consent-management/OperationDefinition/update-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",
"interaction": [
{
"code": "create"
},
{
"code": "update"
},
{
"code": "delete"
}
]
}
]
}
]
}
FHIR