Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Logical Model: Profile - Athena Custom Collection

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-collection-profile Version: 23.1.0
Active as of 2023-03-01 Computable Name: Collection

The Collection is providing details of payor for adjusted amounts,insurance, guarantor and patient balance, such as for goods and services rendered by a provider to patients covered by insurance plans offered by that payor.


This Collection profile is part of the set of resource profiles supported by the API Server used with the athenaPractice product starting with version 23.0. This is not a FHIR Conformant Resource. It further describes read and search capabilities of these products.
Note: Create and Update operations are NOT supported for this resource.

Overview

This resource is used to extract the collection information of Patient/Guarantor. This Collection information contains the amount details owed by patient for practice.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Collection resources. All elements listed in the differential table are supported. Elements listed in the differential profile view 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.

Source

The Collection resource contains information of patient and guarantor. This information is extracted from PatientProfile, Guarantor, PatientProfileAgg, PatientVisit, PatientVisitAgg, MedLists, PatientCorrespondence, PaymentMethod, GuarantorPatientPayments,Batch tables.

Example

Example for the athena-collection-profile Profile.

Collection Example

Usage:

  • This Logical Model 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.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-collection-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient resource.
.... reference 0..1 string Reference to the Patient
.... display 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... guarantor 0..1 Reference(guarantor) Guarantor reference
.... reference 0..1 string GuarantorId refering to Related person
.... display 0..1 string Guarantor Name
... ssn 0..1 string SSN number
... visitDate 0..1 dateTime Visit date of patient(guarantor)
... description 0..1 string Description of visit.
... ticketNumber 0..1 string Ticket Number of patient
... guarantorInsuranceBalance 0..1 Money Guarantor insurance balance details
.... value 0..1 decimal Collection amount
.... currency 0..1 code Currency
... guarantorPatientBalance 0..1 Money Guarantor patient balance details
.... value 0..1 decimal Collection amount
.... currency 0..1 code Currency
... guarantorBalance 0..1 Money Guarantor Balance Details
.... value 0..1 decimal Guarantor Balance.
.... currency 0..1 code Currency
... insuranceBalance 0..1 Money Patient Insurance Balance Details
.... value 0..1 decimal Patient insurance balance.
.... currency 0..1 code Currency
... patientBalance 0..1 Money Patient Balance Details
.... value 0..1 decimal Total balance amount of patient
.... currency 0..1 code Currency
... guarantorAmount 0..1 Money Gaurantor Balance Details
.... value 0..1 decimal Guarantor Balance.
.... currency 0..1 code Currency
... totalBalance 0..1 Money Patient Balance Details
.... value 0..1 decimal Total balance amount.
.... currency 0..1 code Currency
... visitInsurancePayment 0..1 Money Visit Insurance payment
.... value 0..1 decimal Visit insurance payment.
.... currency 0..1 code Currency
... visitPatientPayment 0..1 Money Patient payment
.... value 0..1 decimal Visit patient payment amount
.... currency 0..1 code Currency
... visitInsuranceBalance 0..1 Money insurance Balance Details
.... value 0..1 decimal Insurance amount after visit
.... currency 0..1 code Currency
... visitPatientBalance 0..1 Money Patient balance amount Details
.... value 0..1 decimal Patient balance amount.
.... currency 0..1 code Currency
... collectionsStatus 0..1 string Status of collection

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-collection-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient resource.
.... reference ΣC 0..1 string Reference to the Patient
.... display Σ 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... guarantor C 0..1 Reference(guarantor) Guarantor reference
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string GuarantorId refering to Related person
.... display Σ 0..1 string Guarantor Name
... ssn 0..1 string SSN number
... visitDate 0..1 dateTime Visit date of patient(guarantor)
... description 0..1 string Description of visit.
... ticketNumber 0..1 string Ticket Number of patient
... guarantorInsuranceBalance 0..1 Money Guarantor insurance balance details
.... value Σ 0..1 decimal Collection amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorPatientBalance 0..1 Money Guarantor patient balance details
.... value Σ 0..1 decimal Collection amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorBalance 0..1 Money Guarantor Balance Details
.... value Σ 0..1 decimal Guarantor Balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... insuranceBalance 0..1 Money Patient Insurance Balance Details
.... value Σ 0..1 decimal Patient insurance balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... patientBalance 0..1 Money Patient Balance Details
.... value Σ 0..1 decimal Total balance amount of patient
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorAmount 0..1 Money Gaurantor Balance Details
.... value Σ 0..1 decimal Guarantor Balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalBalance 0..1 Money Patient Balance Details
.... value Σ 0..1 decimal Total balance amount.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitInsurancePayment 0..1 Money Visit Insurance payment
.... value Σ 0..1 decimal Visit insurance payment.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitPatientPayment 0..1 Money Patient payment
.... value Σ 0..1 decimal Visit patient payment amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitInsuranceBalance 0..1 Money insurance Balance Details
.... value Σ 0..1 decimal Insurance amount after visit
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitPatientBalance 0..1 Money Patient balance amount Details
.... value Σ 0..1 decimal Patient balance amount.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... collectionsStatus 0..1 string Status of collection

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
athena-collection-profile.guarantorInsuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorPatientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.insuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.patientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorAmount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.totalBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitInsurancePayment.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitPatientPayment.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitInsuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitPatientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ref-1errorathena-collection-profile.patient, athena-collection-profile.guarantorSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-collection-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient 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
.... reference ΣC 0..1 string Reference to the Patient
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... guarantor C 0..1 Reference(guarantor) Guarantor reference
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string GuarantorId refering to Related person
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Guarantor Name
... ssn 0..1 string SSN number
... visitDate 0..1 dateTime Visit date of patient(guarantor)
... description 0..1 string Description of visit.
... ticketNumber 0..1 string Ticket Number of patient
... guarantorInsuranceBalance 0..1 Money Guarantor insurance balance details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Collection amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorPatientBalance 0..1 Money Guarantor patient balance details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Collection amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorBalance 0..1 Money Guarantor Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Guarantor Balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... insuranceBalance 0..1 Money Patient Insurance Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Patient insurance balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... patientBalance 0..1 Money Patient Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Total balance amount of patient
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorAmount 0..1 Money Gaurantor Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Guarantor Balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalBalance 0..1 Money Patient Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Total balance amount.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitInsurancePayment 0..1 Money Visit Insurance payment
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Visit insurance payment.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitPatientPayment 0..1 Money Patient payment
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Visit patient payment amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitInsuranceBalance 0..1 Money insurance Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Insurance amount after visit
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitPatientBalance 0..1 Money Patient balance amount Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Patient balance amount.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... collectionsStatus 0..1 string Status of collection

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
athena-collection-profile.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-collection-profile.guarantor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-collection-profile.guarantorInsuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorPatientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.insuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.patientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorAmount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.totalBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitInsurancePayment.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitPatientPayment.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitInsuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitPatientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ref-1errorathena-collection-profile.patient, athena-collection-profile.guarantorSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Base

