Athena Core Implementation Guide
2.33.0 - release

Athena Core Implementation Guide - Local Development build (v2.33.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: athenahealth Brand

Official URL: https://fhir.athena.io/StructureDefinition/ah-brand Version: 2.33.0
Active as of 2024-04-12 Computable Name: AthenaBrand

An Extension used to reference a specific athenahealth brand Organization.

athenahealth provides a multi-tenant SaaS platform on which our customers provide healthcare services to their patients. Tenants are defined as practices within athenahealth. In general, a practice can be a hospital, medical center, clinic, or any other healthcare-related entity. Typically, a practice represents the business entity that provides healthcare services and can be in a single location or spread across multiple locations.

A provider group is an organizational entity representing a set of providers within a practice.

A brand is an organizational grouping of one or more provider groups used to define a consistent patient-facing brand experience for patients interacting with those provider groups. This includes Patient Portal look and feel, automated messaging preferences, etc.

Every brand is identified by a single numeric Brand ID and is associated to a specific practice in athenahealth. It is represented as a FHIR Organization having an Organization.id defined by a-{PID}.Brand-{ID} where {PID} is the Practice ID and {ID} is the Brand ID. This resource-level extension is used to specify the appropriate brand for appropriate athenahealth FHIR resources as a literal reference to a FHIR Organization.

Context of Use

This extension may be used on the following element(s):

  • Element ID Resource

Background

athenahealth provides a multi-tenant SaaS platform on which our customers provide healthcare services to their patients. Tenants are defined as practices within athenahealth. In general, a practice can be a hospital, medical center, clinic, or any other healthcare-related entity. Typically, a practice represents the business entity that provides healthcare services and can be in a single location or spread across multiple locations.

A brand is an organizational grouping of one or more provider groups used to define a consistent patient-facing brand experience for patients interacting with those provider groups. This includes Patient Portal look and feel, automated messaging preferences, etc.

Brand Identity

Every brand is identified by a single numeric Brand ID and is associated to a specific practice in athenahealth. It is represented as a FHIR® Organization having an Organization.id defined by a-{PID}.Brand-{ID} where {PID} is the Practice ID and {ID} is the Brand ID.

This resource-level extension is used to specify the appropriate brand for appropriate athenahealth FHIR resources as a literal reference to an Organization. For example:

{
  "id": "...",
  "extension": [
    {
      "url": "https://fhir.athena.io/StructureDefinition/ah-brand",
      "valueReference": {
        "reference": "Organization/a-1.Brand-1234"
      }
    }
  ],
}

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Simple Extension of type Reference: An Extension used to reference a specific <b>athenahealth</b> <i>brand</i> Organization.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Brand
... extension 0..0
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-brand"
... value[x] 1..1Reference(Organization)Reference to athenahealth Organization for 'brand'

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Brand
... id 0..1stringUnique id for inter-element referencing
... extension 0..0
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-brand"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type Reference: An Extension used to reference a specific <b>athenahealth</b> <i>brand</i> Organization.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Brand
... extension 0..0
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-brand"
... value[x] 1..1Reference(Organization)Reference to athenahealth Organization for 'brand'

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Brand
... id 0..1stringUnique id for inter-element referencing
... extension 0..0
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-brand"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron