Athena Core Implementation Guide
5.10.2 - release
Athena Core Implementation Guide
5.10.2 - release
Athena Core Implementation Guide - Local Development build (v5.10.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.athena.io/StructureDefinition/ah-group | Version: 5.10.2 | |||
| Active as of 2026-05-26 | Computable Name: AthenahealthGroup | |||
| Keywords: Wire Format | ||||
Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized.
This API only supports the Group-level export FHIR Operation (i.e. GET [fhir base]/Group/[id]/$export where [id] is formatted as ‘a-1.c-[practiceId]’) to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in the specified Group. The ‘$export’ operation is invoked using the FHIR Asynchronous Request Pattern. Refer to the FHIR Bulk Data Access (Flat FHIR) Export Implementation Guide for more information.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Group
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 | ||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
  meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
 tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
  extension:ahCreated |
0..1 | dateTime | athenahealth Created URL: https://fhir.athena.io/StructureDefinition/ah-created | |||||
| extension:ahCreatedBy |
0..1 | string | athenahealth Created By URL: https://fhir.athena.io/StructureDefinition/ah-createdby | |||||
| extension:ahLastModified |
0..1 | dateTime | athenahealth Last Modified URL: https://fhir.athena.io/StructureDefinition/ah-lastmodified | |||||
| extension:ahLastModifiedBy |
0..1 | string | athenahealth Last Modified By URL: https://fhir.athena.io/StructureDefinition/ah-lastmodifiedby | |||||
 extension:ahProviderPreferredTimezone |
0..1 | CodeableConcept | athenahealth Provider Preferred Timezone URL: https://fhir.athena.io/StructureDefinition/ah-provider-preferred-timezone Binding: athenahealth Provider Preferred Timezone (required) | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Unique id | ||||
| active |
Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. | ||||
| actual |
ΣC | 1..1 | boolean | Descriptive or actual | ||||
| code |
Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name |
Σ | 0..1 | string | Label for Group | ||||
| quantity |
Σ | 0..1 | unsignedInt | Number of members | ||||
 managingEntity |
Σ | 0..1 | Reference(Organization) | Entity that is the custodian of the Group's definition | ||||
| characteristic |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
 value[x] |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueBoolean |
boolean | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(Any) | |||||||
| exclude |
1..1 | boolean | Group includes or excludes | |||||
| period |
0..1 | Period | Period over which characteristic is tested | |||||
 member |
C | 0..* | BackboneElement | Who or what is in group | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ahMainSchedulingPractitioner |
0..1 | boolean | athenahealth Main Scheduling Practitioner URL: https://fhir.athena.io/StructureDefinition/ah-main-scheduling-practitioner | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| entity |
1..1 | Reference(Patient | Practitioner) | Reference to the group member | |||||
| period |
0..1 | Period | Period member belonged to the group | |||||
| inactive |
0..1 | boolean | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Group.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Group.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | example | Not State | Unknown | |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
This structure is derived from Group
Summary
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Group
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ahCreated |
0..1 | dateTime | athenahealth Created URL: https://fhir.athena.io/StructureDefinition/ah-created | |||||
| extension:ahCreatedBy |
0..1 | string | athenahealth Created By URL: https://fhir.athena.io/StructureDefinition/ah-createdby | |||||
| extension:ahLastModified |
0..1 | dateTime | athenahealth Last Modified URL: https://fhir.athena.io/StructureDefinition/ah-lastmodified | |||||
| extension:ahLastModifiedBy |
0..1 | string | athenahealth Last Modified By URL: https://fhir.athena.io/StructureDefinition/ah-lastmodifiedby | |||||
| extension:ahProviderPreferredTimezone |
0..1 | CodeableConcept | athenahealth Provider Preferred Timezone URL: https://fhir.athena.io/StructureDefinition/ah-provider-preferred-timezone Binding: athenahealth Provider Preferred Timezone (required) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Unique id | ||||
| active |
Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. | ||||
| actual |
ΣC | 1..1 | boolean | Descriptive or actual | ||||
| code |
Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
| name |
Σ | 0..1 | string | Label for Group | ||||
| quantity |
Σ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity |
Σ | 0..1 | Reference(Organization) | Entity that is the custodian of the Group's definition | ||||
| characteristic |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
| value[x] |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueBoolean |
boolean | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(Any) | |||||||
| exclude |
1..1 | boolean | Group includes or excludes | |||||
| period |
0..1 | Period | Period over which characteristic is tested | |||||
| member |
C | 0..* | BackboneElement | Who or what is in group | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ahMainSchedulingPractitioner |
0..1 | boolean | athenahealth Main Scheduling Practitioner URL: https://fhir.athena.io/StructureDefinition/ah-main-scheduling-practitioner | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| entity |
1..1 | Reference(Patient | Practitioner) | Reference to the group member | |||||
| period |
0..1 | Period | Period member belonged to the group | |||||
| inactive |
0..1 | boolean | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Group.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Group.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | example | Not State | Unknown | |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
This structure is derived from Group
Summary
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
