Scalable Consent Management
1.0.0-preview - STU 1 PReview 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 1.0.0-preview 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

: Subscription Topics Consent Server

Page standards status: Trial-use Maturity Level: 1

Raw json | Download

{
  "resourceType" : "Requirements",
  "id" : "subscription-topics-consent-server",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements subscription-topics-consent-server</b></p><a name=\"subscription-topics-consent-server\"> </a><a name=\"hcsubscription-topics-consent-server\"> </a><p>These requirements apply to the actor <a href=\"ActorDefinition-consent-server.html\">Consent Server</a></p><table class=\"grid\"><tr><td><b><a name=\"1174\"> </a></b>requirement-1174</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Consent Administration Service SHALL support Consent notification triggers based on create and update&lt;br/&gt;&lt;br/&gt;build: replaced requirement 1090</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22resourceTrigger%22%20%3A%20%5B%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22When%20a%20consent%20record%20has%20been%20%27touched%27%20and%20needs%20to%20be%20distributed%20amongst%20interested%20parties.%22%2C%0A%20%20%20%20%20%20%22resource%22%20%3A%20%22http%3A//hl7.org/fhir/StructureDefinition/Consent%22%2C%0A%20%20%20%20%20%20%22supportedInteraction%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22create%22%2C%0A%20%20%20%20%20%20%20%20%22update%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"1175\"> </a></b>requirement-1175</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Consent Administration Service SHALL support Consent notification filter by patient identifier</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=create%22%2C%0A%20%20%20%20%20%20%20%20%22update%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%0A%20%20%5D%2C%0A%20%20%22canFilterBy%22%20%3A%20%5B%0A%20%20%20%20%7B-,%22description%22%20%3A%20%22The%20patient%20whose,comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"1177\"> </a></b>requirement-1177</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Consent Administration Service SHALL support Consent notification filter by controller identifier</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%2C%0A%20%20%20%20%7B-,%22description%22%20%3A%20%22The%20controller%20of,comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"629\"> </a></b>requirement-629</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Consent Administration Service SHALL support Consent notification filter by actor identifier</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22description%22%20%3A%20%22The%20identifier%20of%20one%20of%20the%20actors%20that%20is%20controlled%20by%20a%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22actor%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dactor%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"630\"> </a></b>requirement-630</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Consent Administration Service SHALL support Consent notification filter by status</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22description%22%20%3A%20%22The%20status%20of%20a%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22status%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dstatus%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"1179\"> </a></b>requirement-1179</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Consent Administration Service SHALL support Consent notification filter by category</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FAST Consent IG</code></li><li>Satisfied By: <a href=\"https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22description%22%20%3A%20%22the%20category%20of%20the%20consent.%22%2C%20%22filterparameter%22%20%3A%20%22category%22%2C%20%22filterdefinition%22%20%3A%20%22http%3A//hl7.org/fhir/searchparameter/consent%2Dcategory%22%2C%20%22comparator%22%20%3A%20%5B%20%22eq%22%20%5D\">https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html</a></li></ul></td></tr><tr><td><b><a name=\"600\"> </a></b>requirement-600</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Consent Administration Service SHALL trigger a notification for every Consent create, unless filtered out&lt;br/&gt;&lt;br/&gt;This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FHIR R5</code></li><li>Satisfied By: <a href=\"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20create,interaction%20is%20confirmed%20to%20apply.\">https://hl7.org/fhir/subscriptiontopic.html</a></li></ul></td></tr><tr><td><b><a name=\"606\"> </a></b>requirement-606</td><td><a href=\"http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/CodeSystem-conformance-expectation.html#conformance-expectation-SHALL\">SHALL</a></td><td><div><p>Consent Administration Service SHALL trigger a notification for every Consent update, unless filtered out&lt;br/&gt;&lt;br/&gt;This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).</p>\n</div><p>Links: </p><ul><li>Derived From: <code>HL7 FHIR R5</code></li><li>Satisfied By: <a href=\"https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20update,PUT%20with%20an%20identical%20resource%29.\">https://hl7.org/fhir/subscriptiontopic.html</a></li></ul></td></tr></table></div>"
  },
  "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/us/consent-management/Requirements/subscription-topics-consent-server",
  "version" : "1.0.0-preview",
  "name" : "SubscriptionTopicsConsentServer",
  "title" : "Subscription Topics Consent Server",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-09-02T22:40:54-04: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" : "Subscription Topics Requirements for Consent Server",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "actor" : [
    🔗 "http://hl7.org/fhir/us/consent-management/ActorDefinition/consent-server"
  ],
  "statement" : [
    {
      "key" : "1174",
      "label" : "requirement-1174",
      "conformance" : [
        "SHALL"
      ],
      "conditionality" : false,
      "requirement" : "Consent Administration Service SHALL support Consent notification triggers based on create and update<br/><br/>build: replaced requirement 1090",
      "derivedFrom" : "HL7 FAST Consent IG",
      "parent" : "Requirements-subscription-topics-client-consent-server.html#requirement-596",
      "satisfiedBy" : [
        "https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22resourceTrigger%22%20%3A%20%5B%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%22description%22%20%3A%20%22When%20a%20consent%20record%20has%20been%20%27touched%27%20and%20needs%20to%20be%20distributed%20amongst%20interested%20parties.%22%2C%0A%20%20%20%20%20%20%22resource%22%20%3A%20%22http%3A//hl7.org/fhir/StructureDefinition/Consent%22%2C%0A%20%20%20%20%20%20%22supportedInteraction%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22create%22%2C%0A%20%20%20%20%20%20%20%20%22update%22"
      ]
    },
    {
      "key" : "1175",
      "label" : "requirement-1175",
      "conformance" : [
        "SHALL"
      ],
      "conditionality" : false,
      "requirement" : "Consent Administration Service SHALL support Consent notification filter by patient identifier",
      "derivedFrom" : "HL7 FAST Consent IG",
      "satisfiedBy" : [
        "https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=create%22%2C%0A%20%20%20%20%20%20%20%20%22update%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%0A%20%20%5D%2C%0A%20%20%22canFilterBy%22%20%3A%20%5B%0A%20%20%20%20%7B-,%22description%22%20%3A%20%22The%20patient%20whose,comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D"
      ]
    },
    {
      "key" : "1177",
      "label" : "requirement-1177",
      "conformance" : [
        "SHALL"
      ],
      "conditionality" : false,
      "requirement" : "Consent Administration Service SHALL support Consent notification filter by controller identifier",
      "derivedFrom" : "HL7 FAST Consent IG",
      "satisfiedBy" : [
        "https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D%0A%20%20%20%20%7D%2C%0A%20%20%20%20%7B-,%22description%22%20%3A%20%22The%20controller%20of,comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22%0A%20%20%20%20%20%20%5D"
      ]
    },
    {
      "key" : "629",
      "label" : "requirement-629",
      "conformance" : [
        "SHALL"
      ],
      "conditionality" : false,
      "requirement" : "Consent Administration Service SHALL support Consent notification filter by actor identifier",
      "derivedFrom" : "HL7 FAST Consent IG",
      "parent" : "Requirements-subscription-topics-client-consent-server.html#requirement-596",
      "satisfiedBy" : [
        "https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22description%22%20%3A%20%22The%20identifier%20of%20one%20of%20the%20actors%20that%20is%20controlled%20by%20a%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22actor%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dactor%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22modifier%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22identifier%22"
      ]
    },
    {
      "key" : "630",
      "label" : "requirement-630",
      "conformance" : [
        "SHALL"
      ],
      "conditionality" : false,
      "requirement" : "Consent Administration Service SHALL support Consent notification filter by status",
      "derivedFrom" : "HL7 FAST Consent IG",
      "parent" : "Requirements-subscription-topics-client-consent-server.html#requirement-596",
      "satisfiedBy" : [
        "https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22description%22%20%3A%20%22The%20status%20of%20a%20consent.%22%2C%0A%20%20%20%20%20%20%22filterParameter%22%20%3A%20%22status%22%2C%0A%20%20%20%20%20%20%22filterDefinition%22%20%3A%20%22http%3A//hl7.org/fhir/SearchParameter/Consent%2Dstatus%22%2C%0A%20%20%20%20%20%20%22comparator%22%20%3A%20%5B%0A%20%20%20%20%20%20%20%20%22eq%22"
      ]
    },
    {
      "key" : "1179",
      "label" : "requirement-1179",
      "conformance" : [
        "SHALL"
      ],
      "conditionality" : false,
      "requirement" : "Consent Administration Service SHALL support Consent notification filter by category",
      "derivedFrom" : "HL7 FAST Consent IG",
      "satisfiedBy" : [
        "https://build.fhir.org/ig/HL7/fhir-consent-management/en/SubscriptionTopic-FASTConsentSubscriptionTopic.json.html#:~:text=%22description%22%20%3A%20%22the%20category%20of%20the%20consent.%22%2C%20%22filterparameter%22%20%3A%20%22category%22%2C%20%22filterdefinition%22%20%3A%20%22http%3A//hl7.org/fhir/searchparameter/consent%2Dcategory%22%2C%20%22comparator%22%20%3A%20%5B%20%22eq%22%20%5D"
      ]
    },
    {
      "key" : "600",
      "label" : "requirement-600",
      "conformance" : [
        "SHALL"
      ],
      "conditionality" : false,
      "requirement" : "Consent Administration Service SHALL trigger a notification for every Consent create, unless filtered out<br/><br/>This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).",
      "derivedFrom" : "HL7 FHIR R5",
      "parent" : "Requirements-subscription-topics-client-consent-server.html#requirement-596",
      "satisfiedBy" : [
        "https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20create,interaction%20is%20confirmed%20to%20apply."
      ]
    },
    {
      "key" : "606",
      "label" : "requirement-606",
      "conformance" : [
        "SHALL"
      ],
      "conditionality" : false,
      "requirement" : "Consent Administration Service SHALL trigger a notification for every Consent update, unless filtered out<br/><br/>This requirement is derived by the definition in the topic plus the actual behavior defined in R5 SubscriptionTopic (which is what's linked).",
      "derivedFrom" : "HL7 FHIR R5",
      "parent" : "Requirements-subscription-topics-client-consent-server.html#requirement-596",
      "satisfiedBy" : [
        "https://hl7.org/fhir/subscriptiontopic.html#:~:text=Subscription%20Topics%20that%20include%20update,PUT%20with%20an%20identical%20resource%29."
      ]
    }
  ]
}