| Package | hl7.fhir.us.udap-security |
| Resource Type | ImplementationGuide |
| Id | hl7.fhir.us.udap-security |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/udap-security/https://build.fhir.org/ig/HL7/fhir-udap-security-ig/index.html |
| URL | http://hl7.org/fhir/us/udap-security/ImplementationGuide/hl7.fhir.us.udap-security |
| Version | 2.0.0 |
| Status | active |
| Date | 2025-07-28 |
| Name | UDAPSecurity |
| Title | Security for Scalable Registration, Authentication, and Authorization |
| Realm | us |
| Authority | hl7 |
| 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. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide hl7.fhir.us.udap-security
The official URL for this implementation guide is:
http://hl7.org/fhir/us/udap-security/ImplementationGuide/hl7.fhir.us.udap-security
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.
FHIR{
"resourceType": "ImplementationGuide",
"id": "hl7.fhir.us.udap-security",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "sec"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4
}
],
"url": "http://hl7.org/fhir/us/udap-security/ImplementationGuide/hl7.fhir.us.udap-security",
"version": "2.0.0",
"name": "UDAPSecurity",
"title": "Security for Scalable Registration, Authentication, and Authorization",
"status": "active",
"date": "2025-07-28",
"publisher": "HL7 International / Security",
"contact": [
{
"name": "HL7 International / Security",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/secure"
}
]
}
],
"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.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"packageId": "hl7.fhir.us.udap-security",
"license": "CC-BY-4.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": "6.5.0"
},
{
"id": "hl7ext",
"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"
}
],
"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": "2025+"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "releaselabel"
},
{
"url": "value",
"valueString": "STU 2"
}
],
"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-parameter"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r4#0.7.1"
},
{
"extension": [
{
"url": "code",
"valueCode": "copyrightyear"
},
{
"url": "value",
"valueString": "2025+"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "releaselabel"
},
{
"url": "value",
"valueString": "STU 2"
}
],
"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"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
}
],
"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": "Home",
"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": "discovery.html"
}
],
"nameUrl": "discovery.html",
"title": "Discovery",
"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": "registration.html"
}
],
"nameUrl": "registration.html",
"title": "Registration",
"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": "consumer.html"
}
],
"nameUrl": "consumer.html",
"title": "Consumer-Facing",
"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": "b2b.html"
}
],
"nameUrl": "b2b.html",
"title": "Business-to-Business",
"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": "user.html"
}
],
"nameUrl": "user.html",
"title": "Tiered OAuth for User Authentication",
"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": "general.html"
}
],
"nameUrl": "general.html",
"title": "General Requirements",
"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": "about.html"
}
],
"nameUrl": "about.html",
"title": "About",
"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": "changelog.html"
}
],
"nameUrl": "changelog.html",
"title": "Change Log",
"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"
}
]
}
}