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
| Page standards status: Trial-use | Maturity Level: 1 |
<Requirements xmlns="http://hl7.org/fhir">
<id value="structure-definitions-client-admin-service"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Requirements structure-definitions-client-admin-service</b></p><a name="structure-definitions-client-admin-service"> </a><a name="hcstructure-definitions-client-admin-service"> </a><p>These requirements apply to the following actors: </p><ul><li><a href="ActorDefinition-admin-service.html">Admin Service</a></li><li><a href="ActorDefinition-client.html">Client</a></li></ul><table class="grid"><tr><td><b><a name="464"> </a></b>requirement-464</td><td>SHALL</td><td><div><p>StructureDefinition FileConsentParameters</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name="70"> </a></b>requirement-70</td><td>SHALL</td><td><div><p>The FileConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html#Parameters.parameter:consent">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="430"> </a></b>requirement-430</td><td>SHALL</td><td><div><p>The FileConsent operation "document" input parameter SHALL be 1..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html#Parameters.parameter:document">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="468"> </a></b>requirement-468</td><td>SHALL</td><td><div><p>StructureDefinition UpdateConsentParameters</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name="434"> </a></b>requirement-434</td><td>SHALL</td><td><div><p>The UpdateConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html#Parameters.parameter:consent">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="436"> </a></b>requirement-436</td><td>SHALL</td><td><div><p>The UpdateConsent operation "document" input parameter SHALL be 1..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html#Parameters.parameter:document">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="469"> </a></b>requirement-469</td><td>SHALL</td><td><div><p>StructureDefinition RevokeConsentParameters</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters.html</a></li></ul></td></tr><tr><td><b><a name="441"> </a></b>requirement-441</td><td>SHALL</td><td><div><p>The RevokeConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:consent">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="448"> </a></b>requirement-448</td><td>SHALL</td><td><div><p>The RevokeConsent operation "patient" input parameter SHALL be 1..1 and conform to the us-core-patient profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:patient">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="443"> </a></b>requirement-443</td><td>SHALL</td><td><div><p>The RevokeConsent operation "document" input parameter SHALL be 0..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:document">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="470"> </a></b>requirement-470</td><td>SHALL</td><td><div><p>StructureDefinition RecordDisclosureParameters</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters.html</a></li></ul></td></tr><tr><td><b><a name="452"> </a></b>requirement-452</td><td>SHALL</td><td><div><p>The RecordDisclosure operation "disclosure" input parameter SHALL be 1..1 and conform to the FASTConsentAuditEvent profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html#key_Parameters.parameter:disclosure">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="450"> </a></b>requirement-450</td><td>SHALL</td><td><div><p>The RecordDisclosure operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html#Parameters.parameter:consent">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html</a></li></ul></td></tr><tr><td><b><a name="477"> </a></b>requirement-477</td><td>SHALL</td><td><div><p>StructureDefinition FASTSubscription<br/><br/>- No requirements to use this yet</p>
<ul>
<li>The constraint that status is always "active" might not make sense. I think the client is supposed to POST it as "requested".</li>
</ul>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTSubscription.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTSubscription.html</a></li></ul></td></tr><tr><td><b><a name="595"> </a></b>requirement-595</td><td>SHALL</td><td><div><p>StructureDefinition BackportSubscription</p>
</div><p>Links: </p><ul><li>Derived From: <code>Subscriptions R5 Backport</code></li><li>References: <a href="https://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription.html">https://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription.html</a></li></ul></td></tr><tr><td><b><a name="597"> </a></b>requirement-597</td><td>SHALL</td><td><div><p>StructureDefinition FASTConsent<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTConsent.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTConsent.html</a></li></ul></td></tr><tr><td><b><a name="599"> </a></b>requirement-599</td><td>SHALL</td><td><div><p>StructureDefinition FASTDocumentReference<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTDocumentReference.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTDocumentReference.html</a></li></ul></td></tr><tr><td><b><a name="601"> </a></b>requirement-601</td><td>SHALL</td><td><div><p>StructureDefinition FASTReference<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTReference.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTReference.html</a></li></ul></td></tr><tr><td><b><a name="598"> </a></b>requirement-598</td><td>SHALL</td><td><div><p>StructureDefinition FASTConsentAuditEvent<br/><br/>Many nested profiles, including from US Core. Will be checked by validator.</p>
</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>References: <a href="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTConsentAuditEvent.html">https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTConsentAuditEvent.html</a></li></ul></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cbcc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="1">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/consent-management/Requirements/structure-definitions-client-admin-service"/>
<version value="0.1.0"/>
<name value="StructureDefinitionsClientAdminService"/>
<title value="Structure Definitions Client Admin Service"/>
<status value="active"/>
<experimental value="false"/>
<date value="2025-09-03T19:43:24-04:00"/>
<publisher value="HL7 International / Community Based Collaborative Care"/>
<contact>
<name value="HL7 International / Community Based Collaborative Care"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cbcc"/>
</telecom>
</contact>
<description
value="Structure Definitions Requirements for Client Admin Service"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<actor
value="http://hl7.org/fhir/us/consent-management/ActorDefinition/admin-service"/>
<actor
value="http://hl7.org/fhir/us/consent-management/ActorDefinition/client"/>
<statement>
<key value="464"/>
<label value="requirement-464"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="StructureDefinition FileConsentParameters"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters.html"/>
</statement>
<statement>
<key value="70"/>
<label value="requirement-70"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The FileConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-464"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html#Parameters.parameter:consent"/>
</statement>
<statement>
<key value="430"/>
<label value="requirement-430"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The FileConsent operation "document" input parameter SHALL be 1..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-464"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FileConsentParameters-definitions.html#Parameters.parameter:document"/>
</statement>
<statement>
<key value="468"/>
<label value="requirement-468"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="StructureDefinition UpdateConsentParameters"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters.html"/>
</statement>
<statement>
<key value="434"/>
<label value="requirement-434"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The UpdateConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-468"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html#Parameters.parameter:consent"/>
</statement>
<statement>
<key value="436"/>
<label value="requirement-436"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The UpdateConsent operation "document" input parameter SHALL be 1..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-468"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-UpdateConsentParameters-definitions.html#Parameters.parameter:document"/>
</statement>
<statement>
<key value="469"/>
<label value="requirement-469"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="StructureDefinition RevokeConsentParameters"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters.html"/>
</statement>
<statement>
<key value="441"/>
<label value="requirement-441"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RevokeConsent operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-469"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:consent"/>
</statement>
<statement>
<key value="448"/>
<label value="requirement-448"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RevokeConsent operation "patient" input parameter SHALL be 1..1 and conform to the us-core-patient profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-469"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:patient"/>
</statement>
<statement>
<key value="443"/>
<label value="requirement-443"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RevokeConsent operation "document" input parameter SHALL be 0..1 and conform to either the us-core-questionnaireresponse or FASTDocumentReference profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-469"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RevokeConsentParameters-definitions.html#Parameters.parameter:document"/>
</statement>
<statement>
<key value="470"/>
<label value="requirement-470"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="StructureDefinition RecordDisclosureParameters"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters.html"/>
</statement>
<statement>
<key value="452"/>
<label value="requirement-452"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RecordDisclosure operation "disclosure" input parameter SHALL be 1..1 and conform to the FASTConsentAuditEvent profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-470"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html#key_Parameters.parameter:disclosure"/>
</statement>
<statement>
<key value="450"/>
<label value="requirement-450"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The RecordDisclosure operation "consent" input parameter SHALL be 1..1 and conform to the FASTConsent profile"/>
<derivedFrom value="HL7 FAST Consent IG"/>
<parent
value="Requirements-structure-definitions-client-admin-service.html#requirement-470"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-RecordDisclosureParameters-definitions.html#Parameters.parameter:consent"/>
</statement>
<statement>
<key value="477"/>
<label value="requirement-477"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="StructureDefinition FASTSubscription<br/><br/>- No requirements to use this yet
- The constraint that status is always "active" might not make sense. I think the client is supposed to POST it as "requested"."/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTSubscription.html"/>
</statement>
<statement>
<key value="595"/>
<label value="requirement-595"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement value="StructureDefinition BackportSubscription"/>
<derivedFrom value="Subscriptions R5 Backport"/>
<reference
value="https://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription.html"/>
</statement>
<statement>
<key value="597"/>
<label value="requirement-597"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="StructureDefinition FASTConsent<br/><br/>Many nested profiles, including from US Core. Will be checked by validator."/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTConsent.html"/>
</statement>
<statement>
<key value="599"/>
<label value="requirement-599"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="StructureDefinition FASTDocumentReference<br/><br/>Many nested profiles, including from US Core. Will be checked by validator."/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTDocumentReference.html"/>
</statement>
<statement>
<key value="601"/>
<label value="requirement-601"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="StructureDefinition FASTReference<br/><br/>Many nested profiles, including from US Core. Will be checked by validator."/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTReference.html"/>
</statement>
<statement>
<key value="598"/>
<label value="requirement-598"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="StructureDefinition FASTConsentAuditEvent<br/><br/>Many nested profiles, including from US Core. Will be checked by validator."/>
<derivedFrom value="HL7 FAST Consent IG"/>
<reference
value="https://build.fhir.org/ig/HL7/fhir-consent-management/StructureDefinition-FASTConsentAuditEvent.html"/>
</statement>
</Requirements>
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