Coverage class
Coverage Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Coverage({@Default(R5ResourceType.Coverage) @JsonKey(unknownEnumValue: R5ResourceType.Coverage) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirCode? kind, @JsonKey(name: '_kind') Element? kindElement, List<CoveragePaymentBy> ? paymentBy, CodeableConcept? type, Reference? policyHolder, Reference? subscriber, List<Identifier> ? subscriberId, required Reference beneficiary, String? dependent, @JsonKey(name: '_dependent') Element? dependentElement, CodeableConcept? relationship, Period? period, Reference? insurer, @JsonKey(name: 'class') List<CoverageClass> ? class_, FhirPositiveInt? order, @JsonKey(name: '_order') Element? orderElement, String? network, @JsonKey(name: '_network') Element? networkElement, List<CoverageCostToBeneficiary> ? costToBeneficiary, FhirBoolean? subrogation, @JsonKey(name: '_subrogation') Element? subrogationElement, List<Reference> ? contract, Reference? insurancePlan}) -
Coverage Financial instrument which may be used to reimburse or pay for
health care products and services. Includes both insurance and
self-payment.
constfactory
-
Coverage.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Coverage.fromJsonString(String source)
-
Acts like a constructor, returns a Coverage, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Coverage.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- beneficiary → Reference
-
beneficiary The party who benefits from the insurance coverage; the
patient when products and/or services are provided.
no setterinherited
-
class_
→ List<
CoverageClass> ? -
class_ ("class") A suite of underwriter specific classifiers.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
contract
→ List<
Reference> ? -
contract The policy(s) which constitute this insurance coverage.
no setterinherited
-
copyWith
→ $CoverageCopyWith<
Coverage> -
no setterinherited
-
costToBeneficiary
→ List<
CoverageCostToBeneficiary> ? -
costToBeneficiary A suite of codes indicating the cost category and
associated amount which have been detailed in the policy and may have
been included on the health card.
no setterinherited
- dbId → int?
-
no setterinherited
- dependent → String?
-
dependent A designator for a dependent under the coverage.
no setterinherited
- dependentElement → Element?
-
dependentElement ("_dependent") Extensions for dependent
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") May be used to represent additional
information that is not part of the basic definition of the resource.
To make the use of extensions safe and managable, there is a strict
set of governance applied to the definition and use of extensions.
Though any implementer can define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier The identifier of the coverage as issued by the insurer.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A reference to a set of rules that were followed when
the resource was constructed, and which must be understood when
processing the content. Often, this is a reference to an
implementation guide that defines the special rules along with other
profiles etc.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- insurancePlan → Reference?
-
insurancePlan The insurance plan details, benefits and costs, which
constitute this insurance coverage.
no setterinherited
- insurer → Reference?
-
insurer The program or plan underwriter, payor, insurance company.
no setterinherited
- kind → FhirCode?
-
kind The nature of the coverage be it insurance, or cash payment such
as self-pay.
no setterinherited
- kindElement → Element?
-
kindElement ("_kind") Extensions for kind
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- meta → FhirMeta?
-
meta The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not
always be associated with version changes to the resource.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May be used to represent additional information
that is not part of the basic definition of the resource and that
modifies the understanding of the element that contains it and/or the
understanding of the containing element's descendants. Usually
modifier elements provide negation or qualification. To make the use
of extensions safe and managable, there is a strict set of governance
applied to the definition and use of extensions. Though any
implementer is allowed to define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension. Applications processing a resource are required to check
for modifier extensions.Modifier extensions SHALL NOT change the
meaning of any elements on Resource or DomainResource (including
cannot change the meaning of modifierExtension itself).
no setterinherited
- network → String?
-
network The insurer-specific identifier for the insurer-defined
network of providers to which the beneficiary may seek treatment which
will be covered at the 'in-network' rate, otherwise 'out of network'
terms and conditions apply.
no setterinherited
- networkElement → Element?
-
networkElement ("_network") Extensions for network
no setterinherited
- order → FhirPositiveInt?
-
order The order of applicability of this coverage relative to other
coverages which are currently in force. Note, there may be gaps in the
numbering and this does not imply primary, secondary etc. as the
specific positioning of coverages depends upon the episode of care.
For example; a patient might have (0) auto insurance (1) their own
health insurance and (2) spouse's health insurance. When claiming for
treatments which were not the result of an auto accident then only
coverages (1) and (2) above would be applicatble and would apply in
the order specified in parenthesis.
no setterinherited
- orderElement → Element?
-
orderElement ("_order") Extensions for order
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
paymentBy
→ List<
CoveragePaymentBy> ? -
paymentBy Link to the paying party and optionally what specifically
they will be responsible to pay.
no setterinherited
- period → Period?
-
period Time period during which the coverage is in force. A missing
start date indicates the start date isn't known, a missing end date
means the coverage is continuing to be in force.
no setterinherited
- policyHolder → Reference?
-
policyHolder The party who 'owns' the insurance policy.
no setterinherited
- relationship → CodeableConcept?
-
relationship The relationship of beneficiary (patient) to the
subscriber.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a Coverage resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The status of the resource instance.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- subrogation → FhirBoolean?
-
subrogation When 'subrogation=true' this insurance instance has been
included not for adjudication but to provide insurers with the details
to recover costs.
no setterinherited
- subrogationElement → Element?
-
subrogationElement ("_subrogation") Extensions for subrogation
no setterinherited
- subscriber → Reference?
-
subscriber The party who has signed-up for or 'owns' the contractual
relationship to the policy or to whom the benefit of the policy for
services rendered to them or their family is due.
no setterinherited
-
subscriberId
→ List<
Identifier> ? -
subscriberId The insurer assigned ID for the Subscriber.
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the
resource and can be used to represent the content of the resource to a
human. The narrative need not encode all the structured data, but is
required to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- type → CodeableConcept?
-
type The type of coverage: social program, medical plan, accident
coverage (workers compensation, auto), group health or payment by an
individual or organization.
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited