FHIR IG analytics| Package | hl7.fhir.us.consent-management |
| Resource Type | Basic |
| Id | Basic-implementation-notes-client-consent-server.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/fhir-consent-management/Requirements-implementation-notes-client-consent-server.html |
| URL | http://hl7.org/fhir/us/consent-management/Requirements/implementation-notes-client-consent-server |
| Version | 1.0.0-preview |
| Status | active |
| Date | 2026-09-02T22:40:54-04:00 |
| Name | ImplementationNotesClientConsentServer |
| Title | Implementation Notes Client Consent Server |
| Realm | us |
| Authority | hl7 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: Requirements implementation-notes-client-consent-server
These requirements apply to the following actors:
| requirement-1185 | SHOULD | A consent administration service receiving a POST Subscription request SHOULD verify that the subscribing system is authorized to access the consents it is requesting to be notified about<br/><br/>Can test by combining Consent and Security tests. Links:
|
| requirement-1186 | SHALL | Access should be limited to consents where the requesting system is a named participant: for example, consents where the system's organization is identified as a controller, manager, or actor within a consent's provision Links:
|
| requirement-1187 | SHALL | Implementers of consent administration services should apply appropriate access control filters when processing search queries Links:
|
| requirement-1184 | SHOULD | A system that cannot maintain a subscription to the consent management source SHOULD fetch a fresh copy of the consent at the time of each authorization decision rather than rely on a cached copy Links:
|
| requirement-1183 | SHALL | When a copy of consent travels to a different system, before making decisions based on the consent, the enforcing system needs to ensure it is up to date<br/><br/>No conformance verb, but this is the key guidance that can drive both black box tests (e.g. A shares with B, B uses access, A revokes, B rejected) as well as tests for specific mechanisms and fallbacks, conditional on systems' support for each technique. Links:
|
| requirement-1181 | SHALL | When the Consent record is created on System A, System A's system identifier SHALL be recorded in the manager extension of the Consent instance Links:
|
| requirement-1182 | SHALL | Systems that ingest a Consent from another system SHALL preserve the manager extension value unchanged Links:
|
{
"resourceType": "Basic",
"id": "implementation-notes-client-consent-server",
"text": {
"status": "generated",
"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/5.0/StructureDefinition/extension-Requirements.url",
"valueUri": "http://hl7.org/fhir/us/consent-management/Requirements/implementation-notes-client-consent-server"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.version",
"valueString": "1.0.0-preview"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.name",
"valueString": "ImplementationNotesClientConsentServer"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.title",
"valueString": "Implementation Notes Client Consent Server"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.status",
"valueCode": "active"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.experimental",
"valueBoolean": false
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.date",
"valueDateTime": "2026-09-02T22:40:54-04:00"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.publisher",
"valueString": "HL7 International / Community Based Collaborative Care"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact",
"valueContactDetail": {
"name": "HL7 International / Community Based Collaborative Care",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/homehealth"
}
]
}
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.description",
"valueMarkdown": "Implementation Notes Requirements for Client Consent Server"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.jurisdiction",
"valueCodeableConcept": {
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
]
}
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.actor",
"valueCanonical": "http://hl7.org/fhir/us/consent-management/ActorDefinition/client"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.actor",
"valueCanonical": "http://hl7.org/fhir/us/consent-management/ActorDefinition/consent-server"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
"valueId": "1185"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
"valueString": "requirement-1185"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
"valueCode": "SHOULD"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
"valueMarkdown": "A consent administration service receiving a POST Subscription request SHOULD verify that the subscribing system is authorized to access the consents it is requesting to be notified about<br/><br/>Can test by combining Consent and Security tests."
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom",
"valueString": "HL7 FAST Consent IG"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.reference",
"valueUrl": "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=a%20consent%20administration%20service%20receiving%20a%20post%20subscription%20request%20should%20verify%20that%20the%20subscribing%20system%20is%20authorized%20to%20access%20the%20consents%20it%20is%20requesting%20to%20be%20notified%20about"
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
"valueId": "1186"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
"valueString": "requirement-1186"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
"valueMarkdown": "Access should be limited to consents where the requesting system is a named participant: for example, consents where the system's organization is identified as a controller, manager, or actor within a consent's provision"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom",
"valueString": "HL7 FAST Consent IG"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.reference",
"valueUrl": "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=access%20should%20be%20limited%20to%20consents%20where%20the%20requesting%20system%20is%20a%20named%20participant%3A%20for%20example%2C%20consents%20where%20the%20system%27s%20organization%20is%20identified%20as%20a%20controller%2C%20manager%2C%20or%20actor%20within%20a%20consent%27s%20provision"
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
"valueId": "1187"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
"valueString": "requirement-1187"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
"valueMarkdown": "Implementers of consent administration services should apply appropriate access control filters when processing search queries"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom",
"valueString": "HL7 FAST Consent IG"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.reference",
"valueUrl": "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=implementers%20of%20consent%20administration%20services%20should%20apply%20appropriate%20access%20control%20filters%20when%20processing%20search%20queries"
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
"valueId": "1184"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
"valueString": "requirement-1184"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
"valueCode": "SHOULD"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
"valueMarkdown": "A system that cannot maintain a subscription to the consent management source SHOULD fetch a fresh copy of the consent at the time of each authorization decision rather than rely on a cached copy"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom",
"valueString": "HL7 FAST Consent IG"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.reference",
"valueUrl": "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=a%20system%20that%20cannot%20maintain%20a%20subscription%20to%20the%20consent%20management%20source%20should%20fetch%20a%20fresh%20copy%20of%20the%20consent%20at%20the%20time%20of%20each%20authorization%20decision%20rather%20than%20rely%20on%20a%20cached%20copy"
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
"valueId": "1183"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
"valueString": "requirement-1183"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
"valueMarkdown": "When a copy of consent travels to a different system, before making decisions based on the consent, the enforcing system needs to ensure it is up to date<br/><br/>No conformance verb, but this is the key guidance that can drive both black box tests (e.g. A shares with B, B uses access, A revokes, B rejected) as well as tests for specific mechanisms and fallbacks, conditional on systems' support for each technique."
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom",
"valueString": "HL7 FAST Consent IG"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.reference",
"valueUrl": "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=when%20a%20copy%20of%20consent%20travels%20to%20a%20different%20system%2C%20before%20making%20decisions%20based%20on%20the%20consent%2C%20the%20enforcing%20system%20needs%20to%20ensure%20it%20is%20up%20to%20date"
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
"valueId": "1181"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
"valueString": "requirement-1181"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
"valueMarkdown": "When the Consent record is created on System A, System A's system identifier SHALL be recorded in the manager extension of the Consent instance"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom",
"valueString": "HL7 FAST Consent IG"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.reference",
"valueUrl": "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=when%20the%20consent%20record%20is%20created%20on%20system%20a%2C%20system%20a%27s%20system%20identifier%20shall%20be%20recorded%20in%20the%20manager%20extension%20of%20the%20consent%20instance"
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.key",
"valueId": "1182"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.label",
"valueString": "requirement-1182"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.conformance",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.requirement",
"valueMarkdown": "Systems that ingest a Consent from another system SHALL preserve the manager extension value unchanged"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.derivedFrom",
"valueString": "HL7 FAST Consent IG"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement.reference",
"valueUrl": "https://build.fhir.org/ig/HL7/fhir-consent-management/en/implementation_notes.html#:~:text=systems%20that%20ingest%20a%20consent%20from%20another%20system%20shall%20preserve%20the%20manager%20extension%20value%20unchanged"
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement"
}
],
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/fhir-types",
"code": "Requirements"
}
]
}
}