FHIR IG analytics| Package | hl7.fhir.us.consent-management |
| Resource Type | ImplementationGuide |
| Id | ImplementationGuide-hl7.fhir.us.consent-management.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/fhir-consent-management/index.html |
| URL | http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management |
| Version | 1.0.0-ballot |
| Status | active |
| Date | 2025-12-04T07:15:50+00:00 |
| Name | ScalableConsentManagement |
| Title | Scalable Consent Management |
| Realm | us |
| Authority | hl7 |
| Description | A FHIR IG that provides APIs for managing consent at scale across multiple consent management repositories. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide hl7.fhir.us.consent-management
The official URL for this implementation guide is:
http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management
A FHIR IG that provides APIs for managing consent at scale across multiple consent management repositories.
FHIR
FHIRsmith{
"resourceType": "ImplementationGuide",
"id": "hl7.fhir.us.consent-management",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cbcc"
}
],
"url": "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management",
"version": "1.0.0-ballot",
"name": "ScalableConsentManagement",
"title": "Scalable Consent Management",
"status": "active",
"date": "2025-12-04T07:15:50+00:00",
"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/homehealth"
}
]
}
],
"description": "A FHIR IG that provides APIs for managing consent at scale across multiple consent management repositories.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
]
}
],
"packageId": "hl7.fhir.us.consent-management",
"license": "CC0-1.0",
"fhirVersion": [
"4.0.1"
],
"dependsOn": [
{
"id": "hl7tx",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
}
],
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"packageId": "hl7.terminology.r4",
"version": "7.0.0"
},
{
"id": "uscore",
"uri": "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core",
"packageId": "hl7.fhir.us.core",
"version": "6.1.0"
},
{
"id": "subscriptions",
"uri": "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport",
"packageId": "hl7.fhir.uv.subscriptions-backport.r4",
"version": "1.1.0"
},
{
"id": "iheconsent",
"uri": "https://profiles.ihe.net/ITI/PCF/ImplementationGuide/ihe.iti.pcf",
"packageId": "ihe.iti.pcf",
"version": "1.1.0"
},
{
"id": "ihebalp",
"uri": "https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp",
"packageId": "ihe.iti.balp",
"version": "1.1.4"
},
{
"id": "hl7_fhir_uv_sdc",
"uri": "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc",
"packageId": "hl7.fhir.uv.sdc",
"version": "3.0.0"
},
{
"id": "hl7_fhir_uv_extensions_r4",
"uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"packageId": "hl7.fhir.uv.extensions.r4",
"version": "5.2.0"
}
],
"definition": {
"extension": [
{
"extension": [
{
"url": "code",
"valueString": "copyrightyear"
},
{
"url": "value",
"valueString": "2024+"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "releaselabel"
},
{
"url": "value",
"valueString": "STU 1 Ballot"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "show-inherited-invariants"
},
{
"url": "value",
"valueString": "false"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-publisher"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-contact"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "produce-jekyll-data"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "globals-in-artifacts"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "pin-canonicals"
},
{
"url": "value",
"valueString": "pin-multiples"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-history"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/us/consent-management/history.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "autoload-resources"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-liquid"
},
{
"url": "value",
"valueString": "template/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-liquid"
},
{
"url": "value",
"valueString": "input/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-qa"
},
{
"url": "value",
"valueString": "temp/qa"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-temp"
},
{
"url": "value",
"valueString": "temp/pages"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-output"
},
{
"url": "value",
"valueString": "output"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-suppressed-warnings"
},
{
"url": "value",
"valueString": "input/ignoreWarnings.txt"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "template-html"
},
{
"url": "value",
"valueString": "template-page.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "template-md"
},
{
"url": "value",
"valueString": "template-page-md.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-context"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-copyright"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-jurisdiction"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-license"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-version"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-wg"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "active-tables"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "fmm-definition"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "propagate-status"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "excludelogbinaryformat"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "tabbed-snapshots"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r4#0.8.0"
},
{
"extension": [
{
"url": "code",
"valueCode": "copyrightyear"
},
{
"url": "value",
"valueString": "2024+"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "releaselabel"
},
{
"url": "value",
"valueString": "STU 1 Ballot"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "show-inherited-invariants"
},
{
"url": "value",
"valueString": "false"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-publisher"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-contact"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "produce-jekyll-data"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "globals-in-artifacts"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "pin-canonicals"
},
{
"url": "value",
"valueString": "pin-multiples"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-history"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/us/consent-management/history.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "autoload-resources"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-liquid"
},
{
"url": "value",
"valueString": "template/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-liquid"
},
{
"url": "value",
"valueString": "input/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-qa"
},
{
"url": "value",
"valueString": "temp/qa"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-temp"
},
{
"url": "value",
"valueString": "temp/pages"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-output"
},
{
"url": "value",
"valueString": "output"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-suppressed-warnings"
},
{
"url": "value",
"valueString": "input/ignoreWarnings.txt"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "template-html"
},
{
"url": "value",
"valueString": "template-page.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "template-md"
},
{
"url": "value",
"valueString": "template-page-md.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-context"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-copyright"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-jurisdiction"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-license"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-version"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-wg"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "active-tables"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "fmm-definition"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "propagate-status"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "excludelogbinaryformat"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "tabbed-snapshots"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
}
],
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ActorDefinition"
}
],
"reference": {
"reference": "ActorDefinition/admin-service"
},
"name": "Admin Service",
"description": "Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/capstmt-admin-service"
},
"name": "CapStmt Admin Service",
"description": "CapStmt Requirements for Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/capstmt-client"
},
"name": "CapStmt Client",
"description": "CapStmt Requirements for Client",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ActorDefinition"
}
],
"reference": {
"reference": "ActorDefinition/client"
},
"name": "Client",
"description": "Client",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/components-admin-service"
},
"name": "Components Admin Service",
"description": "Components Requirements for Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/components-client"
},
"name": "Components Client",
"description": "Components Requirements for Client",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/conformance-admin-service"
},
"name": "Conformance Admin Service",
"description": "Conformance Requirements for Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/conformance-client"
},
"name": "Conformance Client",
"description": "Conformance Requirements for Client",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/conformance-client-admin-service"
},
"name": "Conformance Client Admin Service",
"description": "Conformance Requirements for Client Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
}
],
"reference": {
"reference": "CapabilityStatement/ConsentAdministrativeServerCapabilities"
},
"name": "Consent Administrative Server Capabilities",
"description": "Capabilities required for a server system receiving consents.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
}
],
"reference": {
"reference": "CapabilityStatement/ConsentClientCapabilities"
},
"name": "Consent Client Capabilities",
"description": "Capabilities required for a client system filing and review consents.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "AuditEvent"
}
],
"reference": {
"reference": "AuditEvent/ConsentAuditEventExample"
},
"name": "ConsentAuditEventExample",
"description": "An example of a Consent Audit Event",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsentAuditEvent"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Consent"
}
],
"reference": {
"reference": "Consent/ConsentExample"
},
"name": "ConsentExample",
"description": "An example of a consent.",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "DocumentReference"
}
],
"reference": {
"reference": "DocumentReference/DocumentReferenceExample"
},
"name": "DocumentReferenceExample",
"description": "An example of a consent document.",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTDocumentReference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/extended-operations-client-admin-service"
},
"name": "Extended Operations Client Admin Service",
"description": "Extended Operations Requirements for Client Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/FASTConsentStatuses"
},
"name": "FAST Consent Statuses",
"description": "The two codes that are applicable to FAST Consent instances. 'active' for active Consents, and 'inactive' for revoked Consents.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SubscriptionTopic"
}
],
"reference": {
"reference": "SubscriptionTopic/FASTConsentSubscriptionTopic"
},
"name": "FAST Consent Subscription Topic",
"description": "This is the subscription topic used for ensuring Consent records are updated amongst a set of Consent Registries.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/fast-auditevent-consent"
},
"name": "fast-auditevent-consent",
"description": "The Record Disclosure AuditEvent consent reference which is defined by the AuditEvent entity.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/fast-consent-controller"
},
"name": "fast-consent-controller",
"description": "The Consent controller reference which is defined by the Consent extension controller.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/fast-consent-grantee"
},
"name": "fast-consent-grantee",
"description": "The Consent grantee reference which is defined by the Consent extension grantee.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/fast-consent-manager"
},
"name": "fast-consent-manager",
"description": "The Consent manager reference which is defined by the Consent extension manager.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/fast-consent-organizationId"
},
"name": "fast-consent-organizationId",
"description": "The Consent organization identifier which is defined either within one or more of the extensions grantee, manager, controller or the provision.actor.role.reference.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "SearchParameter"
}
],
"reference": {
"reference": "SearchParameter/fast-consent-patientId"
},
"name": "fast-consent-patientId",
"description": "The Consent patient identifier which is defined either within the patient.identifier element or in one or more patient.extension additionalIdentifier.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/FASTConsent"
},
"name": "FASTConsent",
"description": "This profile captures the details of a Patient's Consent.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/FASTConsentAuditEvent"
},
"name": "FASTConsentAuditEvent",
"description": "Disclosures are recorded as FHIR AuditEvent instances. These AuditEvents reflect the Consent instance that was consulted and whether the decision to disclose data was made or not.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/FASTDocumentReference"
},
"name": "FASTDocumentReference",
"description": "This profile records non-structured documentation that records a patient's consent.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Subscription"
}
],
"reference": {
"reference": "Subscription/FASTOrganizationSubscriptionExample"
},
"name": "FASTOrganizationSubscriptionExample",
"description": "An example of a FAST Subscription for a specific organization.",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTSubscription"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Subscription"
}
],
"reference": {
"reference": "Subscription/FASTPatientSubscriptionExample"
},
"name": "FASTPatientSubscriptionExample",
"description": "An example of a FAST Subscription for a specific patient.",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTSubscription"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:complex-type"
}
],
"reference": {
"reference": "StructureDefinition/FASTReference"
},
"name": "FASTReference",
"description": "A profile on the Reference datatype that requires the identifier and exposes a set of additional identifiers in an extension.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/FASTSubscription"
},
"name": "FASTSubscription",
"description": "A profile for FAST subscriptions.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Bundle"
}
],
"reference": {
"reference": "Bundle/FASTSubscriptionNotification"
},
"name": "FASTSubscriptionNotification",
"description": "An example of a FAST Subscription Notification",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Parameters"
}
],
"reference": {
"reference": "Parameters/FASTSubscriptionNotificationParameters"
},
"name": "FASTSubscriptionNotificationParameters",
"description": "An example of the parameters going back for a FAST subscription notification",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "OperationDefinition"
}
],
"reference": {
"reference": "OperationDefinition/file-consent"
},
"name": "File a Consent",
"description": "This operation is used to file a consent with a consent administration service. The parameters are the Consent resource along with accompanying documentation in the form of a DocumentReference (for PDF or other forms) or QuestionnaireResponse.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/FileConsentParameters"
},
"name": "File Consent Operation Parameters",
"description": "A profile that indicates the parameters for the File Consent operation.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Parameters"
}
],
"reference": {
"reference": "Parameters/FileConsentDocRefExample"
},
"name": "FileConsentDocRefExample",
"description": "An example of a $fileConsent Parameters resource with an optional DocumentReference.",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/FileConsentParameters"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Parameters"
}
],
"reference": {
"reference": "Parameters/FileConsentQuestionnaireExample"
},
"name": "FileConsentQuestionnaireExample",
"description": "An example of a $fileConsent Parameters resource with an optional QuestionnaireResponse.",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/FileConsentParameters"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/LOINCConsentDocumentTypes"
},
"name": "LOINC Consent Document Types",
"description": "These codes are used to convey the type of consent document being referenced.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "QuestionnaireResponse"
}
],
"reference": {
"reference": "QuestionnaireResponse/QuestionnaireResponseExample"
},
"name": "QuestionnaireResponseExample",
"description": "An example of a consent questionnaire response.",
"exampleBoolean": true
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/RecordDisclosureParameters"
},
"name": "Record Disclosure Operation Parameters",
"description": "A profile that indicates the parameters for the Record Disclosure operation.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "OperationDefinition"
}
],
"reference": {
"reference": "OperationDefinition/record-disclosure"
},
"name": "RecordDisclosure",
"description": "This operation is used to record a disclosure based on a given consent for a given patient with a consent administration service. The parameters are a Consent AuditEvent and a reference to the corresponding Consent resource.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Parameters"
}
],
"reference": {
"reference": "Parameters/RecordDisclosureExample"
},
"name": "RecordDisclosureExample",
"description": "An example of a $recordDisclosure Parameters resource.",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/RecordDisclosureParameters"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "OperationDefinition"
}
],
"reference": {
"reference": "OperationDefinition/revoke-consent"
},
"name": "Revoke a Consent",
"description": "This operation is used to revoke a consent with a consent administration service. The parameters are a reference to the Consent resource along with accompanying documentation in the form of a DocumentReference (for PDF or other forms) or QuestionnaireResponse.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/RevokeConsentParameters"
},
"name": "Revoke Consent Operation Parameters",
"description": "A profile that indicates the parameters for the Revoke Consent operation.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Parameters"
}
],
"reference": {
"reference": "Parameters/RevokeConsentExample"
},
"name": "RevokeConsentExample",
"description": "An example of a $revokeConsent Parameters resource.",
"exampleCanonical": "http://hl7.org/fhir/us/consent-management/StructureDefinition/RevokeConsentParameters"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/search-parameters-client-admin-service"
},
"name": "Search Parameters Client Admin Service",
"description": "Search Parameters Requirements for Client Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/structure-definitions-client-admin-service"
},
"name": "Structure Definitions Client Admin Service",
"description": "Structure Definitions Requirements for Client Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/subscriptiontopic-fastconsentsubscriptiontopic-admin-service"
},
"name": "SubscriptionTopic FASTConsentSubscriptionTopic Admin Service",
"description": "SubscriptionTopic FASTConsentSubscriptionTopic Requirements for Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/subscriptiontopic-fastconsentsubscriptiontopic-client"
},
"name": "SubscriptionTopic FASTConsentSubscriptionTopic Client",
"description": "SubscriptionTopic FASTConsentSubscriptionTopic Requirements for Client",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/subscriptiontopic-fastconsentsubscriptiontopic-client-admin-ser"
},
"name": "SubscriptionTopic FASTConsentSubscriptionTopic Client Admin Service",
"description": "SubscriptionTopic FASTConsentSubscriptionTopic Requirements for Client Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/technical-specification-admin-service"
},
"name": "Technical Specification Admin Service",
"description": "Technical Specification Requirements for Admin Service",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/technical-specification-client"
},
"name": "Technical Specification Client",
"description": "Technical Specification Requirements for Client",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/workflow-client-admin-service"
},
"name": "Workflow Client Admin Service",
"description": "Workflow Requirements for Client Admin Service",
"exampleBoolean": false
}
],
"page": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "toc.html"
}
],
"nameUrl": "toc.html",
"title": "Table of Contents",
"generation": "html",
"page": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "index.html"
}
],
"nameUrl": "index.html",
"title": "Overview",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "background.html"
}
],
"nameUrl": "background.html",
"title": "Reading this IG",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "usecases.html"
}
],
"nameUrl": "usecases.html",
"title": "Use Cases",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "implementation_notes.html"
}
],
"nameUrl": "implementation_notes.html",
"title": "Implementation Notes",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "credits.html"
}
],
"nameUrl": "credits.html",
"title": "Project and Participants",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "conformance.html"
}
],
"nameUrl": "conformance.html",
"title": "Conformance Expectations",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "technical.html"
}
],
"nameUrl": "technical.html",
"title": "Technical Specification",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "sharing.html"
}
],
"nameUrl": "sharing.html",
"title": "Consent and Information Sharing",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "artifact_overview.html"
}
],
"nameUrl": "artifact_overview.html",
"title": "Artifact Overview",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "downloads.html"
}
],
"nameUrl": "downloads.html",
"title": "Downloads",
"generation": "markdown"
}
]
},
"parameter": [
{
"code": "path-resource",
"value": "input/capabilities"
},
{
"code": "path-resource",
"value": "input/examples"
},
{
"code": "path-resource",
"value": "input/extensions"
},
{
"code": "path-resource",
"value": "input/models"
},
{
"code": "path-resource",
"value": "input/operations"
},
{
"code": "path-resource",
"value": "input/profiles"
},
{
"code": "path-resource",
"value": "input/resources"
},
{
"code": "path-resource",
"value": "input/vocabulary"
},
{
"code": "path-resource",
"value": "input/maps"
},
{
"code": "path-resource",
"value": "input/testing"
},
{
"code": "path-resource",
"value": "input/history"
},
{
"code": "path-resource",
"value": "fsh-generated/resources"
},
{
"code": "path-pages",
"value": "template/config"
},
{
"code": "path-pages",
"value": "input/images"
},
{
"code": "path-tx-cache",
"value": "input-cache/txcache"
}
]
}
}