Athena Core Implementation Guide
4.5.0 - release
Athena Core Implementation Guide - Local Development build (v4.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir.athena.io/StructureDefinition/ah-brand | Version: 4.5.0 | |||
Active as of 2025-05-09 | 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):
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.
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:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | athenahealth Brand | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-brand" | |
![]() ![]() ![]() |
1..1 | Reference(Organization) | Reference to athenahealth Organization for 'brand' | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | athenahealth Brand | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-brand" | |
![]() ![]() ![]() |
1..1 | Reference(Organization) | Reference to athenahealth Organization for 'brand' | |
![]() |
This structure is derived from Extension
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | athenahealth Brand | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-brand" | |
![]() ![]() ![]() |
1..1 | Reference(Organization) | Reference to athenahealth Organization for 'brand' | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | athenahealth Brand | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-brand" | |
![]() ![]() ![]() |
1..1 | Reference(Organization) | Reference to athenahealth Organization for 'brand' | |
![]() |
Other representations of profile: CSV, Excel, Schematron