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

• Content
• Detailed Descriptions
• JSON

Resource Profile: athenahealth 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.

​This API supports creating and managing custom groups in addition to practice-level groups. Practice-level groups contain all the patients within the given context ID, where the group ID is formatted as ‘a-1.c-[practiceId]’. This API also supports the Group-level export FHIR Operation (i.e. GET [fhir base]/Group/[id]/$export where [id] is a custom or practice-level group ID’) 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.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Group

Name	Flags	Card.	Type	Description & Constraints
Group		0..*	Group	Group of multiple entities
meta
lastUpdated		0..1	instant	When the resource version last changed
type		1..1	code	person | animal | practitioner | device | medication | substance Required Pattern: person
code		0..0
managingEntity		0..1	Reference(Organization)	Entity that is the custodian of the Group's definition
characteristic		0..0
member
entity		1..1	Reference(Patient)	Reference to the group member
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Group of multiple entities
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	code	person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Required Pattern: person
actual	ΣC	1..1	boolean	Descriptive or actual
managingEntity	Σ	0..1	Reference(Organization)	Entity that is the custodian of the Group's definition
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.type	required	Pattern: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.characteristic.code	example
Group.characteristic.value[x]	example

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Group of multiple entities
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. Additional Bindings Purpose AllLanguages Max Binding
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. Required Pattern: person
actual	ΣC	1..1	boolean	Descriptive or actual
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
member	C	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Group.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Group.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Group.type	required	Pattern: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.characteristic.code	example
Group.characteristic.value[x]	example

This structure is derived from Group

Summary

Prohibited: 2 elements

Differential View

This structure is derived from Group

Name	Flags	Card.	Type	Description & Constraints
Group		0..*	Group	Group of multiple entities
meta
lastUpdated		0..1	instant	When the resource version last changed
type		1..1	code	person | animal | practitioner | device | medication | substance Required Pattern: person
code		0..0
managingEntity		0..1	Reference(Organization)	Entity that is the custodian of the Group's definition
characteristic		0..0
member
entity		1..1	Reference(Patient)	Reference to the group member
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Group of multiple entities
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	code	person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Required Pattern: person
actual	ΣC	1..1	boolean	Descriptive or actual
managingEntity	Σ	0..1	Reference(Organization)	Entity that is the custodian of the Group's definition
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.type	required	Pattern: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.characteristic.code	example
Group.characteristic.value[x]	example

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Group of multiple entities
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. Additional Bindings Purpose AllLanguages Max Binding
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. Required Pattern: person
actual	ΣC	1..1	boolean	Descriptive or actual
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
member	C	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Group.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Group.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Group.type	required	Pattern: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.characteristic.code	example
Group.characteristic.value[x]	example

This structure is derived from Group

Summary

Prohibited: 2 elements

​Other representations of profile: CSV, Excel, Schematron