| EnrollEligCOB UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment." - HL7 FHIR, Coverage
Attributes | ||
Contract | contract |
"The policy(s) which constitute this insurance coverage." - HL7 FHIR, Coverage.contract |
CostToBeneficiary | 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." - HL7 FHIR, Coverage.costToBeneficiary |
CoveredPatient | coveredPatient |
"The party who benefits from the insurance coverage, the patient when services are provided." - HL7 FHIR, Coverage.beneficiary |
Dependent | dependent |
"A unique identifier for a dependent under the coverage." - HL7 FHIR, Coverage.dependent |
GroupCoverage | groupCoverage |
"A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan." - HL7 FHIR, Coverage.grouping |
«II» Id | identifier |
"A unique identifier assigned to this coverage. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant." - HL7 FHIR, Coverage.identifier |
Boolean | isSubrogated |
"When subrogation=true, this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. Typically, automotive and worker's compensation policies would be flagged with subrogation=true to enable healthcare payors to collect against accident claims." - HL7 FHIR, Coverage.subrogation |
«CS» Code | kind |
"The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization." - HL7 FHIR, Coverage.type |
Integer | order |
"The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care." - HL7 FHIR, Coverage.order |
«IVL_TS» 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." - HL7 FHIR, Coverage.period |
PlanOrPolicy | planOrPolicy | |
«ANY» Any | policyHolder |
"The party who owns the insurance policy. For example: may be an individual, corporation or the subscriber's employer." - HL7 FHIR, Coverage.policyHolderNote that in FHIR, this property is a pointer to a Patient, a RelatedPerson, or an Organization. In FHIM, this is modeled as an Any to accomodate the different possible target types. In the FHIM, if the policyHolder is the Patient, that person can be reached through the coveredPatient association. If the policy holder is a RelatedPerson, that person could be reached through the Subscriber association. if the policyHolder is an Organization, that organization can be reached through the groupCoverage.planSponsor relationship. This property is included in the FHIM as a convenience so the navigation through these associations can be avoided. |
String | sequence |
"An optional counter for a particular instance of the identified coverage which increments upon each renewal. [Some coverage, for example social plans, may be offered in short time increments, for example for a week or a month at a time, so while the rest of the plan details and identifiers may remain constant over time, the instance is incremented with each renewal and provided to the covered party on their card.]" - HL7 FHIR, Coverage.sequence |
«CS» Code | status |
"The status of the resource instance." Possible values are: Active; Cancelled; Draft; Entered in Error. - HL7 FHIR, Coverage.status |
Subscriber | 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." - HL7 FHIR, Coverage.subscriber |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | Coverage |
Name Expression | |
Namespace | EnrollEligCOB |
Owned Template Signature | |
Owner | EnrollEligCOB |
Owning Template Parameter | |
Package | EnrollEligCOB |
Qualified Name | FHIM::EnrollEligCOB::Coverage |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public Contract contract
"The policy(s) which constitute this insurance coverage." - HL7 FHIR, Coverage.contract
Aggregation | None |
Alias | |
Association | coverage_contract |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | contract |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::contract |
Stereotype | |
Template Parameter | |
Type | Contract |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public CostToBeneficiary 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." - HL7 FHIR, Coverage.costToBeneficiary
Aggregation | None |
Alias | |
Association | coverage_costToBeneficiary |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | costToBeneficiary |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::costToBeneficiary |
Stereotype | |
Template Parameter | |
Type | CostToBeneficiary |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public CoveredPatient coveredPatient
"The party who benefits from the insurance coverage, the patient when services are provided." - HL7 FHIR, Coverage.beneficiary
Aggregation | None |
Alias | |
Association | coverage_coveredPatient |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | coveredPatient |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::coveredPatient |
Stereotype | |
Template Parameter | |
Type | CoveredPatient |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Dependent dependent
"A unique identifier for a dependent under the coverage." - HL7 FHIR, Coverage.dependent
Aggregation | None |
Alias | |
Association | coverage_dependent |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | dependent |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::dependent |
Stereotype | |
Template Parameter | |
Type | Dependent |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public GroupCoverage groupCoverage
"A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan." - HL7 FHIR, Coverage.grouping
Aggregation | None |
Alias | |
Association | coverage_groupCoverage |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | groupCoverage |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::groupCoverage |
Stereotype | |
Template Parameter | |
Type | GroupCoverage |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «II» Id identifier
"A unique identifier assigned to this coverage. The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant." - HL7 FHIR, Coverage.identifier
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | identifier |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Boolean isSubrogated
"When subrogation=true, this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. Typically, automotive and worker's compensation policies would be flagged with subrogation=true to enable healthcare payors to collect against accident claims." - HL7 FHIR, Coverage.subrogation
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | isSubrogated |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::isSubrogated |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code kind
"The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization." - HL7 FHIR, Coverage.type
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Coverage |
Terminologies | [ HL7_FHIR_R4 Coverage Type and Self-Pay Codes http://hl7.org/fhir/ValueSet/coverage-type ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | kind |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::kind |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Integer order
"The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care." - HL7 FHIR, Coverage.order
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | order |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::order |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «IVL_TS» 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." - HL7 FHIR, Coverage.period
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | period |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::period |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PlanOrPolicy planOrPolicy
Aggregation | None |
Alias | |
Association | coverage_planOrPolicy |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | planOrPolicy |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::planOrPolicy |
Stereotype | |
Template Parameter | |
Type | PlanOrPolicy |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «ANY» Any policyHolder
"The party who owns the insurance policy. For example: may be an individual, corporation or the subscriber's employer." - HL7 FHIR, Coverage.policyHolderNote that in FHIR, this property is a pointer to a Patient, a RelatedPerson, or an Organization. In FHIM, this is modeled as an Any to accomodate the different possible target types. In the FHIM, if the policyHolder is the Patient, that person can be reached through the coveredPatient association. If the policy holder is a RelatedPerson, that person could be reached through the Subscriber association. if the policyHolder is an Organization, that organization can be reached through the groupCoverage.planSponsor relationship. This property is included in the FHIM as a convenience so the navigation through these associations can be avoided.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | policyHolder |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::policyHolder |
Stereotype | |
Template Parameter | |
Type | «ANY» Any |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String sequence
"An optional counter for a particular instance of the identified coverage which increments upon each renewal. [Some coverage, for example social plans, may be offered in short time increments, for example for a week or a month at a time, so while the rest of the plan details and identifiers may remain constant over time, the instance is incremented with each renewal and provided to the covered party on their card.]" - HL7 FHIR, Coverage.sequence
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | sequence |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::sequence |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code status
"The status of the resource instance." Possible values are: Active; Cancelled; Draft; Entered in Error. - HL7 FHIR, Coverage.status
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Coverage |
Terminologies | [ HL7_FHIR_R4 Financial Resource Status Codes http://hl7.org/fhir/ValueSet/fm-status ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | status |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::status |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Subscriber 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." - HL7 FHIR, Coverage.subscriber
Aggregation | None |
Alias | |
Association | coverage_subscriber |
Association End | |
Class | Coverage |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | subscriber |
Name Expression | |
Namespace | Coverage |
Opposite | |
Owner | Coverage |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::Coverage::subscriber |
Stereotype | |
Template Parameter | |
Type | Subscriber |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| EnrollEligCOB UML Documentation |
Summary:AttributesProperties | Detail:Attributes |