Scalable Consent Management
0.1.0 - ci-build United States of America flag

Scalable Consent Management, published by HL7 International / Community Based Collaborative Care. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-consent-management/ and changes regularly. See the Directory of published versions

Requirements: CapStmt Client

Official URL: http://hl7.org/fhir/us/consent-management/Requirements/capstmt-client Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: CapStmtClient

CapStmt Requirements for Client

Requirements Actor(s)

These requirements apply to the following actors:

  • Client An application or product that implements the Client.

Requirements Statement List

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/artifacts.html

Conformance: SHALL

Notes: - Interpreting this as: a client doesn't necessarily have to maintain and make available a client CS, but does have to implement the functionality therein. So specific requirements from the CS are traced to tests that exercise them. - Does this mean a conforming system has to reference the "requirements" CS here, or could they just have their own CS that happens to be compatible?

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Notes: - Plan is to have JSON and XML flavors of all tests, but explicitly tracing each of those back to these requirements is probably not necessary.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Notes: - Plan is to have JSON and XML flavors of all tests, but explicitly tracing each of those back to these requirements is probably not necessary.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FHIR R4

Link to Text: https://hl7.org/fhir/R4/profiling.html

Conformance: SHALL

Related Requirement: Requirements-structure-definitions-client-admin-service.html#requirement-597

Notes: Base FHIR requirement, applies because of declaring supportedProfile. Not marking as fully tested because I will continue to need to trace this to every transaction that applies.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Related Requirement: Requirements-search-parameters-client-admin-service.html#requirement-475

Notes: Matches identifier of grantee, manager, controller or the provision.actor.reference

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Related Requirement: Requirements-search-parameters-client-admin-service.html#requirement-476

Notes: Matches patient.identifier or patient.extension additionalIdentifier

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FHIR R4

Link to Text: https://hl7.org/fhir/R4/profiling.html

Conformance: SHALL

Notes: Base FHIR requirement, applies because of declaring supportedProfile. Not marking as fully tested because I will continue to need to trace this to every transaction that applies.

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL

Specification: HL7 FAST Consent IG

Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/CapabilityStatement-ConsentClientCapabilities.json.html

Conformance: SHALL


These requirements apply to the actor Client

requirement-48SHALL

Consent Client SHALL implement the client CapabilityStatement<br/><br/>- Interpreting this as: a client doesn't necessarily have to maintain and make available a client CS, but does have to implement the functionality therein. So specific requirements from the CS are traced to tests that exercise them.

  • Does this mean a conforming system has to reference the "requirements" CS here, or could they just have their own CS that happens to be compatible?

Links:

requirement-49SHALL

Consent Client SHALL support JSON FHIR<br/><br/>- Plan is to have JSON and XML flavors of all tests, but explicitly tracing each of those back to these requirements is probably not necessary.

Links:

requirement-50SHALL

Consent Client SHALL support XML FHIR<br/><br/>- Plan is to have JSON and XML flavors of all tests, but explicitly tracing each of those back to these requirements is probably not necessary.

Links:

requirement-333SHALL

Consent Client SHALL support Consent resource

Links:

requirement-52SHALL

Consent Client SHALL support Consent resources that conform to FASTConsent profile

Links:

requirement-334SHALL

Consent Client SHALL mark with profile assertions Consent resources that conform to the FASTConsent profile<br/><br/>Base FHIR requirement, applies because of declaring supportedProfile. Not marking as fully tested because I will continue to need to trace this to every transaction that applies.

Links:

requirement-56SHALL

Consent Client SHALL support Consent read

Links:

requirement-57SHALL

Consent Client SHALL support Consent search

Links:

requirement-58SHALL

Consent Client SHALL support Consent search by FASTConsentController

Links:

requirement-369SHALL

Consent Client SHALL support Consent search by date

Links:

requirement-370SHALL

Consent Client SHALL support Consent search by FASTConsentGrantee

Links:

requirement-371SHALL

Consent Client SHALL support Consent search by FASTConsentManager

Links:

requirement-59SHALL

Consent Client SHALL support Consent search by FASTConsentOrganizationId<br/><br/>Matches identifier of grantee, manager, controller or the provision.actor.reference

Links:

requirement-60SHALL

Consent Client SHALL support Consent search by patient

Links:

requirement-372SHALL

Consent Client SHALL support Consent search by FASTConsentPatientId<br/><br/>Matches patient.identifier or patient.extension additionalIdentifier

Links:

requirement-47SHALL

Consent Client SHALL support Consent search by scope

Links:

requirement-61SHALL

Consent Client SHALL support Consent search by status

Links:

requirement-53SHALL

Consent Client SHALL support $fileConsent operation against Consent resource

Links:

requirement-375SHALL

Consent Client SHALL support $updateConsent operation against Consent resource

Links:

requirement-376SHALL

Consent Client SHALL support $revokeConsent operation against Consent resource

Links:

requirement-381SHALL

Consent Client SHALL support Consent subscriptions as defined by the FASTConsentSubscriptionTopic for FHIR R4 with Subscriptions Backport

Links:

requirement-382SHALL

Consent Client SHALL support Subscription create

Links:

requirement-383SHALL

Consent Client SHALL support Subscription update

Links:

requirement-384SHALL

Consent Client SHALL support Subscription delete

Links:

requirement-416SHALL

Consent Client SHALL support $recordDisclosure operation against AuditEvent resource

Links:

requirement-401SHALL

Consent Client SHALL support AuditEvent resource

Links:

requirement-402SHALL

Consent Client SHALL support AuditEvent resources that conform to FASTConsentAuditEvent profile

Links:

requirement-403SHALL

Consent Client SHALL mark with profile assertions AuditEvent resources that conform to the FASTConsentAuditEvent profile<br/><br/>Base FHIR requirement, applies because of declaring supportedProfile. Not marking as fully tested because I will continue to need to trace this to every transaction that applies.

Links:

requirement-405SHALL

Consent Client SHALL support AuditEvent read

Links:

requirement-408SHALL

Consent Client SHALL support AuditEvent search

Links:

requirement-411SHALL

Consent Client SHALL support AuditEvent search by FASTAuditEventConsent

Links:

requirement-414SHALL

Consent Client SHALL support AuditEvent search by patient

Links: