Athena Core Implementation Guide
2.33.0 - release
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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| athenahealth Group Level Export |
FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified Group. The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern. |
| athenahealth Patient Match |
An extension to the base Patient-match OperationDefinition adding two additional optional input parameters to further classify the specific Patient match criteria. |
| athenahealth SMART Health Cards |
The definition for the $health-cards-issue operation. This operation is an implementation of Health Cards based on the the SMART Health Cards specification https://spec.smarthealth.cards/ |
| athenahealth Sync External Patient |
The $sync-external operation is used to replicate Patient resources from an external source system into athenahealth’s Patient Directory. This allows these records to be linked to athenahealth’s master Person index where applicable and queried using the Patient/$match operation (subject to pre-established access control restrictions). Note that this operation is asynchronous. A 202 status response indicates that the input Patient resource(s) have passed initial validation and been queued for ingestion, but it may take some minutes before the records are available to search. |
These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.
| athenahealth Brand |
Search by athenahealth Brand (e.g., ‘ah-brand=Organization/a-[practiceId].Brand-[brandId]’) for resources containing the ‘Athena Brand’ Extension |
| athenahealth Chart Sharing Group |
Search by athenahealth Chart Sharing Group (e.g., ‘ah-chart-sharing-group=Organization/a-[practiceId].CSG-[csgId]’) for resources containing the ‘Athena Chart Sharing Group’ Extension |
| athenahealth Cursor |
Search by cursor token for first resource to return in a paged search result |
| athenahealth Department |
Search by athenahealth Department (e.g., ‘ah-department=Organization/a-[practiceId].Department-[deptId]’) for resources containing the ‘Athena Department’ Extension |
| athenahealth Practice |
Identify the athenahealth Practice Organization (e.g., ‘ah-practice=Organization/a-1.Practice-[practiceId]’) |
| athenahealth Procedure Device |
Search for Procedures having a referenced Device |
| athenahealth Provider Group |
Search by athenahealth Provider Group (e.g., ‘ah-provider-group=Organization/a-[practiceId].PG-[providerGroupId]’) for resources containing the ‘Athena Provider Group’ Extension |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| athenahealth AllergyIntolerance |
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. |
| athenahealth Appointment |
Profile documenting the athenahealth implementation of the Appointment resource |
| athenahealth Binary |
A resource that represents the data of a single raw artifact as digital content accessible in its native format. |
| athenahealth CarePlan |
CarePlan describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. |
| athenahealth CareTeam |
The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient. |
| athenahealth Condition |
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. |
| athenahealth DepartmentLocation |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| athenahealth Device |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| athenahealth DiagnosticReport |
A diagnostic report is the set of information that is typically provided by a diagnostic service when investigations are complete. |
| athenahealth DocumentReference |
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. |
| athenahealth Encounter |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| athenahealth Goal |
A Goal in health care services delivery is generally an expressed desired health state to be achieved by a subject of care (or family/group) over a period or at a specific point of time. |
| 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. |
| athenahealth Immunization |
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. |
| athenahealth Location |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| athenahealth Medication |
This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
| athenahealth MedicationRequest |
An order or request for the supply of medication/vaccine, or instructions for the actual administration of medication to a patient. |
| athenahealth Observation |
Measurements and simple assertions made about a patient, device or other subject. |
| athenahealth Organization |
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. |
| athenahealth Patient |
Demographics and other administrative information about an individual receiving care or other health-related services. |
| athenahealth Practitioner |
A Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare. |
| athenahealth Procedure |
An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy. |
| athenahealth Provenance |
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. For example, a Provenance record could include the name of the organization, provider, or staff that created a FHIR Resource record and the timestamp of which it was created. |
| athenahealth ProviderPractitioner |
A Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare. |
| athenahealth ServiceRequest |
BETA: A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| athenahealth Brand |
An Extension used to reference a specific <b>athenahealth</b> <i>brand</i> Organization. |
| athenahealth Chart Sharing Group |
An Extension used to reference a specific <b>athenahealth</b> <i>chart sharing group</i> Organization. |
| athenahealth Condition Problem Type Category |
An Extension to Condition for problems that contains the type of the problem. |
| athenahealth Department |
An Extension used to reference a specific <b>athenahealth</b> <i>department</i> Organization. |
| athenahealth Device Implant Details |
An Extension containing details about a Device and the implant details for the referenced patient. |
| athenahealth Document |
An Extension used to reference a specific athenahealth document. |
| athenahealth Estimated Gestational Age |
An Extension to Observation resource for the estimated gestational age (EGA) of a pregnancy. |
| athenahealth Group Appointment |
An Extension used to reference a specific <b>athenahealth</b> <i>group-appointment</i> Appointment. |
| athenahealth Location Department Details |
An Extension containing details about a department location. |
| athenahealth Note To Patient |
An Extension to accommodate additional information in diagnostic report that is note to patient in athenahealth |
| athenahealth Practice |
An Extension used to reference a specific <b>athenahealth</b> <i>practice</i> Organization. |
| athenahealth Practitioner Provider Details |
An Extension containing details about a practitioner provider. |
| athenahealth Provider Group |
An Extension used to reference a specific <b>athenahealth</b> <i>provider group</i> Organization. |
| athenahealth Search Parameter Metadata |
This extension contains metadata regarding a resource’s collection of supported search parameters. |
| athenahealth Section Note |
An Extension containing a notes field that appears in athenahealth for a particular data section. |
| athenahealth Sortable Search Parameter |
This extension is a boolean flag that indicates whether the CapabilityStatement.rest.resource.searchParam instance is sortable. Assume false when this extension is not provided. |
| athenahealth Superseded Diagnostic Report |
An Extension used to reference a specific athenahealth superseded diagnostic report. |
These define sets of codes used by systems conforming to this implementation guide.
| athenahealth Appointment Cancellation Reason |
Codes describing Appointment cancellation reason |
| athenahealth Appointment Service Type |
Codes describing Appointment service type |
| athenahealth Condition Problem Type Category Value Set |
Acute and Chronice values for Athenahealth Problems |
| athenahealth Contact Relationship |
A brief vocabulary of athenahealth’s contact relationship codes |
| athenahealth Deidentification Group |
Value set for Bulk Export Deidentification Group Type |
| athenahealth Interface Event |
Codes describing FHIR Interface Message Events |
| athenahealth Patient Observation Category |
A list of athenahealth Patient Observation Categories |
| athenahealth Patient Observation Code |
A list of athenahealth Patient Observation Codes |
| athenahealth Provider Type |
List of athenahealth provider types |
| athenahealth Specialty |
List of athenahealth provider specialty codes |
| athenahealth Therapy Session Type |
A list of athenahealth Therapy Session Types |
| athenahealth Treatment Modality |
A list of athenahealth Treatment Modalities |
These define new code systems used by systems conforming to this implementation guide.
| athenahealth Appointment Cancellation Reason |
Appointment cancellation reason codes |
| athenahealth Appointment Service Type |
Appointment service type codes |
| athenahealth Contact Relationship |
A brief vocabulary of athenahealth’s contact relationship codes |
| athenahealth Deidentification Group Codes |
A brief vocabulary of athenahealth’s Deidentification Group Type |
| athenahealth Identifier Type |
A brief vocabulary of athenahealth’s Identifier Type codes |
| athenahealth Interface Event |
List of FHIR Interface Message events |
| athenahealth Patient Observation Category |
List of athenahealth patient observation categories |
| athenahealth Patient Observation Code |
List of athenahealth patient observation codes |
| athenahealth Provider Type |
List of athenahealth provider types |
| athenahealth Specialty |
List of athenahealth provider specialty codes |
| athenahealth Therapy Session Type |
List of athenahealth therapy session types |
| athenahealth Treatment Modality |
List of athenahealth treatment modalities |
These define identifier and/or code system identities used by systems conforming to this implementation guide.
| athenahealth Appointment |
Represents the Identifier.system for an appointment in an athenaNet context |
| athenahealth Appointment Cancellation Reason |
Represents the CodeSystem for the Appointment cancellation reason codes |
| athenahealth Appointment Service Type |
Represents the CodeSystem for the Appointment service type codes |
| athenahealth Athenanet Action |
Represents the Identifier.system for an authorization action |
| athenahealth Athenanet Source |
Represents the Identifier.system for an authorization source |
| athenahealth Athenanet User |
Represents the Identifier.system for an athenaNet user group. |
| athenahealth Chart |
Represents the Identifier.system for a chart ID for a patient in an athenaNet context. |
| athenahealth Chart Sharing Group |
Represents the Identifier.system for a chart sharing group in an athenaNet context. |
| athenahealth Clinical Provider |
Represents the Identifier.system for a clinical provider in an athenaNet context. |
| athenahealth Communicator Brand |
Represents the Identifier.system for a communicator brand in an athenaNet context. |
| athenahealth Contact Relationship |
Represents the CodeSystem for an athenaNet contact relationship code. |
| athenahealth Context |
Represents the Identifier.system for an athenaNet context (also known as a practice or tablespace). |
| athenahealth Cross-Link Appointment |
Represents the Identifier.system for an athenaOne cross-linked Appointment |
| athenahealth Cross-Link Brand |
Represents the Identifier.system for an athenaOne cross-linked Brand |
| athenahealth Cross-Link Chart Sharing Group |
Represents the Identifier.system for an athenaOne cross-linked Chart Sharing Group |
| athenahealth Cross-Link Clinical Provider |
Represents the Identifier.system for an athenaOne cross-linked Clinical Provider |
| athenahealth Cross-Link Department |
Represents the Identifier.system for an athenaOne cross-linked Department |
| athenahealth Cross-Link Encounter |
Represents the Identifier.system for an athenaOne cross-linked Encounter |
| athenahealth Cross-Link Local Clinical Provider |
Represents the Identifier.system for an athenaOne cross-linked Local Clinical Provider |
| athenahealth Cross-Link Patient |
Represents the Identifier.system for an athenaOne cross-linked Patient |
| athenahealth Cross-Link Practice |
Represents the Identifier.system for an athenaOne cross-linked Practice |
| athenahealth Cross-Link Provider |
Represents the Identifier.system for an athenaOne cross-linked Provider |
| athenahealth Cross-Link Provider Group |
Represents the Identifier.system for an athenaOne cross-linked Provider Group |
| athenahealth Deidentification Group |
Represents the CodeSystem used to define the Bulk Export Deidentification Groups |
| athenahealth Department |
Represents the Identifier.system for a department in an athenaNet context. |
| athenahealth Document Reference |
Represents the Identifier.system for different clinical notes and reports in an athenaNet context |
| athenahealth Encounter |
Represents the Identifier.system for an encounter service for a patient in an athenaNet context |
| athenahealth Enterprise Patient |
Represents the Identifier.system for an enterprise ID for a patient in an athenaNet context. |
| athenahealth Immunization |
Represents the Identifier.system for an event of a patient being administered a vaccine or a record of an immunization |
| athenahealth Interface event |
Represents the CodeSystem for the FHIR Interface Message Events |
| athenahealth Local Clinical Provider |
Represents the Identifier.system for a local clinical provider in an athenaNet context. |
| athenahealth MDP User |
Represents the Identifier.system for the athenaNet MDP user group |
| athenahealth Medical Group |
Represents the Identifier.system for a medical group in an athenaNet context. |
| athenahealth Medication |
Represents the Identifier.system for a medication in an athenaNet context |
| athenahealth Medication Request |
Represents the Identifier.system for a medication request in an athenaNet context |
| athenahealth Observation |
Represents the Identifier.system for an observation for a patient in an athenaNet context |
| athenahealth Patient |
Represents the Identifier.system for a patient in an athenaNet context |
| athenahealth Patient Experience User |
Represents the Identifier.system for a patient experience user |
| athenahealth Patient Experience User Permission |
Represents the Identifier.system for a patient experience user permission |
| athenahealth Patient Observation Category |
Represents the CodeSystem used to describe the categories of Patient Observations. |
| athenahealth Patient Observation Code |
Represents the CodeSystem used to describe the codes of Patient Observations. |
| athenahealth Patient Portal Third Party User Id |
Represents the Identifier.system for an Patient Portal Third Party User Id |
| athenahealth Patient Portal User |
Represents the Identifier.system for a patient portal user group. |
| athenahealth Portal User Permission |
Represents the Identifier.system for a patient portal user permission |
| athenahealth Procedure |
Represents the Identifier.system for a procedure performed for a patient |
| athenahealth Provider |
Represents the Identifier.system for a provider in an athenaNet context. |
| athenahealth Provider Group |
Represents the Identifier.system for a provider group in an athenaNet context. |
| athenahealth Referring Provider |
Represents the Identifier.system for a referring provider in an athenaNet context. |
| athenahealth Resource String Access |
Represents the Identifier.system for an access to a resource for an user |
| athenahealth ServiceRequest |
Represents the Identifier.system for a service request for a patient in an athenaNet context |
| athenahealth Stay |
Represents the Identifier.system for a time that a patient spent physically on location |
| athenahealth Therapy Session Type |
Represents the CodeSystem used to describe FHIR Goal Therapy Session Types. |
| athenahealth Treatment Modality |
Represents the CodeSystem used to describe FHIR Goal Treatment Modalities. |
| athenahealth User Type |
Represents the Identifier.system for the athenaNet user type |