Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

athenaFlow CapabilityStatement

This resource contains data for all the fields
athenaPractice CapabilityStatement

This resource contains data for all the fields

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Operation - unique

Operation defined on Patient resource

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

Profile - Athena Custom Adjustment

Custom Adjustment Resource Profile
Profile - Athena Custom BillingStatement

Custom BillingStatement Resource Profile
Profile - Athena Custom Charge

Custom Charge Resource Profile
Profile - Athena Custom Claim

Custom Claim Resource Profile
Profile - Athena Custom Collection

Custom Collection Resource Profile
Profile - Athena Custom Deductible

Custom Deductible Resource Profile
Profile - Athena Custom Eligibility

Custom Eligibility Resource Profile
Profile - Athena Custom PatientInsurance

Custom PatientInsurance Resource Profile
Profile - Athena Custom Payment

Custom Payment Resource Profile

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

AthenaConceptMap

Defines constraints and extensions on the Binary resource as supported by Athena Products.
AthenaList

Defines constraints and extensions on the List resource as supported by Athena Products.
AthenaNamingSystem

Defines constraints and extensions on the Binary resource as supported by Athena Products.
AthenaValueSet

Defines constraints and extensions on the Binary resource as supported by Athena Products.
Profile - Athena Account

Profile defined on Account resource
Profile - Athena AllergyIntolerance

Profile defined on AllergyIntolerance resource
Profile - Athena Appointment

Profile defined on Appointment resource
Profile - Athena AuditEvent

Profile defined on AuditEvent resource
Profile - Athena Binary

Profile defined on Binary resource
Profile - Athena CarePlan

Profile defined on CarePlan resource
Profile - Athena CareTeam

Profile defined on CareTeam resource
Profile - Athena ClinicalImpression

Profile defined on ClinicalImpression resource
Profile - Athena Condition

Profile defined on Condition resource
Profile - Athena Consent

Profile defined on Consent resource
Profile - Athena Coverage

Profile defined on Coverage resource
Profile - Athena Device

Profile defined on Device resource
Profile - Athena DiagnosticReport

Profile defined on DiagnosticReport resource
Profile - Athena DocumentReference

Profile defined on DocumentReference resource
Profile - Athena Encounter

Profile defined on Encounter resource
Profile - Athena Endpoint

Profile defined on Endpoint resource
Profile - Athena FamilyMemberHistory

Profile defined on FamilyMemberHistory resource
Profile - Athena Goal

Profile defined on Goal resource
Profile - Athena Immunization

Profile defined on Immunization resource
Profile - Athena Location

Profile defined on Location resource
Profile - Athena MedRequest

Profile defined on MedicationRequest resource
Profile - Athena Medication

Profile defined on Medication resource
Profile - Athena MedicationAdministration

Profile defined on MedicationAdministration resource
Profile - Athena MedicationStatement

Profile defined on MedicationStatement resource
Profile - Athena Observation

Profile defined on Observation resource
Profile - Athena Organization

Profile defined on Organization resource
Profile - Athena Patient

Profile defined on Patient resource
Profile - Athena Posting

Profile defined on Basic resource
Profile - Athena Practitioner

Profile defined on Practitioner resource
Profile - Athena PractitionerRole

Profile defined on PractitionerRole resource
Profile - Athena Procedure

Profile defined on Procedure resource
Profile - Athena Provenance

Profile defined on Provenance resource
Profile - Athena RelatedPerson

Profile defined on RelatedPerson resource
Profile - Athena Schedule

Profile defined on Schedule resource
Profile - Athena ServiceRequest

Profile defined on ServiceRequest resource
Profile - Athena Slot

Profile defined on Slot resource
Profile - Athena Subscription

Profile defined on Subscription resource

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Account Extension - Bill Status

The bill status extenstion for account
Account Extension - Current Carrier

The current carrier extenstion for account
Account Extension - Doctor Id

The doctorId extenstion for account
Account Extension - Visit Date

The visit Date extenstion for account
Account Extension - company Id

The company Id extenstion for account
Account Extension - facility Id

The facility Id extenstion for account
Account Extension - financial Class Mid

The financial Class Mid extenstion for account
Account Extension - patient Visit Id

The patient visit id extenstion for account
Booklist
Consent Extension - encounter

The Encounter extenstion for consent
Consent Extension - period

The period extenstion for consent
Coverage Extension - coverage-type

coverage-type
Coverage Extension - subscriber-name

subscriber-name
DocumentReference Extension - pubtime

pubtime for the document
DocumentReference Extension - refprovid

refprovid for the document
Extension - AUTHENTICATOR

AUTHENTICATOR
Extension - DESCRIPTION

DESCRIPTION
Extension - REFDOCID

Reference Doctor ID
Extension - RESPPROVID

Responsible Provider ID
Extension - SUMMARY

SUMMARY
Extension - encounter

The encounter in which this allergy was first recorded.
Extension - enddate

The end date for the allergy or intolerance (e.g., if later shown to be inactive or incorrect).
Extension - genderIdentity

Gender Identity
Extension - guarantorDetails

Guarantor Id
Extension - patientAsGuarantor

patient as guarantor
Extension - preferredContact

Preferred Contact of the Patient
Extension - sexualOrientation

Sexual Orientation
Immunization Extension - NotGiven

Flag for whether immunization was given
Immunization Extension - VFCEligibility

VFCEligibility
MedicationAdministration Extension - ddid

ddid Id
MedicationAdministration Extension - ndc

ndc Id
MedicationAdministration Extension - rxnorm

rxnorm Id
MedicationRequest Extension - ddid

ddid Id
MedicationRequest Extension - dispenseInstructions

dispenseInstructions Id
MedicationRequest Extension - dispenser

dispenser Id
MedicationRequest Extension - ndc

ndc Id
MedicationRequest Extension - rxnorm

rxnorm Id
MedicationStatement Extension - ddid

ddid Id
MedicationStatement Extension - medcategory

medcategory
MedicationStatement Extension - ndc

ndc Id
MedicationStatement Extension - rxnorm

rxnorm Id
Posting Extension - Batch

The Batch for Posting
Posting Extension - PayerName

The Payer Name for Posting
Posting Extension - patientVisitId

The Patient Visit ID for Posting
RecallAppointmentId

Booklist for the Appointment.
RecallId
Slot Extension - facility

The facility for the slot
Subscription Extension - owner

The owner extenstion for subscription
Subscription Extension - source id

The source id extenstion for subscription
Subscription Extension - source name

The source name extenstion for subscription
medicationrequest Extension - datewritten

The datewritten extenstion for medicationrequest

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Document class ValueSet

This resource contains data for all the fields
Document format ValueSet

This resource contains data for all the fields
Document type ValueSet

This resource contains data for all the fields
General ValueSet Example

This resource contains data for all the fields

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

General NamingSystem Example

This resource contains data for all the fields

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide.

General ConceptMap Example

This resource contains data for all the fields

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

DiagnosticReport Example supporting US Core DiagnosticReport Lab Profile

This resource contains data for all the fields
DiagnosticReport Example supporting US Core DiagnosticReport Note Profile

This resource contains data for all the fields
Example MedicationRequest - Example1
General Account Example

This resource contains data for all the fields
General AllergyIntolerance Example

This resource contains data for all the fields
General AuditEvent Example

This resource contains data for all the fields
General Basic example supporting $Posting Operation

This resource contains data for all the fields
General Binary Example

This resource contains data for all the fields
General Binary Example for plain text

This resource contains data for all the fields
General Binary Example for rtf text

This resource contains data for all the fields
General CarePlan Example

This resource contains data for all the fields
General CareTeam Example

This resource contains data for all the fields
General ClinicalImpression Example

This resource contains data for all the fields
General Condition Example

This resource contains data for all the fields
General Consent Example

This resource contains data for all the fields
General Coverage Example

This resource contains data for all the fields
General Device Example

This resource contains data for all the fields
General DocumentReference Example

This resource contains data for all the fields
General Encounter Example for lab report

This resource contains data for all the fields
General Encounter Example for office visit

This resource contains data for all the fields
General Encounter Example for radiology report

This resource contains data for all the fields
General Endpoint Example

This resource contains data for all the fields
General FamilyMemberHistory Example

This resource contains data for all the fields
General Goal Example

This resource contains data for all the fields
General Immunization Example

This resource contains data for all the fields
General Immunization Example for Reason Not Given

This resource contains data for all the fields
General Location Example

This resource contains data for all the fields
General Medication Example

This resource contains data for all the fields
General MedicationAdministration Example

This resource contains data for all the fields
General MedicationRequest Example/MR

This resource contains data for all the fields
General MedicationRequest Example/RX

This resource contains data for all the fields
General MedicationStatement Example

This resource contains data for all the fields
General Organization Example

This resource contains data for all the fields
General Patient Example

This resource contains data for all the fields
General Practitioner Example

This resource contains data for all the fields
General PractitionerRole Example

This resource contains data for all the fields
General Procedure Example

This resource contains data for all the fields
General RelatedPerson Example

This resource contains data for the fields that are applicable for the given relationship type
General Schedule Example

This resource contains data for all the fields
General ServiceRequest Example for Referral order

This resource contains Referral order data for all the fields
General ServiceRequest Example for Service order

This resource contains Service order data for all the fields
General ServiceRequest Example for Test order

This resource contains Test order data for all the fields
General Slot Example

This resource contains data for all the fields
Location example for room that can be scheduled for an appointment labeled as a resource in athenaPractice

This resource contains data for all the fields
Observation Example supporting US Core Laboratory Result Observation Profile

This resource contains data for all the fields
Observation Example supporting US Core Laboratory Result Observation Profile

This resource contains data for all the fields
Observation Example supporting US Core Laboratory Result Observation Profile

This resource contains data for all the fields
Observation Example supporting US Core Laboratory Result Observation Profile

This resource contains data for all the fields
Observation Example supporting US Core Pediatric BMI for Age Observation Profile

This resource contains data for all the fields
Observation Example supporting US Core Pediatric Head Occipital-frontal Circumference Percentile Profile

This resource contains data for all the fields
Observation Example supporting US Core Pediatric Weight for Height Observation Profile

This resource contains data for all the fields
Observation Example supporting US Core Pulse Oximetry Profile

This resource contains data for all the fields
Observation Example supporting US Core Smoking Status Observation Profile

This resource contains data for all the fields
Provenance Example supporting US Core Provenance Profile

This resource contains data for all the fields

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

All List Example

This resource contains data for all the fields
ConceptMap List Example

This resource contains data for all the fields
Flowsheet List Example

This resource contains data for all the fields
General Appointment Example

This resource contains data for all the fields
General Doctor Facility Organization Example

This resource contains data for all the fields
General RelatedPerson Guarantor Example

This resource contains data for the fields that are applicable for the given relationship type
General Subscription Example

This resource contains data for all the fields
NamingSystem List Example

This resource contains data for all the fields
ValueSet List Example

This resource contains data for all the fields
search parameters