LinuxForHealth FHIR Implementation Guide
8.0.0 - draft United States of America flag

LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions

Resource Profile: CDMCoverage - Detailed Descriptions

Active as of 2022-11-10

Definitions for the cdm-coverage resource profile.

1. Coverage
2. Coverage.meta
TypeMeta(ProcessMeta)
3. Coverage.contained
Control0..0*
4. Coverage.extension
SlicingThis element introduces a set of slices on Coverage.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
5. Coverage.extension:snapshotAgeInMonths
SliceNamesnapshotAgeInMonths
Definition

Age in months at the time of the coverage period

Control0..1
TypeExtension(SnapshotAgeInMonths) (Extension Type: unsignedInt)
6. Coverage.extension:snapshotAgeInYears
SliceNamesnapshotAgeInYears
Definition

The age of the person in years for the month of eligibility or service

Control0..1
TypeExtension(SnapshotAgeInYears) (Extension Type: unsignedInt)
7. Coverage.extension:employeeSnapshotAgeInYears
SliceNameemployeeSnapshotAgeInYears
Definition

The age of the employee in years for the month of eligibility or service

Control0..1
TypeExtension(EmployeeSnapshotAgeInYears) (Extension Type: unsignedInt)
8. Coverage.extension:ageGroup
SliceNameageGroup
Definition

Standard code for age groupings

Control0..1
TypeExtension(AgeGroup) (Extension Type: CodeableConcept)
9. Coverage.extension:ageGenderGroup
SliceNameageGenderGroup
Definition

Standard code for groupings that combine age and gender

Control0..1
TypeExtension(AgeGenderGroup) (Extension Type: CodeableConcept)
10. Coverage.extension:attributedProviderReferenceWithPeriod
SliceNameattributedProviderReferenceWithPeriod
Definition

Attributed provider reference with period

Control0..1
TypeExtension(AttributedProviderReferenceWithPeriod) (Extension Type: Reference(ReferenceWithPeriod))
11. Coverage.extension:benefitStatus
SliceNamebenefitStatus
Definition

HIPAA standard code for the benefit status

Control0..1
TypeExtension(BenefitStatus) (Extension Type: CodeableConcept)
12. Coverage.extension:benefitStatus.valueCodeableConcept
Control0..1
BindingThe codes SHALL be taken from HIPAA Benefit Status Value Set; other codes may be used where these codes are not suitable
13. Coverage.extension:claimGroupIdentifier
SliceNameclaimGroupIdentifier
Definition

Group ID of the plan member. This ID associates the primary plan holder with any dependents.

Control0..1
TypeExtension(ClaimGroupIdentifier) (Extension Type: string)
14. Coverage.extension:cobraIndicator
SliceNamecobraIndicator
Definition

Indicator of Consolidated Omnibus Budget Reconciliation Act (COBRA) continuation for the person

Control0..1
TypeExtension(CobraIndicator) (Extension Type: string)
15. Coverage.extension:coverageDays
SliceNamecoverageDays
Definition

Number of covered days of eligibility

Control0..1
TypeExtension(CoverageDays) (Extension Type: unsignedInt)
16. Coverage.extension:coverageMonth
SliceNamecoverageMonth
Definition

Date which reflects the month of eligibility

Control0..1
TypeExtension(CoverageMonth) (Extension Type: date)
17. Coverage.extension:coverageInsurancePlan
SliceNamecoverageInsurancePlan
Definition

Reference to the insurance plan for this coverage

Control0..1
TypeExtension(CoverageInsurancePlan) (Extension Type: Reference)
18. Coverage.extension:dualEligibilityIndicator
SliceNamedualEligibilityIndicator
Definition

Indicator of dual eligibility for the Medicaid market

Control0..1
TypeExtension(DualEligibilityIndicator) (Extension Type: string)
19. Coverage.extension:enrollmentPcp
SliceNameenrollmentPcp
Definition

Provider identifier of the primary care physician for the plan member

Control0..1
TypeExtension(EnrollmentPcp) (Extension Type: string)
20. Coverage.extension:enrollmentPcpNameOnEnrollment
SliceNameenrollmentPcpNameOnEnrollment
Definition

Original primary care physician (PCP) name as reporting on the eligibility record

Control0..1
TypeExtension(EnrollmentPcpNameOnEnrollment) (Extension Type: string)
21. Coverage.extension:enrollmentPcpZipOnEnrollment
SliceNameenrollmentPcpZipOnEnrollment
Definition

Original primary care physician (PCP) zip as reporting on the eligibility record

Control0..1
TypeExtension(EnrollmentPcpZipOnEnrollment) (Extension Type: string)
22. Coverage.extension:employeeAverageScheduledHours
SliceNameemployeeAverageScheduledHours
Definition

Average number of hours the employee is scheduled to work per day

Control0..1
TypeExtension(EmployeeAverageScheduledHours) (Extension Type: decimal)
23. Coverage.extension:employeeBirthDate
SliceNameemployeeBirthDate
Definition

Birthdate of the employee or contract holder. For security, this field may be hidden or the value stored in this field should only contain the year.

Control0..1
TypeExtension(EmployeeBirthDate) (Extension Type: date)
24. Coverage.extension:employeeCompany
SliceNameemployeeCompany
Definition

Code for the company of the employee

Control0..1
TypeExtension(EmployeeCompany) (Extension Type: CodeableConcept)
25. Coverage.extension:employeeCostCenter
SliceNameemployeeCostCenter
Definition

Code for the cost center of the employee

Control0..1
TypeExtension(EmployeeCostCenter) (Extension Type: CodeableConcept)
26. Coverage.extension:employeeCount
SliceNameemployeeCount
Definition

Flag of the employees in the eligibility record. Each employee is identified with a value of 1. All others are given values of 0.

Control0..1
TypeExtension(EmployeeCount) (Extension Type: unsignedInt)
27. Coverage.extension:employeeBusinessUnit
SliceNameemployeeBusinessUnit
Definition

Code for the business unit of the employee

Control0..1
TypeExtension(EmployeeBusinessUnit) (Extension Type: CodeableConcept)
28. Coverage.extension:employeeDepartment
SliceNameemployeeDepartment
Definition

Code for the department of the employee

Control0..1
TypeExtension(EmployeeDepartment) (Extension Type: CodeableConcept)
29. Coverage.extension:employeeDivision
SliceNameemployeeDivision
Definition

Code for the division of the employee

Control0..1
TypeExtension(EmployeeDivision) (Extension Type: CodeableConcept)
30. Coverage.extension:employeeExemptIndicator
SliceNameemployeeExemptIndicator
Definition

Indicator of whether the employee status is exempt or non-exempt

Control0..1
TypeExtension(EmployeeExemptIndicator) (Extension Type: string)
31. Coverage.extension:employeeFamilySize
SliceNameemployeeFamilySize
Definition

Total family size of the employee, whether or not dependents are insured or participating in any programs

Control0..1
TypeExtension(EmployeeFamilySize) (Extension Type: integer)
32. Coverage.extension:employeeFTECount
SliceNameemployeeFTECount
Definition

Full Time Equivalent calculation for the employee. Example 1: A full-time employee would have a value of 1. Example 2: A 20-hour per week employee would have a value of 0.5.

Control0..1
TypeExtension(EmployeeFTECount) (Extension Type: decimal)
33. Coverage.extension:employeeId
SliceNameemployeeId
Definition

Identifier for the employee

Control0..*
TypeExtension(EmployeeId) (Extension Type: Identifier)
34. Coverage.extension:employeeJobFamily
SliceNameemployeeJobFamily
Definition

Code for the job family of the employee

Control0..1
TypeExtension(EmployeeJobFamily) (Extension Type: CodeableConcept)
35. Coverage.extension:employeeJobGrade
SliceNameemployeeJobGrade
Definition

Code for the job grade of the employee

Control0..1
TypeExtension(EmployeeJobGrade) (Extension Type: CodeableConcept)
36. Coverage.extension:employeeJobLocation
SliceNameemployeeJobLocation
Definition

Code for the physical location where the employee works

Control0..*
TypeExtension(EmployeeJobLocation) (Extension Type: CodeableConcept)
37. Coverage.extension:employeePayFrequency
SliceNameemployeePayFrequency
Definition

Code indicating the frequency with which the employee is paid (e.g., daily, weekly, monthly)

Control0..1
TypeExtension(EmployeePayFrequency) (Extension Type: CodeableConcept)
38. Coverage.extension:employeePerformanceRating
SliceNameemployeePerformanceRating
Definition

Code indicating the performance rating of the employee, assigned as of the last review period

Control0..1
TypeExtension(EmployeePerformanceRating) (Extension Type: CodeableConcept)
39. Coverage.extension:employeeShift
SliceNameemployeeShift
Definition

Code indicating the regular shift which the employee is scheduled to work (e.g., day, afternoon, midnight)

Control0..1
TypeExtension(EmployeeShift) (Extension Type: CodeableConcept)
40. Coverage.extension:employeeSubBusinessUnit
SliceNameemployeeSubBusinessUnit
Definition

Code of the sub business unit of the employee

Control0..1
TypeExtension(EmployeeSubBusinessUnit) (Extension Type: CodeableConcept)
41. Coverage.extension:salaryIndicator
SliceNamesalaryIndicator
Definition

Indicator of whether the employee status is salaried

Control0..1
TypeExtension(SalaryIndicator) (Extension Type: string)
42. Coverage.extension:unionWorkerIndicator
SliceNameunionWorkerIndicator
Definition

Indicator that the contract holder (subscriber) belongs to a union

Control0..1
TypeExtension(UnionWorkerIndicator) (Extension Type: string)
43. Coverage.extension:employeeEducationLevel
SliceNameemployeeEducationLevel
Definition

Code indicating the highest level of education that the employee has completed (e.g., not a high school graduate, high school graduate, some college, associates degree, bachelors degree, graduate degree)

Control0..1
TypeExtension(EmployeeEducationLevel) (Extension Type: CodeableConcept)
44. Coverage.extension:employeeEducationLevel.valueCodeableConcept
Control0..1
BindingThe codes SHALL be taken from Payer Education Level Value Set; other codes may be used where these codes are not suitable
45. Coverage.extension:employeeGender
SliceNameemployeeGender
Definition

Employee gender code

Control0..1
TypeExtension(EmployeeGender) (Extension Type: CodeableConcept)
46. Coverage.extension:employeeGender.valueCodeableConcept
Control0..1
BindingThe codes SHALL be taken from Payer Gender Value Set; other codes may be used where these codes are not suitable
47. Coverage.extension:employeeHireDate
SliceNameemployeeHireDate
Definition

First date of employment for the employee

Control0..*
TypeExtension(EmployeeHireDate) (Extension Type: date)
48. Coverage.extension:employeeTerminationDate
SliceNameemployeeTerminationDate
Definition

Last date of employment for the employee

Control0..*
TypeExtension(EmployeeTerminationDate) (Extension Type: date)
49. Coverage.extension:employeeTerminationReason
SliceNameemployeeTerminationReason
Definition

Code indicating the reason for employee termination, if the employee was terminated (e.g., discharged, resigned)

Control0..*
TypeExtension(EmployeeTerminationReason) (Extension Type: CodeableConcept)
50. Coverage.extension:employeeJobTitle
SliceNameemployeeJobTitle
Definition

Job title of the employee

Control0..1
TypeExtension(EmployeeJobTitle) (Extension Type: CodeableConcept)
51. Coverage.extension:employeeJobTitle.valueCodeableConcept
Control0..1
BindingThe codes SHALL be taken from Payer Job Title Value Set; other codes may be used where these codes are not suitable
52. Coverage.extension:employeeLaborUnion
SliceNameemployeeLaborUnion
Definition

Code for the labor union of the employee

Control0..1
TypeExtension(EmployeeLaborUnion) (Extension Type: CodeableConcept)
53. Coverage.extension:employeeRetirementDate
SliceNameemployeeRetirementDate
Definition

Date of retirement for the employee or contract holder

Control0..1
TypeExtension(EmployeeRetirementDate) (Extension Type: date)
54. Coverage.extension:employeeStatus
SliceNameemployeeStatus
Definition

Status of the employee based on one or more code systems. Example codes include HIPAA (HipaaEmployeeStatusCodeSystem), Payer (PayerEmployeeStatusCodeSystem) or customer-specific codes.

Control0..1
TypeExtension(EmployeeStatus) (Extension Type: CodeableConcept)
55. Coverage.extension:employeeUnionId
SliceNameemployeeUnionId
Definition

Identification for the labor union member

Control0..1
TypeExtension(EmployeeUnionId) (Extension Type: string)
56. Coverage.extension:employeeWageAmount
SliceNameemployeeWageAmount
Definition

Wage amount of the employee for the time period represented by the Wage Basis field

Control0..1
TypeExtension(EmployeeWageAmount) (Extension Type: decimal)
57. Coverage.extension:employeeWageBasis
SliceNameemployeeWageBasis
Definition

Code indicating the basis on which the wages of the employee are calculated (e.g., hourly, daily, weekly, bimonthly, monthly, annually)

Control0..1
TypeExtension(EmployeeWageBasis) (Extension Type: CodeableConcept)
58. Coverage.extension:employeeYearOfService
SliceNameemployeeYearOfService
Definition

Net credited service in years for the employee

Control0..1
TypeExtension(EmployeeYearOfService) (Extension Type: unsignedInt)
59. Coverage.extension:employer
SliceNameemployer
Definition

Code for the employer

Control0..1
TypeExtension(Employer) (Extension Type: CodeableConcept)
60. Coverage.extension:familyIncomeLevel
SliceNamefamilyIncomeLevel
Definition

Code for the family income level of the person based on the Federal Poverty Level (FPL)

Control0..1
TypeExtension(FamilyIncomeLevel) (Extension Type: CodeableConcept)
61. Coverage.extension:jobClassCode
SliceNamejobClassCode
Definition

Classifcation group of the job role of the employee, for example, Top Executives, Post-secondary teachers, and Engineers

