Group
Overview
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.
This profile is used to define the content that will be returned by the API Server in response to requests to access Group resources. All elements described in the Definition and Detailed Definitions below are supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Definition
The official URL for this profile is:
https://fhir.athena.io/StructureDefinition/ah-group
The base definition for this profile is:
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  Group | I | 0..* | Group | Group of multiple entities | ||||
  id | Σ | 0..1 | string | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 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 | ΣI | 1..1 | boolean | Descriptive or actual | ||||
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (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: (unbound) (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: (unbound) (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 | I | 0..* | BackboneElement | Who or what is in group | ||||
 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 | ||||
| entity | 1..1 | Reference(Patient) | 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 | ||||||||
Detailed Definitions
Group
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; i.e. a collection of entities that isn't an Organization.
| Cardinality | 0..* |
| Type | Root |
| Comments | If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics. |
Group.id
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
| Cardinality | 0..1 |
| Type | string |
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Group.meta
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
| Cardinality | 0..1 |
| Type | Meta |
Group.implicitRules
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
| Cardinality | 0..1 |
| Type | uri |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Group.language
The base language in which the resource is written.
| Cardinality | 0..1 |
| Type | code Binding: CommonLanguages (preferred) |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Group.text
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
| Cardinality | 0..1 |
| Type | Narrative |
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Group.contained
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
| Cardinality | 0..* |
| Type | Resource |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Group.extension
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
| Cardinality | 0..* |
| Type | Extension |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Group.modifierExtension
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
| Cardinality | 0..* |
| Type | Extension |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Requirements | Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Group.identifier
A unique business identifier for this group.
| Cardinality | 0..* |
| Type | Identifier |
| Requirements | Allows the group to be referenced from external specifications. |
Group.active
Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
| Cardinality | 0..1 |
| Type | boolean |
| Requirements | Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists). |
Group.type
Identifies the broad classification of the kind of resources the group includes.
| Cardinality | 1..1 |
| Type | code Binding: GroupType (required) |
| Comments | Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.). |
| Requirements | Identifies what type of resources the group is made up of. |
Group.actual
If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
| Cardinality | 1..1 |
| Type | boolean |
| Requirements | There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag. |
Group.code
Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Comments | This would generally be omitted for Person resources. |
Group.name
A label assigned to the group for human identification and communication.
| Cardinality | 0..1 |
| Type | string |
| Requirements | Used to identify the group in human communication. |
Group.quantity
A count of the number of resource instances that are part of the group.
| Cardinality | 0..1 |
| Type | unsignedInt |
| Comments | Note that the quantity may be less than the number of members if some of the members are not active. |
| Requirements | Group size is a common defining characteristic. |
Group.managingEntity
Entity responsible for defining and maintaining Group characteristics and/or registered members.
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Comments | This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension. |
Group.characteristic
Identifies traits whose presence r absence is shared by members of the group.
| Cardinality | 0..* |
| Type | BackboneElement |
| Comments | All the identified characteristics must be true for an entity to a member of the group. |
| Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Group.characteristic.id
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| Cardinality | 0..1 |
| Type | string |
Group.characteristic.extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
| Cardinality | 0..* |
| Type | Extension |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Group.characteristic.modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
| Cardinality | 0..* |
| Type | Extension |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Requirements | Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Group.characteristic.code
A code that identifies the kind of trait being asserted.
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Requirements | Need a formal way of identifying the characteristic being described. |
Group.characteristic.value[x]
The value of the trait that holds (or does not hold - see 'exclude') for members of the group.
| Cardinality | 1..1 |
| Type | CodeableConcept | boolean | Quantity | Range | Reference |
| Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
| Requirements | The value of the characteristic is what determines group membership. |
Group.characteristic.exclude
If true, indicates the characteristic is one that is NOT held by members of the group.
| Cardinality | 1..1 |
| Type | boolean |
| Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
| Requirements | Sometimes group membership is determined by characteristics not possessed. |
Group.characteristic.period
The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.
| Cardinality | 0..1 |
| Type | Period |
Group.member
Identifies the resource instances that are members of the group.
| Cardinality | 0..* |
| Type | BackboneElement |
| Requirements | Often the only thing of interest about a group is "who's in it". |
Group.member.id
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| Cardinality | 0..1 |
| Type | string |
Group.member.extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
| Cardinality | 0..* |
| Type | Extension |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Group.member.modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
| Cardinality | 0..* |
| Type | Extension |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Requirements | Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Group.member.entity
A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.
| Cardinality | 1..1 |
| Type | Reference(Patient) |
Group.member.period
The period that the member was in the group, if known.
| Cardinality | 0..1 |
| Type | Period |
| Requirements | Need to track who was in a group at a particular time. |
Group.member.inactive
A flag to indicate that the member is no longer in the group, but previously may have been a member.
| Cardinality | 0..1 |
| Type | boolean |
| Requirements | Sometimes you don't know when someone stopped being in a group, but not when. |
Operations
GET $export
AthenahealthGroupLevelExport
FHIR OperationDefinition: export (2.12.0)
FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified Group.
The following authorization scopes are required for this operation:
- system/AllergyIntolerance.read
- system/CarePlan.read
- system/CareTeam.read
- system/Condition.read
- system/Device.read
- system/DiagnosticReport.read
- system/DocumentReference.read
- system/Encounter.read
- system/Goal.read
- system/Immunization.read
- system/Location.read
- system/Medication.read
- system/MedicationRequest.read
- system/Observation.read
- system/Organization.read
- system/Patient.read
- system/Practitioner.read
- system/Procedure.read
- system/Provenance.read
Request Header
Accept: application/fhir+json
Prefer: respond-async
Parameters
❙ required
❙ conditional required
| Name | Type | Description |
| logicalId | string | (REQUIRED) The logical ID of the resource (alias: Resource.id). It is specified in the URL path and not as a query parameter. |
| _outputFormat | string | The format for the requested bulk data files to be generated as per [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html). Defaults to `application/fhir+ndjson`. |
| _type | string | A string of comma-delimited FHIR resource types. Only resources of the specified resource types(s) SHOULD be included in the response. If this parameter is omitted, the server SHOULD return all supported resources within the scope of the client authorization. For non-system-level requests, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned as well as other resources outside of the patient compartment that are helpful in interpreting the patient data such as Organization and Practitioner. Resource references MAY be relative URIs with the format {resource type}/{id}, or absolute URIs with the same structure rooted in the base URI for the server from which the export was performed. References will be resolved looking for a resource with the specified type and id within the file set. Note: Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the Argonaut Implementation Guide. |
Response Codes
| Response code | Description |
| 202 Accepted | The request has been received but not yet acted upon. The body of the HTTP response will contain an OperationOutcome resource that includes the export job identifier. |
| 400 Bad Request | The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed. |
| 429 Too Many Requests | The user has sent too many requests in a given amount of time (rate limiting). The body of the HTTP response will contain an OperationOutcome resource that includes additional information. |
| 500 Internal Server Error | The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
| 5xx Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |