care.emr.resources.payment_reconciliation.spec module

class PaymentReconciliationTypeOptions(*values)

Bases: str, Enum

payment = 'payment'

adjustment = 'adjustment'

advance = 'advance'

class PaymentReconciliationStatusOptions(*values)

Bases: str, Enum

active = 'active'

cancelled = 'cancelled'

draft = 'draft'

entered_in_error = 'entered_in_error'

class PaymentReconciliationKindOptions(*values)

Bases: str, Enum

deposit = 'deposit'

periodic_payment = 'periodic_payment'

online = 'online'

kiosk = 'kiosk'

class PaymentReconciliationIssuerTypeOptions(*values)

Bases: str, Enum

patient = 'patient'

insurer = 'insurer'

class PaymentReconciliationOutcomeOptions(*values)

Bases: str, Enum

queued = 'queued'

complete = 'complete'

error = 'error'

partial = 'partial'

class PaymentReconciliationPaymentMethodOptions(*values)

Bases: str, Enum

cash = 'cash'

ccca = 'ccca'

cchk = 'cchk'

cdac = 'cdac'

chck = 'chck'

ddpo = 'ddpo'

debc = 'debc'

class BasePaymentReconciliationSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, reconciliation_type: PaymentReconciliationTypeOptions, status: PaymentReconciliationStatusOptions, kind: PaymentReconciliationKindOptions, issuer_type: PaymentReconciliationIssuerTypeOptions, outcome: PaymentReconciliationOutcomeOptions, disposition: str | None = None, payment_datetime: datetime | None = None, method: PaymentReconciliationPaymentMethodOptions, reference_number: str | None = None, authorization: str | None = None, note: str | None = None)

Bases: EMRResource

Base model for healthcare service

id: Annotated[UUID, UuidVersion(uuid_version=4)] | None

reconciliation_type: PaymentReconciliationTypeOptions

status: PaymentReconciliationStatusOptions

kind: PaymentReconciliationKindOptions

issuer_type: PaymentReconciliationIssuerTypeOptions

outcome: PaymentReconciliationOutcomeOptions

disposition: str | None

payment_datetime: datetime | None

method: PaymentReconciliationPaymentMethodOptions

reference_number: str | None

authorization: str | None

note: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PaymentReconciliationWriteSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, reconciliation_type: PaymentReconciliationTypeOptions, status: PaymentReconciliationStatusOptions, kind: PaymentReconciliationKindOptions, issuer_type: PaymentReconciliationIssuerTypeOptions, outcome: PaymentReconciliationOutcomeOptions, disposition: str | None = None, payment_datetime: datetime | None = None, method: PaymentReconciliationPaymentMethodOptions, reference_number: str | None = None, authorization: str | None = None, note: str | None = None, target_invoice: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, account: Annotated[UUID, UuidVersion(uuid_version=4)], amount: float | None = None, tendered_amount: float, returned_amount: float, is_credit_note: bool = False, location: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None)

Bases: BasePaymentReconciliationSpec

Payment reconciliation write specification

target_invoice: Annotated[UUID, UuidVersion(uuid_version=4)] | None

account: Annotated[UUID, UuidVersion(uuid_version=4)]

amount: float | None

tendered_amount: float

returned_amount: float

is_credit_note: bool

location: Annotated[UUID, UuidVersion(uuid_version=4)] | None

perform_extra_deserialization(is_update, obj)

check_amount_or_factor()

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PaymentReconciliationMinimalReadSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, reconciliation_type: PaymentReconciliationTypeOptions, status: PaymentReconciliationStatusOptions, kind: PaymentReconciliationKindOptions, issuer_type: PaymentReconciliationIssuerTypeOptions, outcome: PaymentReconciliationOutcomeOptions, disposition: str | None = None, payment_datetime: datetime | None = None, method: PaymentReconciliationPaymentMethodOptions, reference_number: str | None = None, authorization: str | None = None, note: str | None = None, amount: float | None = None, tendered_amount: float, returned_amount: float, is_credit_note: bool, created_date: datetime, modified_date: datetime)

Bases: BasePaymentReconciliationSpec

amount: float | None

tendered_amount: float

returned_amount: float

is_credit_note: bool

created_date: datetime

modified_date: datetime

classmethod perform_extra_serialization(mapping, obj)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PaymentReconciliationReadSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, reconciliation_type: PaymentReconciliationTypeOptions, status: PaymentReconciliationStatusOptions, kind: PaymentReconciliationKindOptions, issuer_type: PaymentReconciliationIssuerTypeOptions, outcome: PaymentReconciliationOutcomeOptions, disposition: str | None = None, payment_datetime: datetime | None = None, method: PaymentReconciliationPaymentMethodOptions, reference_number: str | None = None, authorization: str | None = None, note: str | None = None, amount: float | None = None, tendered_amount: float, returned_amount: float, is_credit_note: bool, created_date: datetime, modified_date: datetime, account: dict, target_invoice: dict | None = None)

Bases: PaymentReconciliationMinimalReadSpec

Invoice read specification

account: dict

target_invoice: dict | None

classmethod perform_extra_serialization(mapping, obj)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PaymentReconciliationRetrieveSpec(*, meta: dict = {}, id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None, reconciliation_type: PaymentReconciliationTypeOptions, status: PaymentReconciliationStatusOptions, kind: PaymentReconciliationKindOptions, issuer_type: PaymentReconciliationIssuerTypeOptions, outcome: PaymentReconciliationOutcomeOptions, disposition: str | None = None, payment_datetime: datetime | None = None, method: PaymentReconciliationPaymentMethodOptions, reference_number: str | None = None, authorization: str | None = None, note: str | None = None, amount: float | None = None, tendered_amount: float, returned_amount: float, is_credit_note: bool, created_date: datetime, modified_date: datetime, account: dict, target_invoice: dict | None = None, location: dict | None = None, created_by: dict | None, updated_by: dict | None)

Bases: PaymentReconciliationReadSpec

location: dict | None

created_by: dict | None

updated_by: dict | None

classmethod perform_extra_serialization(mapping, obj)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].