Control0..1
TypeExtension(JobClassCode) (Extension Type: CodeableConcept)
62. Coverage.extension:jobLocationZipcode
SliceNamejobLocationZipcode
Definition

5-digit zip code of the facility where the employee works

Control0..1
TypeExtension(JobLocationZipcode) (Extension Type: string)
63. Coverage.extension:longTermDisabilityBenefitRate
SliceNamelongTermDisabilityBenefitRate
Definition

Long term disability (LTD) benefit rate, expressed as a percentage of base wages (for example, 50.00%, 60.00%, 70.00%)

Control0..1
TypeExtension(LongTermDisabilityBenefitRate) (Extension Type: decimal)
64. Coverage.extension:medicareCoverage
SliceNamemedicareCoverage
Definition

Standard code for the type of Medicare coverage, if any, for the person

Control0..1
TypeExtension(MedicareCoverage) (Extension Type: CodeableConcept)
65. Coverage.extension:medicareCoverage.valueCodeableConcept
Control0..1
BindingThe codes SHALL be taken from Payer Medicare Coverage Value Set; other codes may be used where these codes are not suitable
66. Coverage.extension:medicareIndicator
SliceNamemedicareIndicator
Definition

Indicator of Medicare coverage for the member

Control0..1
TypeExtension(MedicareIndicator) (Extension Type: string)
67. Coverage.extension:memberEmployeeIndicator
SliceNamememberEmployeeIndicator
Definition

Code indicates whether the member is either an employee of the health plan, or the dependent of an employee of the health plan

Control0..1
TypeExtension(MemberEmployeeIndicator) (Extension Type: CodeableConcept)
68. Coverage.extension:planEmployeeCode
SliceNameplanEmployeeCode
Definition

Code indicating whether the member is an employee of the health plan or the dependent of an employee of the health plan

Control0..1
TypeExtension(PlanEmployeeCode) (Extension Type: string)
69. Coverage.extension:regionCode
SliceNameregionCode
Definition

Customer-specific code for the geographic region of the employee

Control0..1
TypeExtension(RegionCode) (Extension Type: CodeableConcept)
70. Coverage.extension:restrictedBenefits
SliceNamerestrictedBenefits
Definition

Code of the scope of Medicaid or CHIP benefits for a person

Control0..1
TypeExtension(RestrictedBenefits) (Extension Type: CodeableConcept)
71. Coverage.extension:shortTermDisabilityBenefitRate
SliceNameshortTermDisabilityBenefitRate
Definition

Short term disability (STD) benefit rate, expressed as a percentage of base wages or benefit amount (for example, 50.00%, 60.00%, 70.00%)

Control0..1
TypeExtension(ShortTermDisabilityBenefitRate) (Extension Type: decimal)
72. Coverage.extension:ssiIndicator
SliceNamessiIndicator
Definition

Indicates if the person receives Supplemental Security Income (SSI) administered via the Social Security Administration (SSA), at the time of coverage

Control0..1
TypeExtension(SsiIndicator) (Extension Type: string)
73. Coverage.extension:ssiStatus
SliceNamessiStatus
Definition

Standard code of the Supplemental Security Income (SSI) status for the person, at the time of coverage

Control0..1
TypeExtension(SsiStatus) (Extension Type: CodeableConcept)
74. Coverage.extension:ssiStatus.valueCodeableConcept
Control0..1
BindingThe codes SHALL be taken from Payer SSI Status Value Set; other codes may be used where these codes are not suitable
75. Coverage.extension:tanfBenefits
SliceNametanfBenefits
Definition

Standard code of the Temporary Assistance for Needy Families (TANF) benefits for the person

Control0..1
TypeExtension(TanfBenefits) (Extension Type: CodeableConcept)
76. Coverage.extension:tanfBenefits.valueCodeableConcept
Control0..1
BindingThe codes SHALL be taken from Payer TANF Benefit Value Set; other codes may be used where these codes are not suitable
77. Coverage.extension:totalDependentCount
SliceNametotalDependentCount
Definition

Number of dependents covered by the group health medical plan

Control0..1
TypeExtension(TotalDependentCount) (Extension Type: integer)
78. Coverage.extension:subscriberIdEncrypted
SliceNamesubscriberIdEncrypted
Definition

Encrypted identifier of the subscriber or family

Control0..1
TypeExtension(SubscriberIdEncrypted) (Extension Type: string)
79. Coverage.extension:payerRecordPopulationCount
SliceNamepayerRecordPopulationCount
Definition

Specifies whether the member should be counted as eligible for the coverage period. A value of 1 is used to count the member as eligible for the coverage period. Else the value should be 0.

Control0..1
TypeExtension(PayerRecordPopulationCount) (Extension Type: integer)
80. Coverage.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
TypeIdentifier(CDMIdentifier)
81. Coverage.period
Control10..1
82. Coverage.payor
Control1..1*
83. Coverage.class
Control0..?
84. Coverage.class.type
BindingThe codes SHALL be taken from Payer Coverage Class Value Set; other codes may be used where these codes are not suitableThe codes SHALL be taken from CoverageClassCodes; other codes may be used where these codes are not suitable
1. Coverage
Definition

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Control0..*
Comments

The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. Coverage.meta
Definition

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

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.

Control0..1 This element is affected by the following invariants: ele-1
TypeMeta(ProcessMeta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Coverage.implicitRules
Definition

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.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Coverage.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..0*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

5. Coverage.extension
Definition

An 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 manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Coverage.extension:snapshotAgeInMonths
SliceNamesnapshotAgeInMonths
Definition

Age in months at the time of the coverage period

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SnapshotAgeInMonths) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
7. Coverage.extension:snapshotAgeInYears
SliceNamesnapshotAgeInYears
Definition

The age of the person in years for the month of eligibility or service

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SnapshotAgeInYears) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
8. Coverage.extension:employeeSnapshotAgeInYears
SliceNameemployeeSnapshotAgeInYears
Definition

The age of the employee in years for the month of eligibility or service

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeSnapshotAgeInYears) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. Coverage.extension:ageGroup
SliceNameageGroup
Definition

Standard code for age groupings

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AgeGroup) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Coverage.extension:ageGenderGroup
SliceNameageGenderGroup
Definition

Standard code for groupings that combine age and gender

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AgeGenderGroup) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. Coverage.extension:attributedProviderReferenceWithPeriod
SliceNameattributedProviderReferenceWithPeriod
Definition

Attributed provider reference with period

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AttributedProviderReferenceWithPeriod) (Extension Type: Reference(ReferenceWithPeriod))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Coverage.extension:benefitStatus
SliceNamebenefitStatus
Definition

HIPAA standard code for the benefit status

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(BenefitStatus) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. Coverage.extension:benefitStatus.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
14. Coverage.extension:benefitStatus.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/benefit-status
15. Coverage.extension:benefitStatus.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
16. Coverage.extension:benefitStatus.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from HIPAA Benefit Status Value Set; other codes may be used where these codes are not suitableFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Coverage.extension:claimGroupIdentifier
SliceNameclaimGroupIdentifier
Definition

Group ID of the plan member. This ID associates the primary plan holder with any dependents.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ClaimGroupIdentifier) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
18. Coverage.extension:cobraIndicator
SliceNamecobraIndicator
Definition

Indicator of Consolidated Omnibus Budget Reconciliation Act (COBRA) continuation for the person

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CobraIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. Coverage.extension:coverageDays
SliceNamecoverageDays
Definition

Number of covered days of eligibility

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CoverageDays) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
20. Coverage.extension:coverageMonth
SliceNamecoverageMonth
Definition

Date which reflects the month of eligibility

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CoverageMonth) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
21. Coverage.extension:coverageInsurancePlan
SliceNamecoverageInsurancePlan
Definition

Reference to the insurance plan for this coverage

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CoverageInsurancePlan) (Extension Type: Reference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
22. Coverage.extension:dualEligibilityIndicator
SliceNamedualEligibilityIndicator
Definition

Indicator of dual eligibility for the Medicaid market

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(DualEligibilityIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
23. Coverage.extension:enrollmentPcp
SliceNameenrollmentPcp
Definition

Provider identifier of the primary care physician for the plan member

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EnrollmentPcp) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. Coverage.extension:enrollmentPcpNameOnEnrollment
SliceNameenrollmentPcpNameOnEnrollment
Definition

Original primary care physician (PCP) name as reporting on the eligibility record

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EnrollmentPcpNameOnEnrollment) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
25. Coverage.extension:enrollmentPcpZipOnEnrollment
SliceNameenrollmentPcpZipOnEnrollment
Definition

Original primary care physician (PCP) zip as reporting on the eligibility record

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EnrollmentPcpZipOnEnrollment) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
26. Coverage.extension:employeeAverageScheduledHours
SliceNameemployeeAverageScheduledHours
Definition

Average number of hours the employee is scheduled to work per day

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeAverageScheduledHours) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
27. Coverage.extension:employeeBirthDate
SliceNameemployeeBirthDate
Definition

Birthdate of the employee or contract holder. For security, this field may be hidden or the value stored in this field should only contain the year.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeBirthDate) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
28. Coverage.extension:employeeCompany
SliceNameemployeeCompany
Definition

Code for the company of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeCompany) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
29. Coverage.extension:employeeCostCenter
SliceNameemployeeCostCenter
Definition

Code for the cost center of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeCostCenter) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
30. Coverage.extension:employeeCount
SliceNameemployeeCount
Definition

Flag of the employees in the eligibility record. Each employee is identified with a value of 1. All others are given values of 0.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeCount) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
31. Coverage.extension:employeeBusinessUnit
SliceNameemployeeBusinessUnit
Definition

Code for the business unit of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeBusinessUnit) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
32. Coverage.extension:employeeDepartment
SliceNameemployeeDepartment
Definition

Code for the department of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeDepartment) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
33. Coverage.extension:employeeDivision
SliceNameemployeeDivision
Definition

Code for the division of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeDivision) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. Coverage.extension:employeeExemptIndicator
SliceNameemployeeExemptIndicator
Definition

Indicator of whether the employee status is exempt or non-exempt

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeExemptIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
35. Coverage.extension:employeeFamilySize
SliceNameemployeeFamilySize
Definition

Total family size of the employee, whether or not dependents are insured or participating in any programs

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeFamilySize) (Extension Type: integer)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
36. Coverage.extension:employeeFTECount
SliceNameemployeeFTECount
Definition

Full Time Equivalent calculation for the employee. Example 1: A full-time employee would have a value of 1. Example 2: A 20-hour per week employee would have a value of 0.5.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeFTECount) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
37. Coverage.extension:employeeId
SliceNameemployeeId
Definition

Identifier for the employee

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeId) (Extension Type: Identifier)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
38. Coverage.extension:employeeJobFamily
SliceNameemployeeJobFamily
Definition

Code for the job family of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeJobFamily) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. Coverage.extension:employeeJobGrade
SliceNameemployeeJobGrade
Definition

Code for the job grade of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeJobGrade) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
40. Coverage.extension:employeeJobLocation
SliceNameemployeeJobLocation
Definition

Code for the physical location where the employee works

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeJobLocation) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
41. Coverage.extension:employeePayFrequency
SliceNameemployeePayFrequency
Definition

Code indicating the frequency with which the employee is paid (e.g., daily, weekly, monthly)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeePayFrequency) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
42. Coverage.extension:employeePerformanceRating
SliceNameemployeePerformanceRating
Definition

Code indicating the performance rating of the employee, assigned as of the last review period

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeePerformanceRating) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
43. Coverage.extension:employeeShift
SliceNameemployeeShift
Definition

Code indicating the regular shift which the employee is scheduled to work (e.g., day, afternoon, midnight)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeShift) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
44. Coverage.extension:employeeSubBusinessUnit
SliceNameemployeeSubBusinessUnit
Definition

Code of the sub business unit of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeSubBusinessUnit) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
45. Coverage.extension:salaryIndicator
SliceNamesalaryIndicator
Definition

Indicator of whether the employee status is salaried

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SalaryIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
46. Coverage.extension:unionWorkerIndicator
SliceNameunionWorkerIndicator
Definition

Indicator that the contract holder (subscriber) belongs to a union

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(UnionWorkerIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
47. Coverage.extension:employeeEducationLevel
SliceNameemployeeEducationLevel
Definition

Code indicating the highest level of education that the employee has completed (e.g., not a high school graduate, high school graduate, some college, associates degree, bachelors degree, graduate degree)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeEducationLevel) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
48. Coverage.extension:employeeEducationLevel.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
49. Coverage.extension:employeeEducationLevel.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/employee-education-level
50. Coverage.extension:employeeEducationLevel.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
51. Coverage.extension:employeeEducationLevel.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer Education Level Value Set; other codes may be used where these codes are not suitableFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Coverage.extension:employeeGender
SliceNameemployeeGender
Definition

Employee gender code

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeGender) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
53. Coverage.extension:employeeGender.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. Coverage.extension:employeeGender.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/employee-gender
55. Coverage.extension:employeeGender.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
56. Coverage.extension:employeeGender.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer Gender Value Set; other codes may be used where these codes are not suitableFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Coverage.extension:employeeHireDate
SliceNameemployeeHireDate
Definition

First date of employment for the employee

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeHireDate) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
58. Coverage.extension:employeeTerminationDate
SliceNameemployeeTerminationDate
Definition

Last date of employment for the employee

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeTerminationDate) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
59. Coverage.extension:employeeTerminationReason
SliceNameemployeeTerminationReason
Definition

Code indicating the reason for employee termination, if the employee was terminated (e.g., discharged, resigned)

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeTerminationReason) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
60. Coverage.extension:employeeJobTitle
SliceNameemployeeJobTitle
Definition

Job title of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeJobTitle) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
61. Coverage.extension:employeeJobTitle.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
62. Coverage.extension:employeeJobTitle.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/employee-job-title
63. Coverage.extension:employeeJobTitle.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
64. Coverage.extension:employeeJobTitle.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer Job Title Value Set; other codes may be used where these codes are not suitableFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Coverage.extension:employeeLaborUnion
SliceNameemployeeLaborUnion
Definition

Code for the labor union of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeLaborUnion) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
66. Coverage.extension:employeeRetirementDate
SliceNameemployeeRetirementDate
Definition

Date of retirement for the employee or contract holder

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeRetirementDate) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
67. Coverage.extension:employeeStatus
SliceNameemployeeStatus
Definition

Status of the employee based on one or more code systems. Example codes include HIPAA (HipaaEmployeeStatusCodeSystem), Payer (PayerEmployeeStatusCodeSystem) or customer-specific codes.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeStatus) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
68. Coverage.extension:employeeUnionId
SliceNameemployeeUnionId
Definition

Identification for the labor union member

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeUnionId) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
69. Coverage.extension:employeeWageAmount
SliceNameemployeeWageAmount
Definition

Wage amount of the employee for the time period represented by the Wage Basis field

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeWageAmount) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
70. Coverage.extension:employeeWageBasis
SliceNameemployeeWageBasis
Definition

Code indicating the basis on which the wages of the employee are calculated (e.g., hourly, daily, weekly, bimonthly, monthly, annually)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeWageBasis) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
71. Coverage.extension:employeeYearOfService
SliceNameemployeeYearOfService
Definition

Net credited service in years for the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeYearOfService) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
72. Coverage.extension:employer
SliceNameemployer
Definition

Code for the employer

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Employer) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
73. Coverage.extension:familyIncomeLevel
SliceNamefamilyIncomeLevel
Definition

Code for the family income level of the person based on the Federal Poverty Level (FPL)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(FamilyIncomeLevel) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
74. Coverage.extension:jobClassCode
SliceNamejobClassCode
Definition

Classifcation group of the job role of the employee, for example, Top Executives, Post-secondary teachers, and Engineers

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JobClassCode) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
75. Coverage.extension:jobLocationZipcode
SliceNamejobLocationZipcode
Definition

5-digit zip code of the facility where the employee works

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JobLocationZipcode) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
76. Coverage.extension:longTermDisabilityBenefitRate
SliceNamelongTermDisabilityBenefitRate
Definition

Long term disability (LTD) benefit rate, expressed as a percentage of base wages (for example, 50.00%, 60.00%, 70.00%)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(LongTermDisabilityBenefitRate) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
77. Coverage.extension:medicareCoverage
SliceNamemedicareCoverage
Definition

Standard code for the type of Medicare coverage, if any, for the person

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(MedicareCoverage) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
78. Coverage.extension:medicareCoverage.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
79. Coverage.extension:medicareCoverage.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/medicare-coverage
80. Coverage.extension:medicareCoverage.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
81. Coverage.extension:medicareCoverage.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer Medicare Coverage Value Set; other codes may be used where these codes are not suitableFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
82. Coverage.extension:medicareIndicator
SliceNamemedicareIndicator
Definition

Indicator of Medicare coverage for the member

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(MedicareIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
83. Coverage.extension:memberEmployeeIndicator
SliceNamememberEmployeeIndicator
Definition

Code indicates whether the member is either an employee of the health plan, or the dependent of an employee of the health plan

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(MemberEmployeeIndicator) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
84. Coverage.extension:planEmployeeCode
SliceNameplanEmployeeCode
Definition

Code indicating whether the member is an employee of the health plan or the dependent of an employee of the health plan

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(PlanEmployeeCode) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
85. Coverage.extension:regionCode
SliceNameregionCode
Definition

Customer-specific code for the geographic region of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(RegionCode) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
86. Coverage.extension:restrictedBenefits
SliceNamerestrictedBenefits
Definition

Code of the scope of Medicaid or CHIP benefits for a person

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(RestrictedBenefits) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
87. Coverage.extension:shortTermDisabilityBenefitRate
SliceNameshortTermDisabilityBenefitRate
Definition

Short term disability (STD) benefit rate, expressed as a percentage of base wages or benefit amount (for example, 50.00%, 60.00%, 70.00%)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ShortTermDisabilityBenefitRate) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
88. Coverage.extension:ssiIndicator
SliceNamessiIndicator
Definition

Indicates if the person receives Supplemental Security Income (SSI) administered via the Social Security Administration (SSA), at the time of coverage

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SsiIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
89. Coverage.extension:ssiStatus
SliceNamessiStatus
Definition

Standard code of the Supplemental Security Income (SSI) status for the person, at the time of coverage

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SsiStatus) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
90. Coverage.extension:ssiStatus.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
91. Coverage.extension:ssiStatus.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/ssi-status
92. Coverage.extension:ssiStatus.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
93. Coverage.extension:ssiStatus.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer SSI Status Value Set; other codes may be used where these codes are not suitableFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
94. Coverage.extension:tanfBenefits
SliceNametanfBenefits
Definition

Standard code of the Temporary Assistance for Needy Families (TANF) benefits for the person

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(TanfBenefits) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
95. Coverage.extension:tanfBenefits.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
96. Coverage.extension:tanfBenefits.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/tanf-benefits
97. Coverage.extension:tanfBenefits.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
98. Coverage.extension:tanfBenefits.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer TANF Benefit Value Set; other codes may be used where these codes are not suitableFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
99. Coverage.extension:totalDependentCount
SliceNametotalDependentCount
Definition

Number of dependents covered by the group health medical plan

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(TotalDependentCount) (Extension Type: integer)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
100. Coverage.extension:subscriberIdEncrypted
SliceNamesubscriberIdEncrypted
Definition

Encrypted identifier of the subscriber or family

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SubscriberIdEncrypted) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
101. Coverage.extension:payerRecordPopulationCount
SliceNamepayerRecordPopulationCount
Definition

Specifies whether the member should be counted as eligible for the coverage period. A value of 1 is used to count the member as eligible for the coverage period. Else the value should be 0.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(PayerRecordPopulationCount) (Extension Type: integer)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
102. Coverage.modifierExtension
Definition

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 manageable, 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
103. Coverage.identifier
Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

A unique identifier assigned to this coverage.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: ele-1
TypeIdentifier(CDMIdentifier)
Requirements

Allows coverages to be distinguished and referenced.

Comments

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
104. Coverage.status
Definition

The status of the resource instance.

Control1..1
BindingThe codes SHALL be taken from FinancialResourceStatusCodes

A code specifying the state of the resource instance.

Typecode
Is Modifiertrue
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

Comments

This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
105. Coverage.beneficiary
Definition

The party who benefits from the insurance coverage; the patient when products and/or services are provided.

Control1..1
TypeReference(Patient))
Requirements

This is the party who receives treatment for which the costs are reimbursed under the coverage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
106. Coverage.period
Definition

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.

Control10..1
TypePeriod
Requirements

Some insurers require the submission of the coverage term.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
107. Coverage.payor
Definition

The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

Control1..1*
TypeReference(Organization|Patient|RelatedPerson))
Requirements

Need to identify the issuer to target for claim processing and for coordination of benefit processing.

Comments

May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. Coverage
Definition

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Control0..*
Comments

The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

2. Coverage.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Coverage.meta
Definition

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1 This element is affected by the following invariants: ele-1
TypeMeta(ProcessMeta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Coverage.implicitRules
Definition

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.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Coverage.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Coverage.text
Definition

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.

Control0..1
TypeNarrative
Alternate Namesnarrativehtmlxhtmldisplay
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Coverage.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..0
TypeResource
Alternate Namesinline resourcesanonymous resourcescontained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. Coverage.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Coverage.extension:snapshotAgeInMonths
SliceNamesnapshotAgeInMonths
Definition

Age in months at the time of the coverage period

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SnapshotAgeInMonths) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Coverage.extension:snapshotAgeInYears
SliceNamesnapshotAgeInYears
Definition

The age of the person in years for the month of eligibility or service

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SnapshotAgeInYears) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. Coverage.extension:employeeSnapshotAgeInYears
SliceNameemployeeSnapshotAgeInYears
Definition

The age of the employee in years for the month of eligibility or service

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeSnapshotAgeInYears) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Coverage.extension:ageGroup
SliceNameageGroup
Definition

Standard code for age groupings

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AgeGroup) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. Coverage.extension:ageGenderGroup
SliceNameageGenderGroup
Definition

Standard code for groupings that combine age and gender

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AgeGenderGroup) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
14. Coverage.extension:attributedProviderReferenceWithPeriod
SliceNameattributedProviderReferenceWithPeriod
Definition

Attributed provider reference with period

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AttributedProviderReferenceWithPeriod) (Extension Type: Reference(ReferenceWithPeriod))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Coverage.extension:benefitStatus
SliceNamebenefitStatus
Definition

HIPAA standard code for the benefit status

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(BenefitStatus) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
16. Coverage.extension:benefitStatus.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
17. Coverage.extension:benefitStatus.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
18. Coverage.extension:benefitStatus.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/benefit-status
19. Coverage.extension:benefitStatus.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
20. Coverage.extension:benefitStatus.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from HIPAA Benefit Status Value Set; other codes may be used where these codes are not suitable
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Coverage.extension:claimGroupIdentifier
SliceNameclaimGroupIdentifier
Definition

Group ID of the plan member. This ID associates the primary plan holder with any dependents.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ClaimGroupIdentifier) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
22. Coverage.extension:cobraIndicator
SliceNamecobraIndicator
Definition

Indicator of Consolidated Omnibus Budget Reconciliation Act (COBRA) continuation for the person

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CobraIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
23. Coverage.extension:coverageDays
SliceNamecoverageDays
Definition

Number of covered days of eligibility

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CoverageDays) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. Coverage.extension:coverageMonth
SliceNamecoverageMonth
Definition

Date which reflects the month of eligibility

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CoverageMonth) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
25. Coverage.extension:coverageInsurancePlan
SliceNamecoverageInsurancePlan
Definition

Reference to the insurance plan for this coverage

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(CoverageInsurancePlan) (Extension Type: Reference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
26. Coverage.extension:dualEligibilityIndicator
SliceNamedualEligibilityIndicator
Definition

Indicator of dual eligibility for the Medicaid market

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(DualEligibilityIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
27. Coverage.extension:enrollmentPcp
SliceNameenrollmentPcp
Definition

Provider identifier of the primary care physician for the plan member

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EnrollmentPcp) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
28. Coverage.extension:enrollmentPcpNameOnEnrollment
SliceNameenrollmentPcpNameOnEnrollment
Definition

Original primary care physician (PCP) name as reporting on the eligibility record

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EnrollmentPcpNameOnEnrollment) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
29. Coverage.extension:enrollmentPcpZipOnEnrollment
SliceNameenrollmentPcpZipOnEnrollment
Definition

Original primary care physician (PCP) zip as reporting on the eligibility record

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EnrollmentPcpZipOnEnrollment) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
30. Coverage.extension:employeeAverageScheduledHours
SliceNameemployeeAverageScheduledHours
Definition

Average number of hours the employee is scheduled to work per day

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeAverageScheduledHours) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
31. Coverage.extension:employeeBirthDate
SliceNameemployeeBirthDate
Definition

Birthdate of the employee or contract holder. For security, this field may be hidden or the value stored in this field should only contain the year.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeBirthDate) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
32. Coverage.extension:employeeCompany
SliceNameemployeeCompany
Definition

Code for the company of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeCompany) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
33. Coverage.extension:employeeCostCenter
SliceNameemployeeCostCenter
Definition

Code for the cost center of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeCostCenter) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. Coverage.extension:employeeCount
SliceNameemployeeCount
Definition

Flag of the employees in the eligibility record. Each employee is identified with a value of 1. All others are given values of 0.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeCount) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
35. Coverage.extension:employeeBusinessUnit
SliceNameemployeeBusinessUnit
Definition

Code for the business unit of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeBusinessUnit) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
36. Coverage.extension:employeeDepartment
SliceNameemployeeDepartment
Definition

Code for the department of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeDepartment) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
37. Coverage.extension:employeeDivision
SliceNameemployeeDivision
Definition

Code for the division of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeDivision) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
38. Coverage.extension:employeeExemptIndicator
SliceNameemployeeExemptIndicator
Definition

Indicator of whether the employee status is exempt or non-exempt

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeExemptIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. Coverage.extension:employeeFamilySize
SliceNameemployeeFamilySize
Definition

Total family size of the employee, whether or not dependents are insured or participating in any programs

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeFamilySize) (Extension Type: integer)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
40. Coverage.extension:employeeFTECount
SliceNameemployeeFTECount
Definition

Full Time Equivalent calculation for the employee. Example 1: A full-time employee would have a value of 1. Example 2: A 20-hour per week employee would have a value of 0.5.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeFTECount) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
41. Coverage.extension:employeeId
SliceNameemployeeId
Definition

Identifier for the employee

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeId) (Extension Type: Identifier)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
42. Coverage.extension:employeeJobFamily
SliceNameemployeeJobFamily
Definition

Code for the job family of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeJobFamily) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
43. Coverage.extension:employeeJobGrade
SliceNameemployeeJobGrade
Definition

Code for the job grade of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeJobGrade) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
44. Coverage.extension:employeeJobLocation
SliceNameemployeeJobLocation
Definition

Code for the physical location where the employee works

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeJobLocation) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
45. Coverage.extension:employeePayFrequency
SliceNameemployeePayFrequency
Definition

Code indicating the frequency with which the employee is paid (e.g., daily, weekly, monthly)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeePayFrequency) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
46. Coverage.extension:employeePerformanceRating
SliceNameemployeePerformanceRating
Definition

Code indicating the performance rating of the employee, assigned as of the last review period

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeePerformanceRating) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
47. Coverage.extension:employeeShift
SliceNameemployeeShift
Definition

Code indicating the regular shift which the employee is scheduled to work (e.g., day, afternoon, midnight)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeShift) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
48. Coverage.extension:employeeSubBusinessUnit
SliceNameemployeeSubBusinessUnit
Definition

Code of the sub business unit of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeSubBusinessUnit) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
49. Coverage.extension:salaryIndicator
SliceNamesalaryIndicator
Definition

Indicator of whether the employee status is salaried

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SalaryIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
50. Coverage.extension:unionWorkerIndicator
SliceNameunionWorkerIndicator
Definition

Indicator that the contract holder (subscriber) belongs to a union

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(UnionWorkerIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
51. Coverage.extension:employeeEducationLevel
SliceNameemployeeEducationLevel
Definition

Code indicating the highest level of education that the employee has completed (e.g., not a high school graduate, high school graduate, some college, associates degree, bachelors degree, graduate degree)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeEducationLevel) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
52. Coverage.extension:employeeEducationLevel.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
53. Coverage.extension:employeeEducationLevel.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. Coverage.extension:employeeEducationLevel.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/employee-education-level
55. Coverage.extension:employeeEducationLevel.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
56. Coverage.extension:employeeEducationLevel.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer Education Level Value Set; other codes may be used where these codes are not suitable
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Coverage.extension:employeeGender
SliceNameemployeeGender
Definition

Employee gender code

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeGender) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
58. Coverage.extension:employeeGender.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
59. Coverage.extension:employeeGender.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
60. Coverage.extension:employeeGender.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/employee-gender
61. Coverage.extension:employeeGender.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
62. Coverage.extension:employeeGender.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer Gender Value Set; other codes may be used where these codes are not suitable
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Coverage.extension:employeeHireDate
SliceNameemployeeHireDate
Definition

First date of employment for the employee

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeHireDate) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
64. Coverage.extension:employeeTerminationDate
SliceNameemployeeTerminationDate
Definition

Last date of employment for the employee

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeTerminationDate) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
65. Coverage.extension:employeeTerminationReason
SliceNameemployeeTerminationReason
Definition

Code indicating the reason for employee termination, if the employee was terminated (e.g., discharged, resigned)

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(EmployeeTerminationReason) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
66. Coverage.extension:employeeJobTitle
SliceNameemployeeJobTitle
Definition

Job title of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeJobTitle) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
67. Coverage.extension:employeeJobTitle.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
68. Coverage.extension:employeeJobTitle.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
69. Coverage.extension:employeeJobTitle.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/employee-job-title
70. Coverage.extension:employeeJobTitle.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
71. Coverage.extension:employeeJobTitle.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer Job Title Value Set; other codes may be used where these codes are not suitable
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Coverage.extension:employeeLaborUnion
SliceNameemployeeLaborUnion
Definition

Code for the labor union of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeLaborUnion) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
73. Coverage.extension:employeeRetirementDate
SliceNameemployeeRetirementDate
Definition

Date of retirement for the employee or contract holder

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeRetirementDate) (Extension Type: date)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
74. Coverage.extension:employeeStatus
SliceNameemployeeStatus
Definition

Status of the employee based on one or more code systems. Example codes include HIPAA (HipaaEmployeeStatusCodeSystem), Payer (PayerEmployeeStatusCodeSystem) or customer-specific codes.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeStatus) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
75. Coverage.extension:employeeUnionId
SliceNameemployeeUnionId
Definition

Identification for the labor union member

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeUnionId) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
76. Coverage.extension:employeeWageAmount
SliceNameemployeeWageAmount
Definition

Wage amount of the employee for the time period represented by the Wage Basis field

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeWageAmount) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
77. Coverage.extension:employeeWageBasis
SliceNameemployeeWageBasis
Definition

Code indicating the basis on which the wages of the employee are calculated (e.g., hourly, daily, weekly, bimonthly, monthly, annually)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeWageBasis) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
78. Coverage.extension:employeeYearOfService
SliceNameemployeeYearOfService
Definition

Net credited service in years for the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EmployeeYearOfService) (Extension Type: unsignedInt)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
79. Coverage.extension:employer
SliceNameemployer
Definition

Code for the employer

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Employer) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
80. Coverage.extension:familyIncomeLevel
SliceNamefamilyIncomeLevel
Definition

Code for the family income level of the person based on the Federal Poverty Level (FPL)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(FamilyIncomeLevel) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
81. Coverage.extension:jobClassCode
SliceNamejobClassCode
Definition

Classifcation group of the job role of the employee, for example, Top Executives, Post-secondary teachers, and Engineers

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JobClassCode) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
82. Coverage.extension:jobLocationZipcode
SliceNamejobLocationZipcode
Definition

5-digit zip code of the facility where the employee works

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JobLocationZipcode) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
83. Coverage.extension:longTermDisabilityBenefitRate
SliceNamelongTermDisabilityBenefitRate
Definition

Long term disability (LTD) benefit rate, expressed as a percentage of base wages (for example, 50.00%, 60.00%, 70.00%)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(LongTermDisabilityBenefitRate) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
84. Coverage.extension:medicareCoverage
SliceNamemedicareCoverage
Definition

Standard code for the type of Medicare coverage, if any, for the person

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(MedicareCoverage) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
85. Coverage.extension:medicareCoverage.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
86. Coverage.extension:medicareCoverage.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
87. Coverage.extension:medicareCoverage.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/medicare-coverage
88. Coverage.extension:medicareCoverage.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
89. Coverage.extension:medicareCoverage.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer Medicare Coverage Value Set; other codes may be used where these codes are not suitable
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. Coverage.extension:medicareIndicator
SliceNamemedicareIndicator
Definition

Indicator of Medicare coverage for the member

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(MedicareIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
91. Coverage.extension:memberEmployeeIndicator
SliceNamememberEmployeeIndicator
Definition

Code indicates whether the member is either an employee of the health plan, or the dependent of an employee of the health plan

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(MemberEmployeeIndicator) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
92. Coverage.extension:planEmployeeCode
SliceNameplanEmployeeCode
Definition

Code indicating whether the member is an employee of the health plan or the dependent of an employee of the health plan

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(PlanEmployeeCode) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
93. Coverage.extension:regionCode
SliceNameregionCode
Definition

Customer-specific code for the geographic region of the employee

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(RegionCode) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
94. Coverage.extension:restrictedBenefits
SliceNamerestrictedBenefits
Definition

Code of the scope of Medicaid or CHIP benefits for a person

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(RestrictedBenefits) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
95. Coverage.extension:shortTermDisabilityBenefitRate
SliceNameshortTermDisabilityBenefitRate
Definition

Short term disability (STD) benefit rate, expressed as a percentage of base wages or benefit amount (for example, 50.00%, 60.00%, 70.00%)

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ShortTermDisabilityBenefitRate) (Extension Type: decimal)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
96. Coverage.extension:ssiIndicator
SliceNamessiIndicator
Definition

Indicates if the person receives Supplemental Security Income (SSI) administered via the Social Security Administration (SSA), at the time of coverage

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SsiIndicator) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
97. Coverage.extension:ssiStatus
SliceNamessiStatus
Definition

Standard code of the Supplemental Security Income (SSI) status for the person, at the time of coverage

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SsiStatus) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
98. Coverage.extension:ssiStatus.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
99. Coverage.extension:ssiStatus.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
100. Coverage.extension:ssiStatus.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/ssi-status
101. Coverage.extension:ssiStatus.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
102. Coverage.extension:ssiStatus.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer SSI Status Value Set; other codes may be used where these codes are not suitable
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
103. Coverage.extension:tanfBenefits
SliceNametanfBenefits
Definition

