From d6889c7755fde611d39b0ee7f4b040136c952136 Mon Sep 17 00:00:00 2001 From: Josh Mandel Date: Fri, 26 Jan 2024 15:17:08 -0600 Subject: [PATCH] Rename to UAB --- input/includes/fsh-link-references.md | 10 +-- input/includes/menu.xml | 4 +- input/includes/note-to-balloters.md | 2 +- input/pages/brands.md | 78 +++++++++---------- input/pages/conformance.md | 4 +- input/pages/example-brands.md | 4 +- input/pages/index.md | 2 +- input/resources/Bundle-example1.json | 2 +- input/resources/Bundle-example2.json | 6 +- input/resources/Bundle-example3.json | 2 +- input/resources/Bundle-example4.json | 4 +- ...n => CodeSystem-user-access-category.json} | 10 +-- ...ionGuide-hl7.fhir.uv.smart-app-launch.json | 48 ++++++------ input/resources/Organization-example.json | 2 +- ...uctureDefinition-patient-access-brand.json | 28 +++---- ...Definition-user-access-brands-bundle.json} | 30 +++---- ...ctureDefinition-user-access-endpoint.json} | 18 ++--- .../ValueSet-patient-access-category.json | 18 ----- .../ValueSet-user-access-category.json | 18 +++++ 19 files changed, 145 insertions(+), 145 deletions(-) rename input/resources/{CodeSystem-patient-access-category.json => CodeSystem-user-access-category.json} (70%) rename input/resources/{StructureDefinition-patient-access-brands-bundle.json => StructureDefinition-user-access-brands-bundle.json} (65%) rename input/resources/{StructureDefinition-patient-access-endpoint.json => StructureDefinition-user-access-endpoint.json} (67%) delete mode 100644 input/resources/ValueSet-patient-access-category.json create mode 100644 input/resources/ValueSet-user-access-category.json diff --git a/input/includes/fsh-link-references.md b/input/includes/fsh-link-references.md index e3af1049..f20f5d8e 100644 --- a/input/includes/fsh-link-references.md +++ b/input/includes/fsh-link-references.md @@ -1,8 +1,8 @@ -[PatientAccessBrandsBundle]: StructureDefinition-patient-access-brands-bundle.html -[PatientAccessBrand]: StructureDefinition-patient-access-brand.html -[PatientAccessEndpoint]: StructureDefinition-patient-access-endpoint.html -[PatientAccessCategoryCodeSystem]: CodeSystem-patient-access-category.html -[PatientAccessCategoryValueSet]: ValueSet-patient-access-category.html +[UserAccessBrandsBundle]: StructureDefinition-user-access-brands-bundle.html +[UserAccessBrand]: StructureDefinition-user-access-brand.html +[UserAccessEndpoint]: StructureDefinition-user-access-endpoint.html +[UserAccessCategoryCodeSystem]: CodeSystem-user-access-category.html +[UserAccessCategoryValueSet]: ValueSet-user-access-category.html [example1]: Bundle-example1.html [example2]: Bundle-example2.html [example3]: Bundle-example3.html diff --git a/input/includes/menu.xml b/input/includes/menu.xml index 4e3fc112..7fd9691c 100644 --- a/input/includes/menu.xml +++ b/input/includes/menu.xml @@ -78,10 +78,10 @@
  • diff --git a/input/includes/note-to-balloters.md b/input/includes/note-to-balloters.md index dec73515..b6b63037 100644 --- a/input/includes/note-to-balloters.md +++ b/input/includes/note-to-balloters.md @@ -3,7 +3,7 @@ In this ballot: -* We have added support for [Patient Access Brands](./brands.html) +* We have added support for [User Access Brands](./brands.html) * We have enhanced support for launch context, adding the ability to * Supply launch context by [canonical URL or Identifier](./scopes-and-launch-context.html#fhir-context), in addition to Relative URL * Request launch context [with a specific role](scopes-and-launch-context.html#standalone-apps) diff --git a/input/pages/brands.md b/input/pages/brands.md index acc837ea..96f7c1ad 100644 --- a/input/pages/brands.md +++ b/input/pages/brands.md @@ -1,16 +1,16 @@ ### Introduction -The specification defines FHIR profiles for [Endpoint]({{site.data.fhir.path}}endpoint.html), [Organization]({{site.data.fhir.path}}organization.html), and [Bundle]({{site.data.fhir.path}}bundle.html) resources that make it easier for patient-facing apps to connect to health data providers. It outlines the process for API providers to publish Brands associated with their FHIR Endpoints, and for apps to collect and present these Brands to users. Each Brand includes essential information such as the organization's name, logo, and patient access details, which apps can display in their user interface. +The specification defines FHIR profiles for [Endpoint]({{site.data.fhir.path}}endpoint.html), [Organization]({{site.data.fhir.path}}organization.html), and [Bundle]({{site.data.fhir.path}}bundle.html) resources that make it easier for user-facing apps to connect to health data providers. It outlines the process for API providers to publish Brands associated with their FHIR Endpoints, and for apps to collect and present these Brands to users. Each Brand includes essential information such as the organization's name, logo, and user access details, which apps can display in their user interface. -EHR systems, healthcare providers, and app developers can ensure a consistent and recognizable user experience when connecting patients to their health records across various platforms and services by following this specification. +EHR systems, healthcare providers, and app developers can ensure a consistent and recognizable user experience when connecting users to their health records across various platforms and services by following this specification. -The [Patient-Access Brand Examples](example-brands.html) illustrate how providers can represent diverse scenarios. +The [User-Access Brand Examples](example-brands.html) illustrate how providers can represent diverse scenarios. ### Brands and Endpoints -This specification supports a model User Experience (UX) where apps display a collection of cards or tiles, each representing a "Patient-access Brand" that patients can recognize and connect to. App developers are not expected to follow this model UX precisely; the model exists to keep the design grounded and establish a shared vocabulary. +This specification supports a model User Experience (UX) where apps display a collection of cards or tiles, each representing a "SMART-access Brand" that users can recognize and connect to. App developers are not expected to follow this model UX precisely; the model exists to keep the design grounded and establish a shared vocabulary. -In this model, a healthcare **provider, payer, or other organization** exposing a FHIR patient access API can **decide which brands to publish** in association with their FHIR endpoints. Each Brand includes data describing the organization (e.g., organization name and logo that a patient would recognize) together with details about their patient access portals (e.g., name, logo, and description in terms that patients would recognize) as well as the API endpoints associated with these portals. +In this model, a healthcare **provider, payer, or other organization** exposing a user-facing FHIR API can **decide which brands to publish** in association with their FHIR endpoints. Each Brand includes data describing the organization (e.g., organization name and logo that a user would recognize) together with details about their user access portals (e.g., name, logo, and description in terms that users would recognize) as well as the API endpoints associated with these portals. In this model, an **app** can: @@ -20,8 +20,8 @@ In this model, an **app** can: * Guide useres to **connect** to FHIR endpoints for the selected portals ### Design goals -- Providers can publish Brand details (name, logo, etc.) that patients will recognize -- Brands can be associated with one or more patient access portals +- Providers can publish Brand details (name, logo, etc.) that users will recognize +- Brands can be associated with one or more user access portals - Portals can be associated with one or more FHIR endpoints - Apps display Brands to create a “connect to my health records” UX - All details can be published in aggregate (e.g., by EHR vendor, by region, or globally) @@ -37,38 +37,38 @@ Each Brand includes the following information intended to support an app-based c | Field | Description | Cardinality | | --- | --- | --- | | Name|Primary name for the organization to display on a card, e.g., "General Hospital" | 1..1 | -| Consumer-facing website for this Brand | note this is distinct from a patient portal, described under "Patient Access Details" below | 1..1 | +| Consumer-facing website for this Brand | note this is distinct from an access portal, described under "Access Details" below | 1..1 | | Logo |to be displayed on a card, and link to logo use terms/agreements | 0..1 | | Aliases | e.g., former names like "General Health Associates" for filtering/search | 0..* | | Identifiers | supporting cross-publisher references or links to external data sets such as the NPI Registry. | 0..* | | Locations | zip codes and street addresses associated with the Brand | 0..* | | Categories | clinical, insurance, laboratory, imaging, pharmacy, network, aggregator --- for filtering/search | 0..* | -| Portal Details | describes a portal this Brand offers to patients **See the table below**.| 0..* | +| Portal Details | describes a portal this Brand offers to users **See the table below**.| 0..* | {:.grid} #### Portal Details -The details of the Patient Access Brand communicated to the patient. +The details of the User Access Brand communicated to the user. | Field | Description | Cardinality | | --- | --- | --- | | Portal name | e.g., "Patient Gateway" or "MyChildrens Portal" | 0..1 | | Portal logo | to be displayed on a card for Brands that have a portal logo in addition to their brand logo | 0..1 | -| Portal URL | where patients can manage accounts with this provider. | 0..1 | -| Patient-facing description | explaining the subset of patients eligible to connect, or the data available in a patient-friendly language | 0..1 | +| Portal URL | where users can manage accounts with this provider. | 0..1 | +| User-facing description | explaining the subset of users eligible to connect, or the data available in a user-friendly language | 0..1 | | API Endpoints| FHIR API Endpoints associated with the portal | 0..* | {:.grid} #### Relationships Among Brands, Portals, and Endpoints -Commonly, a single Brand is typically associated with a single patient Portal that offers a single FHIR Endpoint. But all of the following cases are supported by this conceptual model: +Commonly, a single Brand is typically associated with a single Portal that offers a single FHIR Endpoint. But all of the following cases are supported by this conceptual model: * *One Brand is associated with one Portal* - * e.g., a primary care practice with a single EHR providing patient access + * e.g., a primary care practice with a single EHR providing user access * *One Brand is associated with multiple Portals* - * e.g., a hospital may offer more than one patient portal for legacy purposes - * e.g., a tertiary cancer center may offer one patient portal for adults and another for pediatric patients - * Because Brand information may be published in multiple places, Organizations include the same `identifier` to facilitate matching, merging, and de-duplication. Apps can merge Brands into a single target Brand's card by displaying the target Brand's title and logo. Within the Brand's card, the app displays a distinct "connect" button for each set of Patient Access Details. + * e.g., a hospital may offer more than one portal for legacy purposes + * e.g., a tertiary cancer center may offer one portal for adults and another for pediatric patients + * Because Brand information may be published in multiple places, Organizations include the same `identifier` to facilitate matching, merging, and de-duplication. Apps can merge Brands into a single target Brand's card by displaying the target Brand's title and logo. Within the Brand's card, the app displays a distinct "connect" button for each set of Portal Details. * *One Portal is associated with one Endpoint* * e.g., an EHR-based portal that provides access to patient data through a single FHIR R4 endpoint * *One Portal is associated with multiple FHIR Endpoints* @@ -79,7 +79,7 @@ Commonly, a single Brand is typically associated with a single patient Portal th ### FHIR Profiles -An app assembles its collection of Brands (typically as an offline, configuration-time process) by gathering FHIR `PatientAccessEndpoint` (Endpoints) and `PatientAccessBrand` (Organizations) resources from: +An app assembles its collection of Brands (typically as an offline, configuration-time process) by gathering FHIR `UserAccessEndpoint` (Endpoints) and `UserAccessBrand` (Organizations) resources from: * Vendor-consolidated Brand Bundles that are openly published (e.g., in the context of a national EHR Certification program) * Brand Bundles linked from `.well-known/smart-configuration` for known endpoints @@ -95,19 +95,19 @@ This annotated example illustrates how a Brand is represented as a FHIR Organiza // A Brand is represented as a FHIR Organization "resourceType" : "Organization", "id" : "good-health", - // The primary name by which patients recognize this brand + // The primary name by which users recognize this brand "name" : "Good Health", - // Additional names or former names that patients may recognize + // Additional names or former names that users may recognize "alias" : ["Goodie Bag Health"], // Any valid status is allowed, but publishers should consider filtering // their published list to only include active brands. "active" : true, // This guide provides a vocabulary for loosely categorizing the type of - // data available at patient access API endpoints. Multiple categories + // data available at user access API endpoints. Multiple categories // can be included here. "type" : [{ "coding" : [{ - "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "code" : "clinical", "display" : "Clinical" }] @@ -140,13 +140,13 @@ This annotated example illustrates how a Brand is represented as a FHIR Organiza // more than one portal is associated with this brand. "url" : "http://hl7.org/fhir/StructureDefinition/organization-portal", "extension" : [{ - // (0..1) Name of the portal as shown to patients + // (0..1) Name of the portal as shown to users "url" : "portalName", "valueString" : "GoodHealthCentral" }, { // (0..1) Describes the portal and its intended audience. May be used to help - // patients select the right portal if multiple options are available. + // users select the right portal if multiple options are available. "url" : "portalDescription", "valueMarkdown" : "GoodHealthCentral is available for our primary care patients." }, @@ -192,7 +192,7 @@ This annotated example illustrates how a Brand is represented as a FHIR Organiza "value" : "https://examplelabs.org" }], // telecom with value conveying the primary public website for the Brand. - // Note this is distinct from the patient access portal website. + // Note this is distinct from the user access portal website. "telecom" : [{ "system" : "url", "value" : "https://brand.example.com" @@ -214,7 +214,7 @@ This annotated example illustrates how a Brand is represented as a FHIR Organiza } ``` -[Formal Profile](StructureDefinition-patient-access-brand.html) +[Formal Profile](StructureDefinition-user-access-brand.html) #### Endpoint Profile @@ -224,14 +224,14 @@ This annotated example illustrates how an Endpoint is represented. { "resourceType": "Endpoint", "id": "goodhealth-r4", - // FHIR Base URL for the Patient Access Endpoint + // FHIR Base URL for the User Access Endpoint "address": "https://fhir.goodhealth.example.org/r4", // Any valid status is allowed, but publishers should consider filtering // their published list to only include active endpoints. "status": "active", - // Name for the Patient Access Endpoint. This value may contain + // Name for the User Access Endpoint. This value may contain // technical details like FHIR API Version designations, so apps should prefer - // displaying the `Organization.name` from an associated PatientAccessBrand, + // displaying the `Organization.name` from an associated UserAccessBrand, // rather than displaying this value to users. "name": "FHIR R4 Endpoint for GoodHealth", // Fixed value indicating FHIR API Endpoint @@ -241,7 +241,7 @@ This annotated example illustrates how an Endpoint is represented. }, "extension": [ { - // (1..*) The Patient Access Endpoint's FHIR Version. This Extension + // (1..*) The User Access Endpoint's FHIR Version. This Extension // is a denormalization to help clients focus on supported endpoints. "url": "http://hl7.org/fhir/StructureDefinition/endpoint-fhir-version", "valueCode": "4.0.1" @@ -271,11 +271,11 @@ This annotated example illustrates how an Endpoint is represented. ``` -[Formal Profile](StructureDefinition-patient-access-endpoint.html) +[Formal Profile](StructureDefinition-user-access-endpoint.html) #### Brand Bundle Profile -{{site.data.structuredefinitions.patient-access-brands-bundle.description}} +{{site.data.structuredefinitions.user-access-brands-bundle.description}} ```js { @@ -290,13 +290,13 @@ This annotated example illustrates how an Endpoint is represented. } ``` -[Formal Profile](StructureDefinition-patient-access-brands-bundle.html) +[Formal Profile](StructureDefinition-user-access-brands-bundle.html) ##### Brand Bundle Examples Brands and Endpoints are compiled together and published in a Brand Bundle. -The [Patient-Access Brand Examples](example-brands.html) illustrate how providers can represent diverse scenarios including: +The [User-Access Brand Examples](example-brands.html) illustrate how providers can represent diverse scenarios including: * National laboratory with many locations * Regional health system with independently branded affiliated practices that share a patient portal @@ -323,8 +323,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: -* `patientAccessBrandBundle` URL of a Brand Bundle. The Bundle entries include any Brand and "peer endpoints" associated with this FHIR endpoint. -* `patientAccessBrandIdentifier`: 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`. +* `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`. The Brand Bundle SHALL include exactly one Brand with an `Organization.identifier` that matches the primary Brand identifier from SMART configuration JSON. @@ -335,8 +335,8 @@ 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 - "patientAccessBrandBundle": "https://example.org/brands.json", - "patientAccessBrandIdentifier": { + "userAccessBrandBundle": "https://example.org/brands.json", + "userAccessBrandIdentifier": { "system": "urn:ietf:rfc:3986", "value": "https://example.org" }, @@ -344,7 +344,7 @@ The Brand Bundle SHOULD include only the Brands and Endpoints associated with th } ``` -Dereferencing the `patientAccessBrandBundle` URL above would return a Brand Bundle. +Dereferencing the `userAccessBrandBundle` URL above would return a Brand Bundle. ##### Must-Support Definition (`MS`) and Data Absent Reasons diff --git a/input/pages/conformance.md b/input/pages/conformance.md index 0d001f4a..478bc0a6 100644 --- a/input/pages/conformance.md +++ b/input/pages/conformance.md @@ -177,8 +177,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. - `smart_app_state_endpoint`: **CONDITIONAL**, URL to the EHR's app state endpoint. SHALL be present when the EHR supports the `smart-app-state` capability and the endpoint is distinct from the EHR's primary endpoint. -- `patientAccessBrandBundle`: **RECOMMENDED**, URL for a Brand Bundle. See [Patient Access Brands](brands.html). -- `patientAccessBrandIdentifier`: **RECOMMENDED**, Identifier for the primary entry in a Brand Bundle. See [Patient Access Brands](brands.html). +- `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). - `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. diff --git a/input/pages/example-brands.md b/input/pages/example-brands.md index 94667fd7..b7edb46e 100644 --- a/input/pages/example-brands.md +++ b/input/pages/example-brands.md @@ -26,9 +26,9 @@ Nearest location: 1 mile (Madison) The FHIR server's `.well-known/smart-configuration` file would include a link like - "patientAccessBrands": "https://labs.example.com/branding.json" + "userAccessBrands": "https://labs.example.com/branding.json" -And the hosted Patient Access Brands Bundle file would look like: +And the hosted User Access Brands Bundle file would look like: [Raw JSON](Bundle-example1.json) diff --git a/input/pages/index.md b/input/pages/index.md index 2614b1d8..793e807c 100644 --- a/input/pages/index.md +++ b/input/pages/index.md @@ -42,7 +42,7 @@ SMART uses a language of "scopes" to define specific access permissions that can SMART defines a Token Introspection API allowing Resource Servers or software components to understand the scopes, users, patients, and other context associated with access tokens. This pattern allows a looser coupling between Resource Servers and Authorization Servers. -### [Patient-Access Brands](brands.html) +### [User-Access Brands](brands.html) SMART defines a publication format for API providers to make branding information available to patient-facing apps. This helps apps offer a "connect to my records" UX where providers appear with the names, logos, and descriptions they choose. diff --git a/input/resources/Bundle-example1.json b/input/resources/Bundle-example1.json index e023fdb3..822433da 100644 --- a/input/resources/Bundle-example1.json +++ b/input/resources/Bundle-example1.json @@ -55,7 +55,7 @@ { "coding": [ { - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "code": "laboratory", "display": "Laboratory" } diff --git a/input/resources/Bundle-example2.json b/input/resources/Bundle-example2.json index 8ed959e6..cedf478a 100644 --- a/input/resources/Bundle-example2.json +++ b/input/resources/Bundle-example2.json @@ -63,7 +63,7 @@ "coding": [ { "code": "clinical", - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "display": "Clinical" } ] @@ -160,7 +160,7 @@ "coding": [ { "code": "clinical", - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "display": "Clinical" } ] @@ -215,7 +215,7 @@ "coding": [ { "code": "clinical", - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "display": "Clinical" } ] diff --git a/input/resources/Bundle-example3.json b/input/resources/Bundle-example3.json index 3ab4efef..5c7e859f 100644 --- a/input/resources/Bundle-example3.json +++ b/input/resources/Bundle-example3.json @@ -80,7 +80,7 @@ "coding": [ { "code": "clinical", - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "display": "Clinical" } ] diff --git a/input/resources/Bundle-example4.json b/input/resources/Bundle-example4.json index 34868b45..1a75b494 100644 --- a/input/resources/Bundle-example4.json +++ b/input/resources/Bundle-example4.json @@ -51,7 +51,7 @@ { "coding": [ { - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "code": "insurance", "display": "Insurance" } @@ -129,7 +129,7 @@ { "coding": [ { - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "code": "insurance", "display": "Insurance" } diff --git a/input/resources/CodeSystem-patient-access-category.json b/input/resources/CodeSystem-user-access-category.json similarity index 70% rename from input/resources/CodeSystem-patient-access-category.json rename to input/resources/CodeSystem-user-access-category.json index 20d9d584..0599c76c 100644 --- a/input/resources/CodeSystem-patient-access-category.json +++ b/input/resources/CodeSystem-user-access-category.json @@ -2,11 +2,11 @@ "resourceType": "CodeSystem", "status": "active", "content": "complete", - "name": "PatientAccessCategoryCodeSystem", - "id": "patient-access-category", - "title": "Patient Access Category Code System", - "description": "Categorizes a PatientAccessBrand into high-level taxonomy", - "url": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "name": "UserAccessCategoryCodeSystem", + "id": "user-access-category", + "title": "User Access Category Code System", + "description": "Categorizes a UserAccessBrand into high-level taxonomy", + "url": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "concept": [ { "code": "clinical", diff --git a/input/resources/ImplementationGuide-hl7.fhir.uv.smart-app-launch.json b/input/resources/ImplementationGuide-hl7.fhir.uv.smart-app-launch.json index e79cc953..8c956a1c 100644 --- a/input/resources/ImplementationGuide-hl7.fhir.uv.smart-app-launch.json +++ b/input/resources/ImplementationGuide-hl7.fhir.uv.smart-app-launch.json @@ -52,13 +52,13 @@ "grouping": [ { "id": "PABProfiles", - "name": "Patient Access Brands", - "description": "Helping patients find and connect to the right API endpoints, by enabling publication of branding information for API providers, portals, and endpoints.\n\nFor an overview, see [Patient Access Brands](brands.html)." + "name": "User Access Brands", + "description": "Helping patients find and connect to the right API endpoints, by enabling publication of branding information for API providers, portals, and endpoints.\n\nFor an overview, see [User Access Brands](brands.html)." }, { "id": "PAB", - "name": "Patient Access Brand Examples", - "description": "The following examples demonstrate use of Patient Access Brands. See [example-brands](./example-brands.html) for a guided tour." + "name": "User Access Brand Examples", + "description": "The following examples demonstrate use of User Access Brands. See [example-brands](./example-brands.html) for a guided tour." }, { "id": "SMARTAppState", @@ -74,44 +74,44 @@ "resource": [ { "reference": { - "reference": "StructureDefinition/patient-access-brands-bundle" + "reference": "StructureDefinition/user-access-brands-bundle" }, - "name": "Patient Access Brands Bundle Profile", + "name": "User Access Brands Bundle Profile", "description": "FHIR Bundle of Organizations and Endpoints that is hosted at a stable, publicly available location", "exampleBoolean": false, "groupingId": "PABProfiles" }, { "reference": { - "reference": "StructureDefinition/patient-access-brand" + "reference": "StructureDefinition/user-access-brand" }, - "name": "Patient Access Brand (Organization) Profile", - "description": "Profile on Organization to convey a Patient Access Brand", + "name": "User Access Brand (Organization) Profile", + "description": "Profile on Organization to convey a User Access Brand", "exampleBoolean": false, "groupingId": "PABProfiles" }, { "reference": { - "reference": "StructureDefinition/patient-access-endpoint" + "reference": "StructureDefinition/user-access-endpoint" }, - "name": "Patient Access Endpoint Profile", - "description": "Profile on Endpoint associated with a Patient Access Brand", + "name": "User Access Endpoint Profile", + "description": "Profile on Endpoint associated with a User Access Brand", "exampleBoolean": false, "groupingId": "PABProfiles" }, { "reference": { - "reference": "CodeSystem/patient-access-category" + "reference": "CodeSystem/user-access-category" }, - "name": "Patient Access Category Code System", + "name": "User Access Category Code System", "exampleBoolean": false, "groupingId": "PABProfiles" }, { "reference": { - "reference": "ValueSet/patient-access-category" + "reference": "ValueSet/user-access-category" }, - "name": "Patient Access Category Value Set", + "name": "User Access Category Value Set", "exampleBoolean": false, "groupingId": "PABProfiles" }, @@ -120,7 +120,7 @@ "reference": "Bundle/example1" }, "name": "Lab with Locations Nationwide", - "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle", + "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brands-bundle", "groupingId": "PAB" }, { @@ -128,7 +128,7 @@ "reference": "Bundle/example2" }, "name": "Regional Health System With Independently Branded Affiliates", - "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle", + "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brands-bundle", "groupingId": "PAB" }, { @@ -136,7 +136,7 @@ "reference": "Bundle/example3" }, "name": "Different EHRs for different sub-populations displayed in a unified card", - "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle", + "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brands-bundle", "groupingId": "PAB" }, { @@ -144,7 +144,7 @@ "reference": "Bundle/example4" }, "name": "Two co-equal brands", - "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle", + "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brands-bundle", "groupingId": "PAB" }, { @@ -152,7 +152,7 @@ "reference": "Organization/example" }, "name": "Example Brand", - "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand", + "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand", "groupingId": "PAB" }, { @@ -160,7 +160,7 @@ "reference": "Endpoint/example" }, "name": "Example Endpoint", - "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint", + "exampleCanonical": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint", "groupingId": "PAB" }, { @@ -324,12 +324,12 @@ }, { "nameUrl": "brands.html", - "title": "Patient-Access Brands and Endpoints", + "title": "User-access Brands and Endpoints", "generation": "markdown", "page": [ { "nameUrl": "example-brands.html", - "title": "Patient-Access Brand Examples", + "title": "User-access Brand Examples", "generation": "markdown" } ] diff --git a/input/resources/Organization-example.json b/input/resources/Organization-example.json index d55bf1b8..05c5c792 100644 --- a/input/resources/Organization-example.json +++ b/input/resources/Organization-example.json @@ -48,7 +48,7 @@ "coding": [ { "code": "clinical", - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category", + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category", "display": "Clinical" } ] diff --git a/input/resources/StructureDefinition-patient-access-brand.json b/input/resources/StructureDefinition-patient-access-brand.json index a6565b0d..9235c786 100644 --- a/input/resources/StructureDefinition-patient-access-brand.json +++ b/input/resources/StructureDefinition-patient-access-brand.json @@ -1,12 +1,12 @@ { "resourceType": "StructureDefinition", - "id": "patient-access-brand", - "url": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand", - "name": "PatientAccessBrand", - "title": "Patient Access Brand (Organization) Profile", + "id": "user-access-brand", + "url": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand", + "name": "UserAccessBrand", + "title": "User Access Brand (Organization) Profile", "status": "active", "date": "2023-03-05", - "description": "Profile on Organization to convey a Patient Access Brand.\n\nFor background and context, see **[Patient Access Brands Overview](brands.html#brand-profile-organization)**.\n\nIn addition to the core data elements on Organization, two key extensions are used in this profile:\n\n* conveys the organization's logo(s) and other top-level branding details. See definitions for details.\n* conveys the details of a patient portal and its associated FHIR endpoints. See definitions for details.\n\n Notes:\n* `0..1 MS` `partOf` Conveys that an affiliate Brand response for providing this Brand's patient access. The hierarchy of \"access provided by\" links SHALL NOT exceed a depth of two (i.e., a Brand either includes portal details or links directly to a Brand that provides them).\n\n* `0..* MS` `identifier` Conveys identifiers that apps can use to link this Brand across publishers or with external data sets. EHRs SHALL support customer-supplied identifiers (`system` and `value`).\n\n * It is RECOMMENDED that each Brand include an identifier where `system` is `urn:ietf:rfc: 3986` (meaning the identifier is a URL) and `value` is the HTTPS URL for the Brand's primary web presence, omitting any \"www.\" prefix from the domain and omitting any path component. For example, since the main web presence of Boston Children's Hospital is https://www.childrenshospital.org/, a recommended identifier would be: `{\"system\": \"urn:ietf:rfc:3986\",\"value\": \"https://childrenshospital.org\"}`", + "description": "Profile on Organization to convey a User Access Brand.\n\nFor background and context, see **[User Access Brands Overview](brands.html#brand-profile-organization)**.\n\nIn addition to the core data elements on Organization, two key extensions are used in this profile:\n\n* conveys the organization's logo(s) and other top-level branding details. See definitions for details.\n* conveys the details of a user portal and its associated FHIR endpoints. See definitions for details.\n\n Notes:\n* `0..1 MS` `partOf` Conveys that an affiliate Brand response for providing this Brand's user access. The hierarchy of \"access provided by\" links SHALL NOT exceed a depth of two (i.e., a Brand either includes portal details or links directly to a Brand that provides them).\n\n* `0..* MS` `identifier` Conveys identifiers that apps can use to link this Brand across publishers or with external data sets. EHRs SHALL support customer-supplied identifiers (`system` and `value`).\n\n * It is RECOMMENDED that each Brand include an identifier where `system` is `urn:ietf:rfc: 3986` (meaning the identifier is a URL) and `value` is the HTTPS URL for the Brand's primary web presence, omitting any \"www.\" prefix from the domain and omitting any path component. For example, since the main web presence of Boston Children's Hospital is https://www.childrenshospital.org/, a recommended identifier would be: `{\"system\": \"urn:ietf:rfc:3986\",\"value\": \"https://childrenshospital.org\"}`", "fhirVersion": "4.0.1", "mapping": [ { @@ -40,7 +40,7 @@ { "id": "Organization", "path": "Organization", - "short": "Patient Access Brand", + "short": "User Access Brand", "definition": "A brand of a healthcare provider, such as a hospital, clinic, or practice" }, { @@ -116,12 +116,12 @@ "id" : "Organization.type:pab", "path" : "Organization.type", "sliceName" : "pab", - "short" : "Categories of patient access offered", + "short" : "Categories of user access offered", "mustSupport" : true, "min" : 0, "binding" : { "strength" : "required", - "valueSet" : "http://hl7.org/fhir/smart-app-launch/ValueSet/patient-access-category" + "valueSet" : "http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category" } }, { @@ -143,7 +143,7 @@ "id": "Organization.telecom", "path": "Organization.telecom", "short": "The primary public website for the Brand.", - "definition": "`telecom` with `system` of `url` and `value` conveying the primary public website for the Brand. Note this is distinct from the patient access portal website.", + "definition": "`telecom` with `system` of `url` and `value` conveying the primary public website for the Brand. Note this is distinct from the user access portal website.", "min": 1, "max": "1", "mustSupport": true @@ -159,19 +159,19 @@ "id": "Organization.partOf", "path": "Organization.partOf", "short": "Affiliated \"parent brand\", if this Brand is part of a larger health system", - "definition": "Affiliated \"parent brand\", if this Brand is part of a larger health system. \"Patient access provided by\", to convey that an affiliated Brand hosts this Brand's API technology and patient portal. The hierarchy of \"access provided by\" links SHALL NOT exceed a depth of two (i.e., a Brand either includes portal details or links directly to a Brand that provides them).", + "definition": "Affiliated \"parent brand\", if this Brand is part of a larger health system. \"User access provided by\", to convey that an affiliated Brand hosts this Brand's API technology and user portal. The hierarchy of \"access provided by\" links SHALL NOT exceed a depth of two (i.e., a Brand either includes portal details or links directly to a Brand that provides them).", "mustSupport": true }, { "id": "Organization.endpoint", "path": "Organization.endpoint", "short": "Endpoint associated with this brand", - "definition": "References one or more `PatientAccessEndpoints`. Endpoints here will also be listed within the `organization-portal` extension, to indicate the specific portal they're associated with.", + "definition": "References one or more `UserAccessEndpoints`. Endpoints here will also be listed within the `organization-portal` extension, to indicate the specific portal they're associated with.", "type": [ { "code": "Reference", "targetProfile": [ - "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint" + "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint" ], "aggregation": [ "bundled" @@ -183,8 +183,8 @@ { "id": "Organization.endpoint.reference", "path": "Organization.endpoint.reference", - "short": "Relative URL to an Endpoint within the Patient Access Brands Bundle", - "definition": "Relative URL to an Endpoint within the Patient Access Brands Bundle", + "short": "Relative URL to an Endpoint within the User Access Brands Bundle", + "definition": "Relative URL to an Endpoint within the User Access Brands Bundle", "mustSupport": true } ] diff --git a/input/resources/StructureDefinition-patient-access-brands-bundle.json b/input/resources/StructureDefinition-user-access-brands-bundle.json similarity index 65% rename from input/resources/StructureDefinition-patient-access-brands-bundle.json rename to input/resources/StructureDefinition-user-access-brands-bundle.json index 242e50bb..de72cd41 100644 --- a/input/resources/StructureDefinition-patient-access-brands-bundle.json +++ b/input/resources/StructureDefinition-user-access-brands-bundle.json @@ -1,12 +1,12 @@ { "resourceType": "StructureDefinition", - "id": "patient-access-brands-bundle", - "url": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle", - "name": "PatientAccessBrandsBundle", - "title": "Patient Access Brands Bundle Profile", + "id": "user-access-brands-bundle", + "url": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brands-bundle", + "name": "UserAccessBrandsBundle", + "title": "User Access Brands Bundle Profile", "status": "active", "date": "2023-03-19", - "description": "JSON FHIR Bundle (type: `collection`) of Organizations and Endpoints that is hosted at a stable, publicly available, publicly disclosed location. \n\nFor background and context, see **[Patient Access Brands Overview](brands.html#brand-bundle-profile)**.\n\nBundle Entries include:\n* [Patient Access Endpoint Profile](StructureDefinition-patient-access-endpoint.html) resources.\n* [Patient Access Brand (Organization)](StructureDefinition-patient-access-brand.html) resources. Vendors SHALL publish at least a \"primary brand\" for each endpoint and SHOULD support the publication of a more detailed Brand hierarchy.\n\nBrand Bundles SHALL populate `Bundle.timestamp` to advertise the timestamp of the last change to the contents. In addition, Brand Bundles SHOULD populate `Bundle.entry.resource.meta.lastUpdated` with a more detailed timestamp if the system tracks updates per Resource.", + "description": "JSON FHIR Bundle (type: `collection`) of Organizations and Endpoints that is hosted at a stable, publicly available, publicly disclosed location. \n\nFor background and context, see **[User Access Brands Overview](brands.html#brand-bundle-profile)**.\n\nBundle Entries include:\n* [User Access Endpoint Profile](StructureDefinition-user-access-endpoint.html) resources.\n* [User Access Brand (Organization)](StructureDefinition-user-access-brand.html) resources. Vendors SHALL publish at least a \"primary brand\" for each endpoint and SHOULD support the publication of a more detailed Brand hierarchy.\n\nBrand Bundles SHALL populate `Bundle.timestamp` to advertise the timestamp of the last change to the contents. In addition, Brand Bundles SHOULD populate `Bundle.entry.resource.meta.lastUpdated` with a more detailed timestamp if the system tracks updates per Resource.", "fhirVersion": "4.0.1", "mapping": [ { @@ -40,8 +40,8 @@ { "id": "Bundle", "path": "Bundle", - "short": "Patient Access Brands Bundle", - "definition": "FHIR Bundle (type: collection) of Endpoints and related resources hosted at a stable, publicly available, publicly disclosed location Endpoint associated with a Patient Access Brand (Organization)" + "short": "User Access Brands Bundle", + "definition": "FHIR Bundle (type: collection) of Endpoints and related resources hosted at a stable, publicly available, publicly disclosed location Endpoint associated with a User Access Brand (Organization)" }, { "id": "Bundle.meta", @@ -75,42 +75,42 @@ "mustSupport": true }, { - "id": "Bundle.entry:PatientAccessEndpoint", + "id": "Bundle.entry:UserAccessEndpoint", "path": "Bundle.entry", - "sliceName": "PatientAccessEndpoint", + "sliceName": "UserAccessEndpoint", "min": 0, "max": "*", "mustSupport": true }, { - "id": "Bundle.entry:PatientAccessEndpoint.resource", + "id": "Bundle.entry:UserAccessEndpoint.resource", "path": "Bundle.entry.resource", "type": [ { "code": "Endpoint", "profile": [ - "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint" + "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint" ] } ], "mustSupport": true }, { - "id": "Bundle.entry:PatientAccessBrand", + "id": "Bundle.entry:UserAccessBrand", "path": "Bundle.entry", - "sliceName": "PatientAccessBrand", + "sliceName": "UserAccessBrand", "min": 0, "max": "*", "mustSupport": true }, { - "id": "Bundle.entry:PatientAccessBrand.resource", + "id": "Bundle.entry:UserAccessBrand.resource", "path": "Bundle.entry.resource", "type": [ { "code": "Organization", "profile": [ - "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand" + "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand" ] } ], diff --git a/input/resources/StructureDefinition-patient-access-endpoint.json b/input/resources/StructureDefinition-user-access-endpoint.json similarity index 67% rename from input/resources/StructureDefinition-patient-access-endpoint.json rename to input/resources/StructureDefinition-user-access-endpoint.json index 5a305b31..4b6d9315 100644 --- a/input/resources/StructureDefinition-patient-access-endpoint.json +++ b/input/resources/StructureDefinition-user-access-endpoint.json @@ -1,12 +1,12 @@ { "resourceType": "StructureDefinition", - "id": "patient-access-endpoint", - "url": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint", - "name": "PatientAccessEndpoint", - "title": "Patient Access Endpoint Profile", + "id": "user-access-endpoint", + "url": "http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint", + "name": "UserAccessEndpoint", + "title": "User Access Endpoint Profile", "status": "active", "date": "2023-08-31", - "description": "Profile on Endpoint associated with a Patient Access Brand.\n\nFor background and context, see **[Patient Access Brands Overview](brands.html#endpoint-profile)**.\n\nIn addition to the core data elements on Endpoint, one key extension is used in this profile:\n\n* conveys is a denormalization to help clients focus on supported endpoints. The `valueCode` is any version from http://hl7.org/fhir/valueset-FHIR-version.html (e.g., `4.0.1` is expected for FHIR R4 endpoints).\n\nNotes:\n * `0..1` `name` Conveys a fallback or default name describing the endpoint and the organization offering Patient API access at this endpoint. This value MAY contain technical details like FHIR API Version designations and apps SHOULD preferentially use names from an associated `PatientAccessBrand` rather than displaying this value to users.\n * `1..* MS` `contact` website where developers can configure access to this endpoint, providing at least one `\"system\": \"url\"` contact point where the `value` is an `https://` URL intended for app developers\n * `1..1 MS` `address` FHIR base URL for server supporting patient access", + "description": "Profile on Endpoint associated with a User Access Brand.\n\nFor background and context, see **[User Access Brands Overview](brands.html#endpoint-profile)**.\n\nIn addition to the core data elements on Endpoint, one key extension is used in this profile:\n\n* conveys is a denormalization to help clients focus on supported endpoints. The `valueCode` is any version from http://hl7.org/fhir/valueset-FHIR-version.html (e.g., `4.0.1` is expected for FHIR R4 endpoints).\n\nNotes:\n * `0..1` `name` Conveys a fallback or default name describing the endpoint and the organization offering User API access at this endpoint. This value MAY contain technical details like FHIR API Version designations and apps SHOULD preferentially use names from an associated `UserAccessBrand` rather than displaying this value to users.\n * `1..* MS` `contact` website where developers can configure access to this endpoint, providing at least one `\"system\": \"url\"` contact point where the `value` is an `https://` URL intended for app developers\n * `1..1 MS` `address` FHIR base URL for server supporting user access", "fhirVersion": "4.0.1", "mapping": [ { @@ -30,8 +30,8 @@ { "id": "Endpoint", "path": "Endpoint", - "short": "Patient Access Endpoint", - "definition": "Endpoint associated with a Patient Access Brand (Organization)" + "short": "User Access Endpoint", + "definition": "Endpoint associated with a User Access Brand (Organization)" }, { "id": "Endpoint.extension", @@ -82,7 +82,7 @@ { "id": "Endpoint.name", "path": "Endpoint.name", - "definition": "Fallback or default name describing the endpoint and the organization offering Patient API access at this endpoint. This value MAY contain technical details like FHIR API Version designations, and apps SHOULD preferentially use the name from an associated PatientAccessBrand, rather than displaying this value to users." + "definition": "Fallback or default name describing the endpoint and the organization offering User API access at this endpoint. This value MAY contain technical details like FHIR API Version designations, and apps SHOULD preferentially use the name from an associated UserAccessBrand, rather than displaying this value to users." }, { "id": "Endpoint.contact", @@ -143,7 +143,7 @@ { "id": "Endpoint.address", "path": "Endpoint.address", - "short": "FHIR base URL for servers supporting patient access", + "short": "FHIR base URL for servers supporting user access", "mustSupport": true } ] diff --git a/input/resources/ValueSet-patient-access-category.json b/input/resources/ValueSet-patient-access-category.json deleted file mode 100644 index 8574d602..00000000 --- a/input/resources/ValueSet-patient-access-category.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "resourceType": "ValueSet", - "status": "active", - "name": "PatientAccessCategoryValueSet", - "id": "patient-access-category", - "title": "Patient Access Category Value Set", - "description": "Categorizes a PatientAccessBrand into high-level taxonomy", - "url": "http://hl7.org/fhir/smart-app-launch/ValueSet/patient-access-category", - "experimental": false, - "date": "2023-03-05T22:40:04-08:00", - "compose": { - "include": [ - { - "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category" - } - ] - } -} diff --git a/input/resources/ValueSet-user-access-category.json b/input/resources/ValueSet-user-access-category.json new file mode 100644 index 00000000..ba841354 --- /dev/null +++ b/input/resources/ValueSet-user-access-category.json @@ -0,0 +1,18 @@ +{ + "resourceType": "ValueSet", + "status": "active", + "name": "UserAccessCategoryValueSet", + "id": "user-access-category", + "title": "User Access Category Value Set", + "description": "Categorizes a UserAccessBrand into high-level taxonomy", + "url": "http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category", + "experimental": false, + "date": "2023-03-05T22:40:04-08:00", + "compose": { + "include": [ + { + "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/user-access-category" + } + ] + } +}