SMART App Launch
2.2.0-preview - CI-Build International flag

SMART App Launch - Local Development build (v2.2.0-preview). See the Directory of published versions

Patient-Access Brand Examples

The brands below are fabricated for the purpose of these examples.

Example 1: Lab with Thousands of Locations Nationwide

  • One national brand
  • Locations in thousands of cities

The configuration below establishes a single top-level Brand with a long list of ExampleHealth addresses. (The organization can also group their locations into sub-brands such as “ExampleLabs Alaska”)

ExampleLabs ExampleLabs (examplelabs.com)

Source API Portal
ExampleLabs Patient™ portal ▢ Connect ▢ View

Nearest location: 1 mile (Madison)

The FHIR server’s .well-known/smart-configuration file would include a link like

"patientAccessBrands": "https://examplelabs.example.com/branding.json"

And the hosted` Patient Access Brands Bundle file would look like:

Raw JSON

{
  "resourceType" : "Bundle",
  "id" : "example1",
  "meta" : {
    "lastUpdated" : "2023-09-05T20:00:43.241454-07:00",
    "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle"]
  },
  "type" : "collection",
  "timestamp" : "2023-09-05T20:00:43.241070-07:00",
  "entry" : [{
    "fullUrl" : "https://examplelabs.example.org/Endpoint/examplelabs",
    "resource" : {
      "resourceType" : "Endpoint",
      "id" : "examplelabs",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/endpoint-fhir-version",
        "valueCode" : "4.0.1"
      }],
      "status" : "active",
      "connectionType" : {
        "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code" : "hl7-fhir-rest"
      },
      "name" : "FHIR R4 Endpoint for ExampleLabs",
      "contact" : [{
        "system" : "url",
        "value" : "https://dev-portal.examplelabs.org"
      }],
      "payloadType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "none"
        }]
      }],
      "address" : "https://fhir.examplelabs.example.org/r4"
    }
  },
  {
    "fullUrl" : "https://examplelabs.example.org/Organization/examplelabs",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "examplelabs",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://example.org/examplelabs/images/ExampleLabs_Logo.svg"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name",
        "valueString" : "ExampleLabs Patient Portal"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url",
        "valueUrl" : "https://example.org/patient.examplelabs.com/landing"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://examplelabs.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "lab",
          "display" : "Laboratory"
        }]
      }],
      "name" : "ExampleLabs",
      "alias" : ["ExampleLabs Alaska"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.examplelabs.com"
      }],
      "address" : [{
        "line" : ["4015 Lake Otis Pkwy"],
        "city" : "Anchorage",
        "state" : "AK",
        "postalCode" : "99508"
      },
      {
        "line" : ["3223 Palmer Wasilla Hwy",
        "Suite 4"],
        "city" : "Wasilla",
        "state" : "AK",
        "postalCode" : "99654"
      },
      {
        "line" : ["1626 30Th Avenue"],
        "city" : "Fairbanks",
        "state" : "AK",
        "postalCode" : "99701"
      }],
      "endpoint" : [{
        "reference" : "Endpoint/examplelabs",
        "display" : "FHIR R4 Endpoint for ExampleLabs Brand"
      }]
    }
  }]
}

Example 2: Regional Health System With Independently Branded Affiliates

  • Regional health system (“ExampleHealth”)
  • Multiple locations in/around 12 cities
  • Provides EHR for many affiliates (distinctly branded sites like “ExampleHealth Physicians of Madison” or “ExampleHealth Community Hospital”)

The system displays the following cards to a user:

ExampleHealth ExampleHealth (examplehealth.org)

Source API Portal
MyExampleHospital ▢ Connect ▢ View

Nearest location: 13 miles (Madison)

ExampleHealth Physicians of Madison ExampleHealth Physicians of Madison (ehpmadison.com)

Source API Portal
MyExampleHospital ▢ Connect ▢ View

Nearest location: 1 mile (Madison)

ExampleHealth Community Hospital ExampleHealth Community Hospital (ehchospital.org)

Source API Portal
MyExampleHospital ▢ Connect ▢ View

Nearest location: 120 miles (Lake City)

(And two more cards for other affiliated brands sharing the MyExampleHospital portal.)

Raw JSON

{
  "resourceType" : "Bundle",
  "id" : "example2",
  "meta" : {
    "lastUpdated" : "2023-09-05T20:18:52.639617-07:00",
    "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle"]
  },
  "type" : "collection",
  "timestamp" : "2023-09-05T20:18:52.638960-07:00",
  "entry" : [{
    "fullUrl" : "https://ehr.example.org/Endpoint/examplehealth-r2",
    "resource" : {
      "resourceType" : "Endpoint",
      "id" : "examplehealth-r2",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/endpoint-fhir-version",
        "valueCode" : "1.0.2"
      }],
      "status" : "active",
      "connectionType" : {
        "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code" : "hl7-fhir-rest"
      },
      "name" : "FHIR DSTU2 Endpoint for ExampleHealth",
      "contact" : [{
        "system" : "url",
        "value" : "https://open.ehr.com"
      }],
      "payloadType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "none"
        }]
      }],
      "address" : "https://ehrfhir.examplehealth.org/ProdFHIR/api/FHIR/R4"
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Endpoint/examplehealth-r4",
    "resource" : {
      "resourceType" : "Endpoint",
      "id" : "examplehealth-r4",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/endpoint-fhir-version",
        "valueCode" : "4.0.1"
      }],
      "status" : "active",
      "connectionType" : {
        "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code" : "hl7-fhir-rest"
      },
      "name" : "FHIR R4 Endpoint for ExampleHealth",
      "contact" : [{
        "system" : "url",
        "value" : "https://open.ehr.com"
      }],
      "payloadType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "none"
        }]
      }],
      "address" : "https://ehrfhir.examplehealth.org/ProdFHIR/api/FHIR/R4"
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/ehchospital",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "ehchospital",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "data:image/svg+xml;base64,PHN2ZyB0aXRsZT0iU3Rld2FydCBNZW1vcmlhbCBIb3Nw...+IDwvc3ZnPgo="
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://ehchospital.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "clinical",
          "display" : "Clinical Care provider"
        }]
      }],
      "name" : "ExampleHealth Community Hospital",
      "alias" : ["GoodHealth Madison"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.ehchospital.com"
      }],
      "address" : [{
        "city" : "Lake City",
        "state" : "IA"
      }],
      "partOf" : {
        "reference" : "Organization/examplehealth"
      }
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/ehpmadison",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "ehpmadison",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://example.org/examplehealth.org/logo/ehp-madison.png"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://ehpmadison.com"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "clinical",
          "display" : "Clinical Care provider"
        }]
      }],
      "name" : "ExampleHealth Physicians Madison",
      "alias" : ["GoodHealth Madison"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.ehpmadison.com"
      }],
      "address" : [{
        "city" : "Madison",
        "state" : "WI"
      }],
      "partOf" : {
        "reference" : "Organization/examplehealth"
      }
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/examplehealth",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "examplehealth",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://example.org/examplehealth/logo/main.1024x102.png"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name",
        "valueString" : "My ExampleHealth Portal"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url",
        "valueUrl" : "https://example.org/chart.myexamplehealth.org"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://examplehealth.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "clinical",
          "display" : "Clinical Care provider"
        }]
      }],
      "name" : "ExampleHealth",
      "alias" : ["GoodHealth Hospital",
      "GoodHealth Mental Health"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.examplehealth.com"
      }],
      "address" : [{
        "city" : "Madison",
        "state" : "WI"
      },
      {
        "city" : "Anamosa",
        "state" : "IA"
      },
      {
        "city" : "Cedar Rapids",
        "state" : "IA"
      },
      {
        "city" : "Des Moines",
        "state" : "IA"
      },
      {
        "city" : "Dubuque",
        "state" : "IA"
      },
      {
        "city" : "Fort Dodge",
        "state" : "IA"
      },
      {
        "city" : "Grinnell",
        "state" : "IA"
      },
      {
        "city" : "Marshalltown",
        "state" : "IA"
      },
      {
        "city" : "Peoria",
        "state" : "IA"
      },
      {
        "city" : "Pekin",
        "state" : "I"
      },
      {
        "city" : "Muscatine",
        "state" : "IA"
      },
      {
        "city" : "Sioux City",
        "state" : "IA"
      }],
      "endpoint" : [{
        "reference" : "Endpoint/examplehealth-r4",
        "display" : "FHIR R4 Endpoint for ExampleHealth Brand"
      },
      {
        "reference" : "Endpoint/examplehealth-r2",
        "display" : "FHIR DSTU2 Endpoint for ExampleHealth Brand"
      }]
    }
  }]
}

Example 3: Different EHRs for different sub-populations displayed in a unified card

(Note: this is not an uncommon pattern. For example see, https://www.tuftsmedicalcenter.org/myTuftsMedicalCenter, https://www.nuvancehealth.org/patients-and-visitors/patient-portals, https://www.ouhealth.com/ou-health-patients-families/patient-portals, or run a search like https://www.google.com/search?q=%22patient+portals%22+%22if+you%22.)

The ExampleHospital’s patient portals below are split by audience:

  • EHR1: “Patient Gateway” for adult patients to help them connect with providers, manage appointments and refill prescriptions.
  • EHR2: “Pediatrics”, a patient portal where parents can access their child’s information.

Based on the definitions below, there would be top-level Brand cards for the two Hospital’s, ExampleHospital1 and ExampleHospital2

ExampleHospital1 ExampleHospital1 (examplehospital1.org)

Source API Portal
Patient Gateway ▢ Connect ▢ View

Nearest location: 3 miles (Boston)

ExampleHospital2 ExampleHospital2 (examplehospital2.org)

Source API Portal
Pediatrics ▢ Connect ▢ View

Nearest location: 3 miles (Boston)

ExampleHospital3’s patient portal is split by “Patient Gateway” and “Pediatrics”.

Without a consistent identifier on both Organizations, ExampleHospital3 would have two cards:

ExampleHospital3 ExampleHospital3 (examplehospital3.org)

Source API Portal
Patient Gateway ▢Connect ▢ View

Nearest location: 3 miles (Boston)

ExampleHospital3 ExampleHospital3 (examplehospital3.org)

Source API Portal
Pediatrics ▢ Connect ▢ View

Nearest location: 3 miles (Boston)

Although displaying 2 cards is correct, it may not reflect the organization’s desired formatting. Since the definitions below include a consistent identifier (system urn:ietf:rfc:3986, value https://examplehospital3.org), the system can combine the two ExampleHospital3 connection choices into a single card at display time. This results in a card more like this:

ExampleHospital3 ExampleHospital3 (examplehospital3.org)

Source API Portal
Patient Gateway ▢ Connect ▢ View
Pediatrics ▢ Connect ▢ View

Nearest location: 3 miles (Boston)

EHR1 content for ExampleHospital1 (with ExampleHospital3 as partOf)

Raw JSON

{
  "resourceType" : "Bundle",
  "id" : "example3",
  "meta" : {
    "lastUpdated" : "2023-09-05T20:23:42.723732-07:00",
    "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle"]
  },
  "type" : "collection",
  "timestamp" : "2023-09-05T20:23:42.723178-07:00",
  "entry" : [{
    "fullUrl" : "https://ehr.example.org/Endpoint/examplehospital1-ehr1",
    "resource" : {
      "resourceType" : "Endpoint",
      "id" : "examplehospital1-ehr1",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/endpoint-fhir-version",
        "valueCode" : "1.0.2"
      }],
      "status" : "active",
      "connectionType" : {
        "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code" : "hl7-fhir-rest"
      },
      "name" : "FHIR DSTU2 Endpoint for ExampleHospital1's EHR1 Patient Gateway",
      "contact" : [{
        "system" : "url",
        "value" : "https://open.ehr.com"
      }],
      "payloadType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "none"
        }]
      }],
      "address" : "https://example.org/EHR1/ExampleHospital1/api/FHIR/DSTU2"
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/examplehospital1-ehr1",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "examplehospital1-ehr1",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://example.org/examplehospital1-ehr1/themes/custom/logo.svg"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name",
        "valueString" : "ExampleHospital1 Patient Gateway"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url",
        "valueUrl" : "https://patientgateway.examplehospital1-ehr1.org"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://examplehospital1.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "clinical",
          "display" : "Clinical Care provider"
        }]
      }],
      "name" : "ExampleHospital1",
      "alias" : ["GoodHealth Healthcare"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.example.org/examplehospital1.org"
      }],
      "address" : [{
        "city" : "Boston",
        "state" : "MA"
      },
      {
        "city" : "Newton",
        "state" : "MA"
      },
      {
        "city" : "Waltham",
        "state" : "MA"
      }],
      "endpoint" : [{
        "reference" : "Endpoint/examplehospital1-ehr1",
        "display" : "FHIR DSTU2 Endpoint for ExampleHospital1's EHR1 Patient Gateway Brand"
      }]
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/examplehospital3-ehr1",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "examplehospital3-ehr1",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://example.org/examplehospital3/ui/images/img-logo-2x-new.webp"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description",
        "valueMarkdown" : "Patient Gateway is an online tool to help adult patients connect with health care providers, manage appointments, and refill prescriptions.\n"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://examplehospital3.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "clinical",
          "display" : "Clinical Care provider"
        }]
      }],
      "name" : "ExampleHospital3",
      "alias" : ["GoodCare Cancer Center"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.example.org/examplehospital3.org"
      }],
      "address" : [{
        "city" : "Boston",
        "state" : "MA"
      }],
      "partOf" : {
        "reference" : "Organization/examplehospital1-ehr1"
      }
    }
  }]
}

EHR2 Content for ExampleHospital2 (with ExampleHospital3 as partOf)

Raw JSON

{
  "resourceType" : "Bundle",
  "id" : "example4",
  "meta" : {
    "lastUpdated" : "2023-09-05T20:31:01.224902-07:00",
    "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle"]
  },
  "type" : "collection",
  "timestamp" : "2023-09-05T20:31:01.224122-07:00",
  "entry" : [{
    "fullUrl" : "https://ehr.example.org/Endpoint/examplehospital2-ehr2",
    "resource" : {
      "resourceType" : "Endpoint",
      "id" : "examplehospital2-ehr2",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/endpoint-fhir-version",
        "valueCode" : "4.0.1"
      }],
      "status" : "active",
      "connectionType" : {
        "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code" : "hl7-fhir-rest"
      },
      "name" : "FHIR R4 EHR2 Endpoint for ExampleHospital2",
      "contact" : [{
        "system" : "url",
        "value" : "https://code.ehr2.com"
      }],
      "payloadType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "none"
        }]
      }],
      "address" : "https://example.org/examplehospital2.ehr2/r4"
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/examplehospital2-ehr2",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "examplehospital2-ehr2",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://www.example.org/hospital2/media/logo.ashx?h=85&w=600&la=en&hash=AF50B39C3F246D61E4C012ED25A2D8CF4C3A1607"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name",
        "valueString" : "ExampleHospital2 Pediatrics Portal"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url",
        "valueUrl" : "https://apps.examplehospital2/pediatrics-portal/index.html"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://examplehospital2"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "clinical",
          "display" : "Clinical Care provider"
        }]
      }],
      "name" : "Example Hospital1",
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.example.org/examplehospital2/"
      }],
      "address" : [{
        "city" : "Boston",
        "state" : "MA"
      }],
      "endpoint" : [{
        "reference" : "Endpoint/examplehospital2-ehr2",
        "display" : "FHIR R4 EHR2 Endpoint for ExampleHospital2 Brand"
      }]
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/examplehospital3-ehr2",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "examplehospital3-ehr2",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url",
        "valueUrl" : "https://patientgateway.examplehospital1-ehr1.org"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description",
        "valueMarkdown" : "Pediatrics Portal is a Web-based, easy-to-use, and secure way to access your child's information at your convenience."
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://examplehospital3.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "clinical",
          "display" : "Clinical Care provider"
        }]
      }],
      "name" : "ExampleHospital3",
      "alias" : ["GoodCare Cancer Center"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.example.org/examplehospital3/"
      }],
      "address" : [{
        "city" : "Boston",
        "state" : "MA"
      }],
      "partOf" : {
        "reference" : "Organization/examplehospital2-ehr2"
      }
    }
  }]
}

Example 4: Two co-equal brands (“Brand1” + “Brand2”)

All three option described below would have two cards:

Brand1 Brand1 (brand1.org)

Source API Portal
Brand1 Portal ▢Connect ▢ View

Nearest location: 1 miles (Napa)

Brand2 Brand2 (brand2.org)

Source API Portal
Brand2 Portal ▢Connect ▢ View

Nearest location: 13 miles (Sonoma)

Option 1: Duplicate the Endpoint

  • two endpoints with the same address
  • Each endpoint points to its primary brand
  • No brand hierarchy

Option 2: Combine both Brands as Affiliated with a Hidden Brand

  • One endpoint with a parent brand
  • Parent brand marked as “hidden”
  • Child brands for Brand1 + Brand2, pointing up to “primary brand”
Brand Bundle for Option 1: Duplicate the Endpoint

Raw JSON

{
  "resourceType" : "Bundle",
  "id" : "example5",
  "meta" : {
    "lastUpdated" : "2023-09-05T20:36:42.269187-07:00",
    "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle"]
  },
  "type" : "collection",
  "timestamp" : "2023-09-05T20:36:42.268403-07:00",
  "entry" : [{
    "fullUrl" : "https://ehr.example.org/Endpoint/brand1-opt2",
    "resource" : {
      "resourceType" : "Endpoint",
      "id" : "brand1-opt2",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/endpoint-fhir-version",
        "valueCode" : "4.0.1"
      }],
      "status" : "active",
      "connectionType" : {
        "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code" : "hl7-fhir-rest"
      },
      "name" : "FHIR R4 Endpoint for Brand1/Brand2",
      "contact" : [{
        "system" : "url",
        "value" : "https://open.ehr.com"
      }],
      "payloadType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "none"
        }]
      }],
      "address" : "https://example.org/brand1.org/ProdFHIR/api/FHIR/R4"
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Endpoint/brand2-opt2",
    "resource" : {
      "resourceType" : "Endpoint",
      "id" : "brand2-opt2",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/endpoint-fhir-version",
        "valueCode" : "4.0.1"
      }],
      "status" : "active",
      "connectionType" : {
        "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code" : "hl7-fhir-rest"
      },
      "name" : "FHIR R4 Endpoint for Brand1/Brand2",
      "contact" : [{
        "system" : "url",
        "value" : "https://open.ehr.com"
      }],
      "payloadType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "none"
        }]
      }],
      "address" : "https://example.org/brand2.org/ProdFHIR/api/FHIR/R4"
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/brand1-opt2",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "brand1-opt2",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://example.org/brand1/logo/main.svg"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name",
        "valueString" : "Brand1 Portal"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url",
        "valueUrl" : "https://example.org/chart.brand1.org"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://brand1.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "insurer",
          "display" : "Health Insurance provider"
        }]
      }],
      "name" : "Brand1",
      "alias" : ["Umbrella Insurance"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.brand1.com"
      }],
      "address" : [{
        "city" : "Napa",
        "state" : "CA"
      },
      {
        "city" : "Sonoma",
        "state" : "CA"
      },
      {
        "city" : "St Helena",
        "state" : "CA"
      }],
      "endpoint" : [{
        "reference" : "Endpoint/brand1-opt2",
        "display" : "FHIR R4 Endpoint for Brand1/Brand2"
      }]
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/brand2-opt2",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "brand2-opt2",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://example.org/brand2/logo/main.svg"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name",
        "valueString" : "Brand2 Portal"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url",
        "valueUrl" : "https://example.org/chart.brand2.org"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://brand2.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "insurer",
          "display" : "Health Insurance provider"
        }]
      }],
      "name" : "Brand2",
      "alias" : ["Shield Insurance"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.brand2.com"
      }],
      "address" : [{
        "city" : "Sonoma",
        "state" : "CA"
      },
      {
        "city" : "San Rafael",
        "state" : "CA"
      },
      {
        "city" : "Santa Rosa",
        "state" : "CA"
      }],
      "endpoint" : [{
        "reference" : "Endpoint/brand2-opt2",
        "display" : "FHIR R4 Endpoint for Brand1/Brand2"
      }]
    }
  }]
}

Example 5: EHR and EHR Customer Hosted Brands Bundles

ExampleHealth uses EHR1, and its endpoint is listed in EHR1’s Brands Bundle. As shown above, ExampleHealth also hosts its own branding bundle (with mores details about every clinic location, specialty, etc.). In EHR1 Brands Bundle, ExampleHealth points to the Patient Access Endpoint within the Bundle and to an external Brand Bundle.

For EHR1 Brands Bundle, the system displays the following card to a user:

ExampleHealth ExampleHealth (examplehealth.org)

Source API Portal
MyExampleHospital ▢ Connect ▢ View

EHR1 Content for ExampleHealth

Raw JSON

{
  "resourceType" : "Bundle",
  "id" : "example6",
  "meta" : {
    "lastUpdated" : "2023-09-05T20:49:08.419567-07:00",
    "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brands-bundle"]
  },
  "type" : "collection",
  "timestamp" : "2023-09-05T20:49:08.418823-07:00",
  "entry" : [{
    "fullUrl" : "https://ehr.example.org/Endpoint/ehr1-examplehealth",
    "resource" : {
      "resourceType" : "Endpoint",
      "id" : "ehr1-examplehealth",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/endpoint-fhir-version",
        "valueCode" : "1.0.2"
      }],
      "status" : "active",
      "connectionType" : {
        "system" : "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
        "code" : "hl7-fhir-rest"
      },
      "name" : "FHIR DSTU2 Endpoint for ExampleHealth's EHR1 Patient Gateway",
      "contact" : [{
        "system" : "url",
        "value" : "https://open.ehr.com"
      }],
      "payloadType" : [{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
          "code" : "none"
        }]
      }],
      "address" : "https://example.org/EHR1/ExampleHealth/api/FHIR/DSTU2"
    }
  },
  {
    "fullUrl" : "https://ehr.example.org/Organization/cust-hosted-examplehealth",
    "resource" : {
      "resourceType" : "Organization",
      "id" : "cust-hosted-examplehealth",
      "meta" : {
        "profile" : ["http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand"]
      },
      "extension" : [{
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo",
        "valueUrl" : "https://example.org/ehr1-examplehealth/themes/custom/logo.svg"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name",
        "valueString" : "EHR1 ExampleHealth Patient Gateway"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url",
        "valueUrl" : "https://patientgateway.ehr1-examplehealth.org"
      },
      {
        "url" : "http://hl7.org/fhir/smart-app-launch/StructureDefinition/brands-bundle",
        "valueUrl" : "https://example.org/examplehealth.org/bundle.json"
      }],
      "identifier" : [{
        "system" : "urn:ietf:rfc:3986",
        "value" : "https://examplehealth.org"
      }],
      "active" : true,
      "type" : [{
        "coding" : [{
          "system" : "http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category",
          "code" : "clinical",
          "display" : "Clinical Care provider"
        }]
      }],
      "name" : "ExampleHealth",
      "alias" : ["GoodHealth Healthcare"],
      "telecom" : [{
        "system" : "url",
        "value" : "https://www.example.org/examplehealth.org"
      }],
      "address" : [{
        "city" : "Madison",
        "state" : "WI"
      }],
      "endpoint" : [{
        "reference" : "Endpoint/ehr1-examplehealth",
        "display" : "FHIR DSTU2 Endpoint for ExampleHealth's EHR1 Patient Gateway"
      }]
    }
  }]
}