Scalable Consent Management
0.1.0 - ci-build
Scalable Consent Management
0.1.0 - ci-build
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
| Official URL: http://hl7.org/fhir/us/consent-management/Requirements/extended-operations-client-admin-service | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: ExtendedOperationsClientAdminService | ||
Extended Operations Requirements for Client Admin Service
These requirements apply to the following actors:
Specification: HL7 FAST Consent IG
Reference: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.html
Conformance: SHALL
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-463
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-463
Notes: For the most part, I'm not going to trace to everything in StructDefs, because the FHIR validator will check these. We may revisit this decision.
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-463
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-463
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-file-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-463
Notes: Note no defined way to return Consent ID
Specification: HL7 FAST Consent IG
Reference: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html
Conformance: SHALL
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-465
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-465
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-465
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-465
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-update-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-465
Specification: HL7 FAST Consent IG
Reference: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.html
Conformance: SHALL
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-466
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-466
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-466
Related Requirement: Requirements-structure-definitions-client-admin-service.html#requirement-597
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-466
Notes: - See http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html - Consider tracking that
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-466
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-revoke-consent.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-466
Specification: HL7 FAST Consent IG
Reference: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html
Conformance: SHALL
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-467
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-467
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-467
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html
Conformance: SHALL
Parent: Requirements-extended-operations-client-admin-service.html#requirement-467
Related Requirement: Requirements-structure-definitions-client-admin-service.html#requirement-597
Specification: HL7 FAST Consent IG
Link to Text: https://build.fhir.org/ig/HL7/fhir-consent-management/OperationDefinition-record-disclosure.json.html
Conformance: SHALL
These requirements apply to the following actors:
| requirement-463 | SHALL | OperationDefinition FileConsent Links:
|
| requirement-133 | SHALL | The FileConsent operation is invoked as [base]/Consent/$fileConsent Links:
|
| requirement-134 | SHALL | The FileConsent operation input parameters SHALL conform to the FileConsentParameters profile<br/><br/>For the most part, I'm not going to trace to everything in StructDefs, because the FHIR validator will check these. We may revisit this decision. Links:
|
| requirement-135 | SHALL | The FileConsent operation "consent" input parameter SHALL be 1..1 and a Consent resource Links:
|
| requirement-166 | SHALL | The FileConsent operation "document" input parameter SHALL be 1..1 and any resource Links:
|
| requirement-168 | SHALL | The FileConsent operation "return" output parameter SHALL be 0..1 and be an OperationOutcome<br/><br/>Note no defined way to return Consent ID Links:
|
| requirement-465 | SHALL | OperationDefinition UpdateConsent Links:
|
| requirement-431 | SHALL | The UpdateConsent operation is invoked as [base]/Consent/$updateConsent Links:
|
| requirement-432 | SHALL | The UpdateConsent operation input parameters SHALL conform to the UpdateConsentParameters profile Links:
|
| requirement-433 | SHALL | The UpdateConsent operation "consent" input parameter SHALL be 1..1 and a Consent resource Links:
|
| requirement-435 | SHALL | The UpdateConsent operation "document" input parameter SHALL be 1..1 and any resource Links:
|
| requirement-437 | SHALL | The UpdateConsent operation "return" output parameter SHALL be 0..1 and be an OperationOutcome Links:
|
| requirement-466 | SHALL | OperationDefinition RevokeConsent Links:
|
| requirement-438 | SHALL | The RevokeConsent operation is invoked as [base]/Consent/$revokeConsent Links:
|
| requirement-439 | SHALL | The RevokeConsent operation input parameters SHALL conform to the RevokeConsentParameters profile Links:
|
| requirement-440 | SHALL | The RevokeConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile Links:
|
| requirement-447 | SHALL | The RevokeConsent operation "patient" input parameter SHALL be 1..1 and conform to the us-core-patient profile<br/><br/>- See http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html
Links:
|
| requirement-442 | SHALL | The RevokeConsent operation "document" input parameter SHALL be 0..1 and any resource Links:
|
| requirement-444 | SHALL | The RevokeConsent operation "return" output parameter SHALL be 0..1 and be an OperationOutcome Links:
|
| requirement-467 | SHALL | OperationDefinition RecordDisclosure Links:
|
| requirement-445 | SHALL | The RecordDisclosure operation is invoked as [base]/AuditEvent/$recordDisclosure Links:
|
| requirement-446 | SHALL | The RecordDisclosure operation input parameters SHALL conform to the RecordDisclosureParameters profile Links:
|
| requirement-451 | SHALL | The RecordDisclosure operation "disclosure" input parameter SHALL be 1..1 and an AuditEvent resource Links:
|
| requirement-449 | SHALL | The RecordDisclosure operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile Links:
|
| requirement-453 | SHALL | The RecordDisclosure operation "return" output parameter SHALL be 0..1 and be an OperationOutcome Links:
|
IG © 2024+ HL7 International / Community Based Collaborative Care. Package hl7.fhir.us.consent-management#0.1.0 based on FHIR 4.0.1. Generated 2025-09-05
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change