Skip to content

Commit

Permalink
Fix casing on smart-configuration properties
Browse files Browse the repository at this point in the history
  • Loading branch information
jmandel committed Jan 31, 2024
1 parent f9202c7 commit b6b3d07
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions input/pages/brands.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@ Commonly, a single Brand is typically associated with a single Portal that offer
* MAY provide a Data Absent Reason of `asked-declined` or `asked-unknown` in a Brand Bundle
* SHALL NOT use Data Absent Reasons other than `asked-declined` or `asked-unknown` in a Brand Bundle
* **SMART on FHIR Server**. Any SMART on FHIR server that supports discovery of a User Access Brand Bundle.
* SHOULD include `userAccessBrandBundle` and `userAccessBrandIdentifier` properties in the SMART configuration JSON response
* When populating `userAccessBrandBundle`
* SHOULD include `user_access_brand_bundle` and `user_access_brand_identifier` properties in the SMART configuration JSON response
* When populating `user_access_brand_bundle`
* SHOULD link to a Bundle that includes only Brands and Endpoints affiliated with the Health Data Provider responsible for this SMART on FHIR server
* MAY link to a Bundle with Brands or Endpoints for additional Health Data Providers
* SHALL populate `userAccessBrandIdentifier` in SMART configuration JSON response if the `userAccessBrandBundle` refers to a Bundle with multiple Brands.
* When populating `userAccessBrandIdentifier`
* SHALL populate `user_access_brand_identifier` in SMART configuration JSON response if the `user_access_brand_bundle` refers to a Bundle with multiple Brands.
* When populating `user_access_brand_identifier`
* SHALL include a `value`
* SHOULD include a `system`
* SHALL ensure this identifier matches exactly one `Organization.identifier` in the referenced Brand Bundle
Expand Down Expand Up @@ -363,8 +363,8 @@ Publishers SHOULD include a weak `ETag` header in all HTTP responses. Clients SH

To ensure that SMART apps can discover Brand information directly from a FHIR endpoint's base URL, FHIR servers supporting this IG SHOULD include the following properties in the SMART configuration JSON response:

* `userAccessBrandBundle` URL of a Brand Bundle. The Bundle entries include any Brand and "peer endpoints" associated with this FHIR endpoint.
* `userAccessBrandIdentifier`: FHIR Identifier for this server's primary Brand within the Bundle. Publishers SHALL populate this property if the referenced Brand Bundle includes more than one Brand. When present, this identifier SHALL consist of a `value` and SHOULD have a `system`.
* `user_access_brand_bundle` URL of a Brand Bundle. The Bundle entries include any Brand and "peer endpoints" associated with this FHIR endpoint.
* `user_access_brand_identifier`: FHIR Identifier for this server's primary Brand within the Bundle. Publishers SHALL populate this property if the referenced Brand Bundle includes more than one Brand. When present, this identifier SHALL consist of a `value` and SHOULD have a `system`.

The Brand Bundle SHALL include exactly one Brand with an `Organization.identifier` that matches the primary Brand identifier from SMART configuration JSON.

Expand All @@ -375,16 +375,16 @@ The Brand Bundle SHOULD include only the Brands and Endpoints associated with th
```javascript
{
// details at http://hl7.org/fhir/smart-app-launch/conformance.html
"userAccessBrandBundle": "https://example.org/brands.json",
"userAccessBrandIdentifier": {
"user_access_brand_bundle": "https://example.org/brands.json",
"user_access_brand_identifier": {
"system": "urn:ietf:rfc:3986",
"value": "https://example.org"
},
// ...
}
```

Dereferencing the `userAccessBrandBundle` URL above would return a Brand Bundle.
Dereferencing the `user_access_brand_bundle` URL above would return a Brand Bundle.

#### Must-Support Definition (`MS`) and Data Absent Reasons

Expand Down
4 changes: 2 additions & 2 deletions input/pages/conformance.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,8 @@ A JSON document must be returned using the `application/json` mime type.
- `token_endpoint_auth_methods_supported`: **OPTIONAL**, array of client authentication methods supported by the token endpoint. The options are "client_secret_post", "client_secret_basic", and "private_key_jwt".
- `registration_endpoint`: **OPTIONAL**, If available, URL to the OAuth2 dynamic registration endpoint for this FHIR server.
- `associated_endpoints`: **OPTIONAL**, Array of objects for endpoints that share the same authorization mechanism as this FHIR endpoint, each with a "url" and "capabilities" array
- `userAccessBrandBundle`: **RECOMMENDED**, URL for a Brand Bundle. See [User Access Brands](brands.html).
- `userAccessBrandIdentifier`: **RECOMMENDED**, Identifier for the primary entry in a Brand Bundle. See [User Access Brands](brands.html).
- `user_access_brand_bundle`: **RECOMMENDED**, URL for a Brand Bundle. See [User Access Brands](brands.html).
- `user_access_brand_identifier`: **RECOMMENDED**, Identifier for the primary entry in a Brand Bundle. See [User Access Brands](brands.html).
- `scopes_supported`: **RECOMMENDED**, Array of scopes a client may request. See [scopes and launch context](scopes-and-launch-context.html#quick-start). The server SHALL support all scopes listed here; additional scopes MAY be supported (so clients should not consider this an exhaustive list).
- `response_types_supported`: **RECOMMENDED**, Array of OAuth2 `response_type` values that are supported. Implementers can refer to `response_type`s defined in OAuth 2.0 ([RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749)) and in [OIDC Core](https://openid.net/specs/openid-connect-core-1_0.html#Authentication).
- `management_endpoint`: **RECOMMENDED**, URL where an end-user can view which applications currently have access to data and can make adjustments to these access rights.
Expand Down

0 comments on commit b6b3d07

Please sign in to comment.