{
  "description": "This implementation guide describes how to extend OAuth 2.0 to support secure and scalable workflows for business-to-business (B2B) apps that implement the client credentials flow or authorization code flow.",
  "_filename": "ImplementationGuide-hl7.fhir.us.udap-security.json",
  "package_name": "hl7.fhir.us.udap-security.r4",
  "definition": {
    "page": {
      "page": [ {
        "title": "Home",
        "nameUrl": "index.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "index.html"
        } ],
        "generation": "markdown"
      }, {
        "title": "Discovery",
        "nameUrl": "discovery.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "discovery.html"
        } ],
        "generation": "markdown"
      }, {
        "title": "Registration",
        "nameUrl": "registration.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "registration.html"
        } ],
        "generation": "markdown"
      }, {
        "title": "Consumer-Facing",
        "nameUrl": "consumer.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "consumer.html"
        } ],
        "generation": "markdown"
      }, {
        "title": "Business-to-Business",
        "nameUrl": "b2b.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "b2b.html"
        } ],
        "generation": "markdown"
      }, {
        "title": "Tiered OAuth for User Authentication",
        "nameUrl": "user.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "user.html"
        } ],
        "generation": "markdown"
      }, {
        "title": "General Guidance",
        "nameUrl": "general.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "general.html"
        } ],
        "generation": "markdown"
      }, {
        "title": "About",
        "nameUrl": "about.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "about.html"
        } ],
        "generation": "markdown"
      }, {
        "title": "Change Log",
        "nameUrl": "changelog.html",
        "extension": [ {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
          "valueUrl": "changelog.html"
        } ],
        "generation": "markdown"
      } ],
      "title": "Table of Contents",
      "nameUrl": "toc.html",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
        "valueUrl": "toc.html"
      } ],
      "generation": "html"
    },
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "copyrightyear"
      }, {
        "url": "value",
        "valueString": "2021+"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "releaselabel"
      }, {
        "url": "value",
        "valueString": "STU2 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-jurisdiction"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "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": "active-tables"
      }, {
        "url": "value",
        "valueString": "false"
      } ]
    }, {
      "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": "apply-version"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "usage-stats-opt-out"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "excludexml"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "excludettl"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "excludemap"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "path-history"
      }, {
        "url": "value",
        "valueString": "http://hl7.org/fhir/us/udap-security/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-license"
      }, {
        "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": "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-internal-dependency",
      "valueCode": "hl7.fhir.uv.tools.r4#0.3.0"
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueCode": "copyrightyear"
      }, {
        "url": "value",
        "valueString": "2021+"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueCode": "releaselabel"
      }, {
        "url": "value",
        "valueString": "STU2 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-jurisdiction"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "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": "active-tables"
      }, {
        "url": "value",
        "valueString": "false"
      } ]
    }, {
      "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": "apply-version"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueCode": "usage-stats-opt-out"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueCode": "excludexml"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueCode": "excludettl"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueCode": "excludemap"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueCode": "path-history"
      }, {
        "url": "value",
        "valueString": "http://hl7.org/fhir/us/udap-security/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-license"
      }, {
        "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": "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"
      } ]
    } ],
    "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"
    } ]
  },
  "date": "2024-12-02",
  "publisher": "HL7 International / Security",
  "fhirVersion": [ "4.0.1" ],
  "license": "CC-BY-4.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "US",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "dependsOn": [ {
    "id": "hl7tx",
    "uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
    "version": "6.1.0",
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
      "valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
    } ],
    "packageId": "hl7.terminology.r4"
  }, {
    "id": "hl7ext",
    "uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
    "version": "5.1.0",
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
      "valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"
    } ],
    "packageId": "hl7.fhir.uv.extensions.r4"
  }, {
    "id": "hl7_fhir_us_core",
    "uri": "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core",
    "version": "3.1.1",
    "packageId": "hl7.fhir.us.core"
  } ],
  "name": "UDAPSecurity",
  "type": null,
  "experimental": null,
  "resourceType": "ImplementationGuide",
  "title": "Security for Scalable Registration, Authentication, and Authorization",
  "package_version": "2.0.0-ballot",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "sec"
  } ],
  "status": "active",
  "id": "d9dc1448-8848-4db5-a236-56d283ffe044",
  "kind": null,
  "url": "http://hl7.org/fhir/us/udap-security/ImplementationGuide/hl7.fhir.us.udap-security",
  "version": "2.0.0-ballot",
  "packageId": "hl7.fhir.us.udap-security",
  "contact": [ {
    "name": "HL7 International / Security",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/secure",
      "system": "url"
    } ]
  } ]
}