Summary

Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

  • Unable to summarise profile http://hl7.org/fhir/StructureDefinition/guarantor (no profile found)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-collection-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient resource.
.... reference 0..1 string Reference to the Patient
.... display 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... guarantor 0..1 Reference(guarantor) Guarantor reference
.... reference 0..1 string GuarantorId refering to Related person
.... display 0..1 string Guarantor Name
... ssn 0..1 string SSN number
... visitDate 0..1 dateTime Visit date of patient(guarantor)
... description 0..1 string Description of visit.
... ticketNumber 0..1 string Ticket Number of patient
... guarantorInsuranceBalance 0..1 Money Guarantor insurance balance details
.... value 0..1 decimal Collection amount
.... currency 0..1 code Currency
... guarantorPatientBalance 0..1 Money Guarantor patient balance details
.... value 0..1 decimal Collection amount
.... currency 0..1 code Currency
... guarantorBalance 0..1 Money Guarantor Balance Details
.... value 0..1 decimal Guarantor Balance.
.... currency 0..1 code Currency
... insuranceBalance 0..1 Money Patient Insurance Balance Details
.... value 0..1 decimal Patient insurance balance.
.... currency 0..1 code Currency
... patientBalance 0..1 Money Patient Balance Details
.... value 0..1 decimal Total balance amount of patient
.... currency 0..1 code Currency
... guarantorAmount 0..1 Money Gaurantor Balance Details
.... value 0..1 decimal Guarantor Balance.
.... currency 0..1 code Currency
... totalBalance 0..1 Money Patient Balance Details
.... value 0..1 decimal Total balance amount.
.... currency 0..1 code Currency
... visitInsurancePayment 0..1 Money Visit Insurance payment
.... value 0..1 decimal Visit insurance payment.
.... currency 0..1 code Currency
... visitPatientPayment 0..1 Money Patient payment
.... value 0..1 decimal Visit patient payment amount
.... currency 0..1 code Currency
... visitInsuranceBalance 0..1 Money insurance Balance Details
.... value 0..1 decimal Insurance amount after visit
.... currency 0..1 code Currency
... visitPatientBalance 0..1 Money Patient balance amount Details
.... value 0..1 decimal Patient balance amount.
.... currency 0..1 code Currency
... collectionsStatus 0..1 string Status of collection

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-collection-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient resource.
.... reference ΣC 0..1 string Reference to the Patient
.... display Σ 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... guarantor C 0..1 Reference(guarantor) Guarantor reference
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string GuarantorId refering to Related person
.... display Σ 0..1 string Guarantor Name
... ssn 0..1 string SSN number
... visitDate 0..1 dateTime Visit date of patient(guarantor)
... description 0..1 string Description of visit.
... ticketNumber 0..1 string Ticket Number of patient
... guarantorInsuranceBalance 0..1 Money Guarantor insurance balance details
.... value Σ 0..1 decimal Collection amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorPatientBalance 0..1 Money Guarantor patient balance details
.... value Σ 0..1 decimal Collection amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorBalance 0..1 Money Guarantor Balance Details
.... value Σ 0..1 decimal Guarantor Balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... insuranceBalance 0..1 Money Patient Insurance Balance Details
.... value Σ 0..1 decimal Patient insurance balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... patientBalance 0..1 Money Patient Balance Details
.... value Σ 0..1 decimal Total balance amount of patient
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorAmount 0..1 Money Gaurantor Balance Details
.... value Σ 0..1 decimal Guarantor Balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalBalance 0..1 Money Patient Balance Details
.... value Σ 0..1 decimal Total balance amount.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitInsurancePayment 0..1 Money Visit Insurance payment
.... value Σ 0..1 decimal Visit insurance payment.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitPatientPayment 0..1 Money Patient payment
.... value Σ 0..1 decimal Visit patient payment amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitInsuranceBalance 0..1 Money insurance Balance Details
.... value Σ 0..1 decimal Insurance amount after visit
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitPatientBalance 0..1 Money Patient balance amount Details
.... value Σ 0..1 decimal Patient balance amount.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... collectionsStatus 0..1 string Status of collection

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
athena-collection-profile.guarantorInsuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorPatientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.insuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.patientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorAmount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.totalBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitInsurancePayment.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitPatientPayment.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitInsuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitPatientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ref-1errorathena-collection-profile.patient, athena-collection-profile.guarantorSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-collection-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient 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
.... reference ΣC 0..1 string Reference to the Patient
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... guarantor C 0..1 Reference(guarantor) Guarantor reference
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string GuarantorId refering to Related person
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Guarantor Name
... ssn 0..1 string SSN number
... visitDate 0..1 dateTime Visit date of patient(guarantor)
... description 0..1 string Description of visit.
... ticketNumber 0..1 string Ticket Number of patient
... guarantorInsuranceBalance 0..1 Money Guarantor insurance balance details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Collection amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorPatientBalance 0..1 Money Guarantor patient balance details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Collection amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorBalance 0..1 Money Guarantor Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Guarantor Balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... insuranceBalance 0..1 Money Patient Insurance Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Patient insurance balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... patientBalance 0..1 Money Patient Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Total balance amount of patient
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... guarantorAmount 0..1 Money Gaurantor Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Guarantor Balance.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalBalance 0..1 Money Patient Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Total balance amount.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitInsurancePayment 0..1 Money Visit Insurance payment
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Visit insurance payment.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitPatientPayment 0..1 Money Patient payment
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Visit patient payment amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitInsuranceBalance 0..1 Money insurance Balance Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Insurance amount after visit
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... visitPatientBalance 0..1 Money Patient balance amount Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Patient balance amount.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... collectionsStatus 0..1 string Status of collection

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
athena-collection-profile.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-collection-profile.guarantor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-collection-profile.guarantorInsuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorPatientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.insuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.patientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.guarantorAmount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.totalBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitInsurancePayment.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitPatientPayment.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitInsuranceBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-collection-profile.visitPatientBalance.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ref-1errorathena-collection-profile.patient, athena-collection-profile.guarantorSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Base

Summary

Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

  • Unable to summarise profile http://hl7.org/fhir/StructureDefinition/guarantor (no profile found)

 

Other representations of profile: CSV, Excel

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Collection resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/customresource/Collection?{search-parameters}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://ap22sandbox.athenahealth.com/demoAPIServer
_id (token) The ID of the resource
patientProfileId known id of the patient.
patient (reference) Who the sensitivity is for
[_include] Specifies the supported hl7 resources include which are defined as reference in examples. Note: The Patient and RelatedPerson resources are supported via the _include parameter.
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 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.