0.1.0 - ci-build

kenyaClaimsIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SHACoverage - Detailed Descriptions

Draft as of 2024-09-06

Definitions for the SHACoverage resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Coverage
2. Coverage.id
ShortA unique id for the coverage resource that will be used for referencing within the bundle message.
Control1..?
4. Coverage.meta
ShortThe metadata about a resource.
Control1..?
6. Coverage.meta.profile
Control1..?
8. Coverage.identifier
ShortA unique id for the coverage resource that will be used for referencing within the bundle message.
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
10. Coverage.status
ShortThe status of the resource instance.
Pattern Valueactive
12. Coverage.type
Control1..?
14. Coverage.policyHolder
ShortOwner of the policy. The patient
TypeReference(SHAPatient, Organization)
16. Coverage.subscriber
ShortSubscriber to the policy. A reference to the patient resource. The patient
TypeReference(SHAPatient)
18. Coverage.subscriberId
ShortID assigned to the subscriber. The policy subscriber ID from the insurance company. SHA Number
20. Coverage.beneficiary
ShortThe party who is the subject of care and whose healthcare costs may be covered under the insurance policy. The Patient
Pattern Value{
  "reference" : "Patient/SHAPatientExample"
}
22. Coverage.dependent
ShortDependent number issued by an insurer to distinguish between multiple parties covered under the subscriber's policy.
24. Coverage.relationship
ShortThe relationship of the beneficiary to the subscriber eg Self
Control1..?
26. Coverage.period
ShortTime 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
28. Coverage.payor
ShortIssuer of the policy. A reference to the insurance company
Control0..1
30. Coverage.class
ShortAdditional coverage classifications. Plan and group
32. Coverage.class.value
ShortValue associated with the type. Group ID
34. Coverage.class.name
ShortValue associated with the type. Group display name
Control1..?
36. Coverage.costToBeneficiary
ShortPatient payments for services/products. Ex: co-payment
38. Coverage.costToBeneficiary.type
ShortCost category. This value set includes sample Coverage Copayment Type codes.
40. Coverage.costToBeneficiary.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Coverage.costToBeneficiary.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 42. Coverage.costToBeneficiary.value[x]:valueQuantity
    Slice NamevalueQuantity
    Control0..1
    TypeQuantity(SimpleQuantity)
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    44. Coverage.costToBeneficiary.value[x]:valueMoney
    Slice NamevalueMoney
    ShortMoney value to be paid by the beneficiary
    Control0..1
    TypeMoney
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    46. Coverage.subrogation
    ShortIndicates whether this plan is just for other insurers to recover changes from, for example auto, home or workers compensation

    Guidance on how to interpret the contents of this table can be found here

    0. Coverage
    Definition

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

    ShortInsurance or medical plan or a payment agreement
    Comments

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

    Control0..*
    Is Modifierfalse
    Summaryfalse
    Invariantsdom-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.id
    Definition

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

    ShortA unique id for the coverage resource that will be used for referencing within the bundle message.Logical id of this artifact
    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.

    Control10..1
    Typeidstring
    Is Modifierfalse
    Summarytrue
    4. Coverage.meta
    Definition

    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.

    ShortThe metadata about a resource.Metadata about the resource
    Control10..1
    TypeMeta
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. Coverage.meta.profile
    Definition

    A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

    ShortProfiles this resource claims to conform to
    Comments

    It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

    Control10..*
    Typecanonical(StructureDefinition)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. 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.

    ShortA set of rules under which this content was created
    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.

    Control0..1
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. 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).

    ShortExtensions that cannot be ignored
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    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
    Invariantsele-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.identifier
    Definition

    A unique identifier assigned to this coverage.

    ShortA unique id for the coverage resource that will be used for referencing within the bundle message.Business Identifier for the coverage
    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.

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows coverages to be distinguished and referenced.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Coverage.status
    Definition

    The status of the resource instance.

    ShortThe status of the resource instance.active | cancelled | draft | entered-in-error
    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.

    Control1..1
    BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

    A code specifying the state of the resource instance.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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'.

    Pattern Valueactive
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. 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.

    ShortCoverage category such as medical or accident
    Control10..1
    BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type
    (preferred to http://hl7.org/fhir/ValueSet/coverage-type)

    The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Coverage.policyHolder
    Definition

    The party who 'owns' the insurance policy.

    ShortOwner of the policy. The patient
    Comments

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

    Control0..1
    TypeReference(SHAPatient, Organization, Patient, RelatedPerson)
    Is Modifierfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. 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.

    ShortSubscriber to the policy. A reference to the patient resource. The patient
    Comments

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

    Control0..1
    TypeReference(SHAPatient, Patient, RelatedPerson)
    Is Modifierfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Coverage.subscriberId
    Definition

    The insurer assigned ID for the Subscriber.

    ShortID assigned to the subscriber. The policy subscriber ID from the insurance company. SHA Number
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Coverage.beneficiary
    Definition

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

    ShortThe party who is the subject of care and whose healthcare costs may be covered under the insurance policy. The PatientPlan beneficiary
    Control1..1
    TypeReference(Patient)
    Is Modifierfalse
    Summarytrue
    Requirements

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

    Pattern Value{
      "reference" : "Patient/SHAPatientExample"
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Coverage.dependent
    Definition

    A unique identifier for a dependent under the coverage.

    ShortDependent number issued by an insurer to distinguish between multiple parties covered under the subscriber's policy.
    Comments

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

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Coverage.relationship
    Definition

    The relationship of beneficiary (patient) to the subscriber.

    ShortThe relationship of the beneficiary to the subscriber eg SelfBeneficiary relationship to the subscriber
    Comments

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

    Control10..1
    BindingUnless not suitable, these codes SHALL be taken from SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationship
    (extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship)

    The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. 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.

    ShortTime 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 forceCoverage start and end dates
    Control0..1
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Requirements

    Some insurers require the submission of the coverage term.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Coverage.payor
    Definition

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

    ShortIssuer of the policy. A reference to the insurance company
    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.

    Control1..1*
    TypeReference(Organization, Patient, RelatedPerson)
    Is Modifierfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Coverage.class
    Definition

    A suite of underwriter specific classifiers.

    ShortAdditional coverage classifications. Plan and group
    Comments

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

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. 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).

    ShortExtensions that cannot be ignored even if unrecognized
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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, modifiers
    Invariantsele-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.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.

    ShortType of class such as 'group' or 'plan'
    Control1..1
    BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class
    (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

    The policy classifications, eg. Group, Plan, Class, etc.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    The insurer issued label for a specific health card value.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Coverage.class.value
    Definition

    The alphanumeric string value associated with the insurer issued label.

    ShortValue associated with the type. Group ID
    Comments

    For example, the Group or Plan number.

    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Coverage.class.name
    Definition

    A short description for the class.

    ShortValue associated with the type. Group display nameHuman readable description of the type and value
    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. 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.

    ShortPatient payments for services/products. Ex: co-payment
    Comments

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

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    Required by providers to manage financial transaction with the patient.

    Alternate NamesCoPay, Deductible, Exceptions
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. 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).

    ShortExtensions that cannot be ignored even if unrecognized
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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, modifiers
    Invariantsele-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.costToBeneficiary.type
    Definition

    The category of patient centric costs associated with treatment.

    ShortCost category. This value set includes sample Coverage Copayment Type codes.
    Comments

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

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from CoverageCopayTypeCodeshttp://hl7.org/fhir/ValueSet/coverage-copay-type
    (extensible to http://hl7.org/fhir/ValueSet/coverage-copay-type)

    The types of services to which patient copayments are specified.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. Coverage.costToBeneficiary.value[x]
    Definition

    The amount due from the patient for the cost category.

    ShortThe amount or percentage due from the beneficiary
    Comments

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

    Control1..1
    TypeChoice of: Quantity(SimpleQuantity), Money
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summarytrue
    Requirements

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

    Invariantsele-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.costToBeneficiary.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • type @ $this
    • 52. Coverage.costToBeneficiary.value[x]:valueQuantity
      Slice NamevalueQuantity
      Definition

      The amount due from the patient for the cost category.

      ShortThe amount or percentage due from the beneficiary
      Comments

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

      Control01..1
      TypeQuantity(SimpleQuantity), Money
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. Coverage.costToBeneficiary.value[x]:valueMoney
      Slice NamevalueMoney
      Definition

      The amount due from the patient for the cost category.

      ShortMoney value to be paid by the beneficiaryThe amount or percentage due from the beneficiary
      Comments

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

      Control01..1
      TypeMoney, Quantity(SimpleQuantity)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. 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.

      ShortIndicates whether this plan is just for other insurers to recover changes from, for example auto, home or workers compensationReimbursement to insurer
      Comments

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

      Control0..1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Requirements

      See definition for when to be used.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be found here

      0. Coverage
      Definition

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

      ShortInsurance or medical plan or a payment agreement
      Comments

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

      Control0..*
      Is Modifierfalse
      Summaryfalse
      Invariantsdom-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.id
      Definition

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

      ShortA unique id for the coverage resource that will be used for referencing within the bundle message.
      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.

      Control1..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. Coverage.meta
      Definition

      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.

      ShortThe metadata about a resource.
      Control1..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Coverage.meta.id
      Definition

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

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      8. Coverage.meta.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.

      ShortAdditional content defined by implementations
      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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. Coverage.meta.versionId
        Definition

        The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

        ShortVersion specific identifier
        Comments

        The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

        Control0..1
        Typeid
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. Coverage.meta.lastUpdated
        Definition

        When the resource last changed - e.g. when the version changed.

        ShortWhen the resource version last changed
        Comments

        This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

        Control0..1
        Typeinstant
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        14. Coverage.meta.source
        Definition

        A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

        ShortIdentifies where the resource comes from
        Comments

        In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

        This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

        Control0..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. Coverage.meta.profile
        Definition

        A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

        ShortProfiles this resource claims to conform to
        Comments

        It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

        Control1..*
        Typecanonical(StructureDefinition)
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. Coverage.meta.security
        Definition

        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

        ShortSecurity Labels applied to this resource
        Comments

        The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from All Security Labels
        (extensible to http://hl7.org/fhir/ValueSet/security-labels)

        Security Labels from the Healthcare Privacy and Security Classification System.

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. Coverage.meta.tag
        Definition

        Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

        ShortTags applied to this resource
        Comments

        The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingFor example codes, see CommonTags
        (example to http://hl7.org/fhir/ValueSet/common-tags)

        Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. 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.

        ShortA set of rules under which this content was created
        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.

        Control0..1
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. Coverage.language
        Definition

        The base language in which the resource is written.

        ShortLanguage of the resource content
        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).

        Control0..1
        BindingThe codes SHOULD be taken from CommonLanguages
        (preferred to http://hl7.org/fhir/ValueSet/languages)

        A human language.

        Additional BindingsPurpose
        AllLanguagesMax Binding
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. 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.

        ShortText summary of the resource, for human interpretation
        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.

        Control0..1
        TypeNarrative
        Is Modifierfalse
        Summaryfalse
        Alternate Namesnarrative, html, xhtml, display
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. 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.

        ShortContained, inline 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.

        Control0..*
        TypeResource
        Is Modifierfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        30. Coverage.extension
        Definition

        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.

        ShortAdditional content defined by implementations
        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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.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).

        ShortExtensions that cannot be ignored
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        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
        Invariantsele-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.identifier
        Definition

        A unique identifier assigned to this coverage.

        ShortA unique id for the coverage resource that will be used for referencing within the bundle message.
        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.

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..*
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows coverages to be distinguished and referenced.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Coverage.status
        Definition

        The status of the resource instance.

        ShortThe status of the resource instance.
        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.

        Control1..1
        BindingThe codes SHALL be taken from FinancialResourceStatusCodes
        (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

        A code specifying the state of the resource instance.

        Typecode
        Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        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'.

        Pattern Valueactive
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. 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.

        ShortCoverage category such as medical or accident
        Control1..1
        BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodes
        (preferred to http://hl7.org/fhir/ValueSet/coverage-type)

        The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. Coverage.policyHolder
        Definition

        The party who 'owns' the insurance policy.

        ShortOwner of the policy. The patient
        Comments

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

        Control0..1
        TypeReference(SHAPatient, Organization)
        Is Modifierfalse
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. 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.

        ShortSubscriber to the policy. A reference to the patient resource. The patient
        Comments

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

        Control0..1
        TypeReference(SHAPatient)
        Is Modifierfalse
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Coverage.subscriberId
        Definition

        The insurer assigned ID for the Subscriber.

        ShortID assigned to the subscriber. The policy subscriber ID from the insurance company. SHA Number
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. Coverage.beneficiary
        Definition

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

        ShortThe party who is the subject of care and whose healthcare costs may be covered under the insurance policy. The Patient
        Control1..1
        TypeReference(Patient)
        Is Modifierfalse
        Summarytrue
        Requirements

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

        Pattern Value{
          "reference" : "Patient/SHAPatientExample"
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. Coverage.dependent
        Definition

        A unique identifier for a dependent under the coverage.

        ShortDependent number issued by an insurer to distinguish between multiple parties covered under the subscriber's policy.
        Comments

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

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. Coverage.relationship
        Definition

        The relationship of beneficiary (patient) to the subscriber.

        ShortThe relationship of the beneficiary to the subscriber eg Self
        Comments

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

        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from SubscriberRelationshipCodes
        (extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship)

        The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. 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.

        ShortTime 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
        Control0..1
        TypePeriod
        Is Modifierfalse
        Summarytrue
        Requirements

        Some insurers require the submission of the coverage term.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Coverage.payor
        Definition

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

        ShortIssuer of the policy. A reference to the insurance company
        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.

        Control1..1
        TypeReference(Organization, Patient, RelatedPerson)
        Is Modifierfalse
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. Coverage.class
        Definition

        A suite of underwriter specific classifiers.

        ShortAdditional coverage classifications. Plan and group
        Comments

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

        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. 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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        60. 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.

        ShortAdditional content defined by implementations
        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        62. 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).

        ShortExtensions that cannot be ignored even if unrecognized
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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, modifiers
        Invariantsele-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.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.

        ShortType of class such as 'group' or 'plan'
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodes
        (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

        The policy classifications, eg. Group, Plan, Class, etc.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Requirements

        The insurer issued label for a specific health card value.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. Coverage.class.value
        Definition

        The alphanumeric string value associated with the insurer issued label.

        ShortValue associated with the type. Group ID
        Comments

        For example, the Group or Plan number.

        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        68. Coverage.class.name
        Definition

        A short description for the class.

        ShortValue associated with the type. Group display name
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. 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.

        ShortRelative order of the coverage
        Control0..1
        TypepositiveInt
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Used in managing the coordination of benefits.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        72. 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.

        ShortInsurer network
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Used in referral for treatment and in claims processing.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. 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.

        ShortPatient payments for services/products. Ex: co-payment
        Comments

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

        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Requirements

        Required by providers to manage financial transaction with the patient.

        Alternate NamesCoPay, Deductible, Exceptions
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        76. 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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        78. 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.

        ShortAdditional content defined by implementations
        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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.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).

        ShortExtensions that cannot be ignored even if unrecognized
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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, modifiers
        Invariantsele-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.costToBeneficiary.type
        Definition

        The category of patient centric costs associated with treatment.

        ShortCost category. This value set includes sample Coverage Copayment Type codes.
        Comments

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

        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from CoverageCopayTypeCodes
        (extensible to http://hl7.org/fhir/ValueSet/coverage-copay-type)

        The types of services to which patient copayments are specified.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. Coverage.costToBeneficiary.value[x]
        Definition

        The amount due from the patient for the cost category.

        ShortThe amount or percentage due from the beneficiary
        Comments

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

        Control1..1
        TypeChoice of: Quantity(SimpleQuantity), Money
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Summarytrue
        Requirements

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

        Invariantsele-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.costToBeneficiary.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
        • type @ $this
        • 86. Coverage.costToBeneficiary.value[x]:valueQuantity
          Slice NamevalueQuantity
          Definition

          The amount due from the patient for the cost category.

          ShortThe amount or percentage due from the beneficiary
          Comments

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

          Control0..1
          TypeQuantity(SimpleQuantity)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          88. Coverage.costToBeneficiary.value[x]:valueMoney
          Slice NamevalueMoney
          Definition

          The amount due from the patient for the cost category.

          ShortMoney value to be paid by the beneficiary
          Comments

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

          Control0..1
          TypeMoney
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          90. Coverage.costToBeneficiary.exception
          Definition

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

          ShortExceptions for patient payments
          Control0..*
          TypeBackboneElement
          Is Modifierfalse
          Summaryfalse
          Requirements

          Required by providers to manage financial transaction with the patient.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          92. 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.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          94. 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.

          ShortAdditional content defined by implementations
          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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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.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).

          ShortExtensions that cannot be ignored even if unrecognized
          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.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          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, modifiers
          Invariantsele-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.costToBeneficiary.exception.type
          Definition

          The code for the specific exception.

          ShortException category
          Control1..1
          BindingFor example codes, see ExampleCoverageFinancialExceptionCodes
          (example to http://hl7.org/fhir/ValueSet/coverage-financial-exception)

          The types of exceptions from the part or full value of financial obligations such as copays.

          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          100. Coverage.costToBeneficiary.exception.period
          Definition

          The timeframe during when the exception is in force.

          ShortThe effective period of the exception
          Control0..1
          TypePeriod
          Is Modifierfalse
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          102. 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.

          ShortIndicates whether this plan is just for other insurers to recover changes from, for example auto, home or workers compensation
          Comments

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

          Control0..1
          Typeboolean
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Requirements

          See definition for when to be used.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          104. Coverage.contract
          Definition

          The policy(s) which constitute this insurance coverage.

          ShortContract details
          Control0..*
          TypeReference(Contract)
          Is Modifierfalse
          Summaryfalse
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))