Standard code of the Temporary Assistance for Needy Families (TANF) benefits for the person

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(TanfBenefits) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
104. Coverage.extension:tanfBenefits.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
105. Coverage.extension:tanfBenefits.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
106. Coverage.extension:tanfBenefits.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/tanf-benefits
107. Coverage.extension:tanfBenefits.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Coverage.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
108. Coverage.extension:tanfBenefits.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from Payer TANF Benefit Value Set; other codes may be used where these codes are not suitable
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
109. Coverage.extension:totalDependentCount
SliceNametotalDependentCount
Definition

Number of dependents covered by the group health medical plan

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(TotalDependentCount) (Extension Type: integer)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
110. Coverage.extension:subscriberIdEncrypted
SliceNamesubscriberIdEncrypted
Definition

Encrypted identifier of the subscriber or family

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(SubscriberIdEncrypted) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
111. Coverage.extension:payerRecordPopulationCount
SliceNamepayerRecordPopulationCount
Definition

Specifies whether the member should be counted as eligible for the coverage period. A value of 1 is used to count the member as eligible for the coverage period. Else the value should be 0.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(PayerRecordPopulationCount) (Extension Type: integer)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
112. Coverage.modifierExtension
Definition

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 manageable, 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
113. Coverage.identifier
Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: ele-1
TypeIdentifier(CDMIdentifier)
Requirements

Allows coverages to be distinguished and referenced.

Comments

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
114. Coverage.status
Definition

The status of the resource instance.

Control1..1
BindingThe codes SHALL be taken from FinancialResourceStatusCodes A code specifying the state of the resource instance
Typecode
Is Modifiertrue
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

Comments

This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
115. Coverage.type
Definition

The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

Control0..1
BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodes The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization
TypeCodeableConcept
Requirements

The order of application of coverages is dependent on the types of coverage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
116. Coverage.policyHolder
Definition

The party who 'owns' the insurance policy.

Control0..1
TypeReference(PatientRelatedPersonOrganization))
Requirements

This provides employer information in the case of Worker's Compensation and other policies.

Comments

For example: may be an individual, corporation or the subscriber's employer.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
117. Coverage.subscriber
Definition

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.

Control0..1
TypeReference(PatientRelatedPerson))
Requirements

This is the party who is entitled to the benfits under the policy.

Comments

May be self or a parent in the case of dependants.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
118. Coverage.subscriberId
Definition

The insurer assigned ID for the Subscriber.

Control0..1
Typestring
Requirements

The insurer requires this identifier on correspondance and claims (digital and otherwise).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
119. Coverage.beneficiary
Definition

The party who benefits from the insurance coverage; the patient when products and/or services are provided.

Control1..1
TypeReference(Patient))
Requirements

This is the party who receives treatment for which the costs are reimbursed under the coverage.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
120. Coverage.dependent
Definition

A unique identifier for a dependent under the coverage.

Control0..1
Typestring
Requirements

For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.

Comments

Periodically the member number is constructed from the subscriberId and the dependant number.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
121. Coverage.relationship
Definition

The relationship of beneficiary (patient) to the subscriber.

Control0..1
BindingThe codes SHALL be taken from SubscriberRelationshipCodes; other codes may be used where these codes are not suitable The relationship between the Subscriber and the Beneficiary (insured/covered party/patient)
TypeCodeableConcept
Requirements

To determine relationship between the patient and the subscriber to determine coordination of benefits.

Comments

Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
122. Coverage.period
Definition

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.

Control1..1
TypePeriod
Requirements

Some insurers require the submission of the coverage term.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
123. Coverage.payor
Definition

The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

Control1..1
TypeReference(OrganizationPatientRelatedPerson))
Requirements

Need to identify the issuer to target for claim processing and for coordination of benefit processing.

Comments

May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
124. Coverage.class
Definition

A suite of underwriter specific classifiers.

Control0..*
TypeBackboneElement
Requirements

The codes provided on the health card which identify or confirm the specific policy for the insurer.

Comments

For example may be used to identify a class of coverage or employer group, Policy, Plan.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
125. Coverage.class.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
126. Coverage.class.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
127. Coverage.class.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser contentmodifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
128. Coverage.class.type
Definition

The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

Control1..1
BindingThe codes SHALL be taken from Payer Coverage Class Value Set; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

The insurer issued label for a specific health card value.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
129. Coverage.class.value
Definition

The alphanumeric string value associated with the insurer issued label.

Control1..1
Typestring
Requirements

The insurer issued label and value are necessary to identify the specific policy.

Comments

For example, the Group or Plan number.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
130. Coverage.class.name
Definition

A short description for the class.

Control0..1
Typestring
Requirements

Used to provide a meaningful description in correspondence to the patient.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
131. Coverage.order
Definition

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.

Control0..1
TypepositiveInt
Requirements

Used in managing the coordination of benefits.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
132. Coverage.network
Definition

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.

Control0..1
Typestring
Requirements

Used in referral for treatment and in claims processing.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
133. Coverage.costToBeneficiary
Definition

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.

Control0..*
TypeBackboneElement
Requirements

Required by providers to manage financial transaction with the patient.

Alternate NamesCoPayDeductibleExceptions
Comments

For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
134. Coverage.costToBeneficiary.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
135. Coverage.costToBeneficiary.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
136. Coverage.costToBeneficiary.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser contentmodifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
137. Coverage.costToBeneficiary.type
Definition

The category of patient centric costs associated with treatment.

Control0..1
BindingThe codes SHALL be taken from CoverageCopayTypeCodes; other codes may be used where these codes are not suitable The types of services to which patient copayments are specified
TypeCodeableConcept
Requirements

Needed to identify the category associated with the amount for the patient.

Comments

For example visit, specialist visits, emergency, inpatient care, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
138. Coverage.costToBeneficiary.value[x]
Definition

The amount due from the patient for the cost category.

Control1..1
TypeChoice of: Quantity(SimpleQuantity), Money
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Needed to identify the amount for the patient associated with the category.

Comments

Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
139. Coverage.costToBeneficiary.exception
Definition

A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

Control0..*
TypeBackboneElement
Requirements

Required by providers to manage financial transaction with the patient.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
140. Coverage.costToBeneficiary.exception.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
141. Coverage.costToBeneficiary.exception.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
142. Coverage.costToBeneficiary.exception.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser contentmodifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
143. Coverage.costToBeneficiary.exception.type
Definition

The code for the specific exception.

Control1..1
BindingFor example codes, see ExampleCoverageFinancialExceptionCodes The types of exceptions from the part or full value of financial obligations such as copays
TypeCodeableConcept
Requirements

Needed to identify the exception associated with the amount for the patient.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
144. Coverage.costToBeneficiary.exception.period
Definition

The timeframe during when the exception is in force.

Control0..1
TypePeriod
Requirements

Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
145. Coverage.subrogation
Definition

When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

Control0..1
Typeboolean
Requirements

See definition for when to be used.

Comments

Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
146. Coverage.contract
Definition

The policy(s) which constitute this insurance coverage.

Control0..*
TypeReference(Contract))
Requirements

To reference the legally binding contract between the policy holder and the insurer.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))