Consumer Real-Time Pharmacy Benefit Check FHIR IG
2.0.0-ballot - STU 2 Ballot United States of America flag

Consumer Real-Time Pharmacy Benefit Check FHIR IG, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-rtpbc/ and changes regularly. See the Directory of published versions

Resource Profile: RTPBC Coverage - Non-PHI - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the rtpbc-coverage-non-phi resource profile

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

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())
us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present (identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists())
2. 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()))
4. 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())
6. Coverage.identifier
Definition

A unique identifier assigned to this coverage.

ShortMember ID and other identifiersBusiness 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)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
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()))
SlicingThis element introduces a set of slices on Coverage.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ type
  • 8. Coverage.identifier:memberid
    Slice Namememberid
    Definition

    A unique identifier assigned to this coverage.

    ShortMember IDBusiness 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)
    Control0..1*
    This element is affected by the following invariants: us-core-15
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    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()))
    10. Coverage.identifier:memberid.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Coverage.identifier:memberid.type
    Definition

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    ShortMember Number identifier typeDescription of identifier
    Comments

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Control10..1
    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows users to make use of identifiers when the identifier system is not known.

    Pattern Value{
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "MB"
      }]
    }
    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.

    Shortactive | cancelled | draft | entered-in-error
    Comments

    The Coverage.status alone does not indicate whether an individual's coverage is terminated or that the individual is not covered. The Coverage.period needs to be considered as well.


    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
    Must Supporttrue
    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'.

    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
    Comments

    Identifies if the coverage is PPO, HMO, POS, etc.

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Payer Type .http://hl7.org/fhir/ValueSet/coverage-type|4.0.1
    (extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591)

    US Public Health Data Consortium Source of Payment Codes


    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
    Must Supporttrue
    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.subscriberId
    Definition

    No personally-identifiable information is included in this profile. Instead, the patient element is populated with a Data Absent Reason = 'masked'


    The insurer assigned ID for the Subscriber.

    ShortSubscriber ID (masked)ID assigned to the subscriber
    Comments

    The identifier assigned by the Payer on the subscriber's ID card

    Control0..1
    This element is affected by the following invariants: us-core-15
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

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

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

    ShortExtensionAdditional 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.

    Control10..*
    TypeExtension
    Is Modifierfalse
    Must Supporttrue
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Coverage.subscriberId.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 22. Coverage.subscriberId.extension:data-masked
      Slice Namedata-masked
      Definition

      Provides a reason why the expected value or elements in the element that is extended are missing.

      Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
      Control1..1
      TypeExtension(Data Absent Reason) (Extension Type: code)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      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())
      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.subscriberId.extension:data-masked.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.

      ShortExtensionAdditional 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..0*
      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())
      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.subscriberId.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 26. Coverage.subscriberId.extension:data-masked.url
        Definition

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

        Shortidentifies the meaning of the extension
        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.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/data-absent-reason
        28. Coverage.subscriberId.extension:data-masked.value[x]
        Definition

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


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

        ShortValue of extension
        Control10..1
        This element is affected by the following invariants: ext-1
        BindingThe codes SHALL be taken from For codes, see DataAbsentReason
        (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
        Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Fixed Valuemasked
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. Coverage.beneficiary
        Definition

        No personally-identifiable information is included in this profile. Instead, the patient element is populated with a Data Absent Reason = 'masked'


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

        ShortPatient information (masked)Plan beneficiary
        Comments

        Identifier for a member assigned by the Payer.

        Control1..1
        TypeReference(US Core Patient Profile, Patient)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

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

        LabelPatient information (masked)
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. Coverage.beneficiary.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.

        ShortExtensionAdditional 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.

        Control10..*
        TypeExtension
        Is Modifierfalse
        Must Supporttrue
        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.beneficiary.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 34. Coverage.beneficiary.extension:data-masked
          Slice Namedata-masked
          Definition

          Provides a reason why the expected value or elements in the element that is extended are missing.

          Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
          Control1..1
          TypeExtension(Data Absent Reason) (Extension Type: code)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          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())
          36. Coverage.beneficiary.extension:data-masked.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.

          ShortExtensionAdditional 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..0*
          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())
          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.beneficiary.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 38. Coverage.beneficiary.extension:data-masked.url
            Definition

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

            Shortidentifies the meaning of the extension
            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.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/data-absent-reason
            40. Coverage.beneficiary.extension:data-masked.value[x]
            Definition

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


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

            ShortValue of extension
            Control10..1
            This element is affected by the following invariants: ext-1
            BindingThe codes SHALL be taken from For codes, see DataAbsentReason
            (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
            Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Fixed Valuemasked
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            42. Coverage.beneficiary.reference
            Definition

            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

            ShortLiteral reference, Relative, internal or absolute URL
            Comments

            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

            Control0..01
            This element is affected by the following invariants: ref-1
            Typestring
            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()))
            44. Coverage.beneficiary.type
            Definition

            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

            ShortType the reference refers to (e.g. "Patient")
            Comments

            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

            Control0..01
            BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
            (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

            Aa resource (or, for logical models, the URI of the logical model).

            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()))
            46. Coverage.beneficiary.identifier
            Definition

            A unique, non-personally identifiable code such as an anonymous account identifier


            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

            ShortUnique, non-personally identifiable codeLogical reference, when literal reference is not known
            Comments

            The beneficiary.identifier element in this profile is limited to only non-personally-identifiable codes, such as an account or user ID assigned during an anonymous interaction with the server.


            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            TypeIdentifier
            Is Modifierfalse
            Summarytrue
            LabelUnique, non-personally identifiable code
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. Coverage.beneficiary.display
            Definition

            Plain text narrative that identifies the resource in addition to the resource reference.

            ShortText alternative for the resource
            Comments

            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

            Control0..01
            Typestring
            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()))
            50. Coverage.relationship
            Definition

            The relationship of beneficiary (patient) to the subscriber.

            ShortBeneficiary relationship to the subscriber
            Comments

            In this non-PHI Coverage profile, always 'self'


            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|4.0.1
            (extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            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.

            ShortCoverage start and end dates
            Comments

            Date that the contract became effective and Date that the contract was terminated or coverage changed.

            Control0..1
            TypePeriod
            Is Modifierfalse
            Must Supporttrue
            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
            Comments

            Issuer of the Policy


            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(US Core Organization Profile, US Core Patient Profile, US Core RelatedPerson Profile, Organization, Patient, RelatedPerson)
            Is Modifierfalse
            Must Supporttrue
            Must Support TypesReference(US Core Organization Profile)
            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.payor.identifier
            Definition

            Payer ID as defined in the participants' environment. E.g., an identifier defined in an eligibility service to represent the payer.


            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

            ShortPayer IDLogical reference, when literal reference is not known
            Comments

            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            LabelPayer ID
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. Coverage.payor.identifier.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control0..1
            BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
            (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

            Identifies the purpose for this identifier, if known .

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

            ShortPayer ID ValueThe value that is unique
            Comments

            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

            Control10..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            LabelPayer ID Value
            ExampleGeneral: 123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. Coverage.class
            Definition

            Identifiers used by the payer/PBM to located the patient's coverage. IIN (BIN) number, Processor Control Number (PCN), pharmacy benefit Group ID and patient's PBM Member ID.


            A suite of underwriter specific classifiers.

            ShortPharmacy coverage identifiersAdditional coverage classifications
            Comments

            Populate with identifiers retrieved from an eligibility service or other source agreed between trading partners


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

            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

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

            LabelPharmacy coverage identifiers
            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.class. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ type
            • 64. 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())
              66. 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|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

              Coverage Class Codes


              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()))
              68. Coverage.class.value
              Definition

              The alphanumeric string value associated with the insurer issued label.

              ShortValue associated with the type
              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()))
              70. Coverage.class:group
              Slice Namegroup
              Definition

              A suite of underwriter specific classifiers.

              ShortGroupAdditional coverage classifications
              Comments

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

              Control0..1*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              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()))
              72. Coverage.class:group.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())
              74. Coverage.class:group.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|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/coverage-class|4.0.1)

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

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              The insurer issued label for a specific health card value.

              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code" : "group"
                }]
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              76. Coverage.class:group.value
              Definition

              The alphanumeric string value associated with the insurer issued label.

              ShortGroup IdentifierValue associated with the type
              Comments

              Employer account identifier


              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
              Must Supporttrue
              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()))
              78. Coverage.class:plan
              Slice Nameplan
              Definition

              A suite of underwriter specific classifiers.

              ShortPlanAdditional coverage classifications
              Comments

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

              Control0..1*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              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()))
              80. Coverage.class:plan.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.class:plan.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|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/coverage-class|4.0.1)

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

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              The insurer issued label for a specific health card value.

              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code" : "plan"
                }]
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              84. Coverage.class:plan.value
              Definition

              The alphanumeric string value associated with the insurer issued label.

              ShortPlan NumberValue associated with the type
              Comments

              Business concept used by a health plan to describe its benefit offerings


              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
              Must Supporttrue
              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()))
              86. Coverage.class:plan.name
              Definition

              A short description for the class.

              ShortPlan NameHuman readable description of the type and value
              Comments

              Name of the health plan benefit offering assigned to the Plan Identifier

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              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()))
              88. Coverage.class:bin
              Slice Namebin
              Definition

              A suite of underwriter specific classifiers.

              ShortIIN (BIN) numberAdditional coverage classifications
              Comments

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

              Control0..1*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Requirements

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

              LabelIIN (BIN) number
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              90. Coverage.class:bin.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())
              92. Coverage.class:bin.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|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

              Coverage Class Codes


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

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              The insurer issued label for a specific health card value.

              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code" : "rxbin"
                }]
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              94. Coverage.class:bin.value
              Definition

              The alphanumeric string value associated with the insurer issued label.

              ShortValue associated with the type
              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()))
              96. Coverage.class:pcn
              Slice Namepcn
              Definition

              A suite of underwriter specific classifiers.

              ShortProcessor Control Number (PCN)Additional coverage classifications
              Comments

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

              Control0..1*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Requirements

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

              LabelProcessor Control Number (PCN)
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              98. Coverage.class:pcn.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())
              100. Coverage.class:pcn.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|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

              Coverage Class Codes


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

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              The insurer issued label for a specific health card value.

              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code" : "rxpcn"
                }]
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              102. Coverage.class:pcn.value
              Definition

              The alphanumeric string value associated with the insurer issued label.

              ShortValue associated with the type
              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()))
              104. Coverage.class:rxgroup-id
              Slice Namerxgroup-id
              Definition

              A suite of underwriter specific classifiers.

              ShortPharmacy Benefit Group IDAdditional coverage classifications
              Comments

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

              Control0..1*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Requirements

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

              LabelPharmacy Benefit Group ID
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              106. Coverage.class:rxgroup-id.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())
              108. Coverage.class:rxgroup-id.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|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

              Coverage Class Codes


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

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              The insurer issued label for a specific health card value.

              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code" : "rxgroup"
                }]
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              110. Coverage.class:rxgroup-id.value
              Definition

              The alphanumeric string value associated with the insurer issued label.

              ShortValue associated with the type
              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()))
              112. Coverage.class:member-id
              Slice Namemember-id
              Definition

              A suite of underwriter specific classifiers.

              ShortPBM Member IDAdditional coverage classifications
              Comments

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

              Control0..1*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Requirements

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

              LabelPBM Member ID
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              114. Coverage.class:member-id.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())
              116. Coverage.class:member-id.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|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

              Coverage Class Codes


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

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              The insurer issued label for a specific health card value.

              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code" : "rxid"
                }]
              }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              118. Coverage.class:member-id.value
              Definition

              The alphanumeric string value associated with the insurer issued label.

              ShortValue associated with the type
              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()))

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

              0. Coverage
              2. Coverage.subscriberId
              Definition

              No personally-identifiable information is included in this profile. Instead, the patient element is populated with a Data Absent Reason = 'masked'

              ShortSubscriber ID (masked)
              LabelSubscriber ID (masked)
              4. Coverage.subscriberId.extension
              Control1..?
              Must Supporttrue
              SlicingThis element introduces a set of slices on Coverage.subscriberId.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 6. Coverage.subscriberId.extension:data-masked
                Slice Namedata-masked
                Control1..1
                TypeExtension(Data Absent Reason) (Extension Type: code)
                Must Supporttrue
                8. Coverage.subscriberId.extension:data-masked.value[x]
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Fixed Valuemasked
                10. Coverage.beneficiary
                Definition

                No personally-identifiable information is included in this profile. Instead, the patient element is populated with a Data Absent Reason = 'masked'

                ShortPatient information (masked)
                LabelPatient information (masked)
                12. Coverage.beneficiary.extension
                Control1..?
                Must Supporttrue
                14. Coverage.beneficiary.extension:data-masked
                Slice Namedata-masked
                Control1..1
                TypeExtension(Data Absent Reason) (Extension Type: code)
                Must Supporttrue
                16. Coverage.beneficiary.extension:data-masked.value[x]
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Fixed Valuemasked
                18. Coverage.beneficiary.reference
                Control0..0
                20. Coverage.beneficiary.type
                Control0..0
                22. Coverage.beneficiary.identifier
                Definition

                A unique, non-personally identifiable code such as an anonymous account identifier

                ShortUnique, non-personally identifiable code
                Comments

                The beneficiary.identifier element in this profile is limited to only non-personally-identifiable codes, such as an account or user ID assigned during an anonymous interaction with the server.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                LabelUnique, non-personally identifiable code
                24. Coverage.beneficiary.display
                Control0..0
                26. Coverage.relationship
                Comments

                In this non-PHI Coverage profile, always 'self'

                28. Coverage.relationship.coding
                30. Coverage.relationship.coding.system
                Fixed Valuehttp://terminology.hl7.org/CodeSystem/subscriber-relationship
                32. Coverage.relationship.coding.code
                Fixed Valueself
                34. Coverage.payor
                36. Coverage.payor.identifier
                Definition

                Payer ID as defined in the participants' environment. E.g., an identifier defined in an eligibility service to represent the payer.

                ShortPayer ID
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Must Supporttrue
                LabelPayer ID
                38. Coverage.payor.identifier.value
                ShortPayer ID Value
                Control1..?
                Must Supporttrue
                LabelPayer ID Value
                40. Coverage.class
                Definition

                Identifiers used by the payer/PBM to located the patient's coverage. IIN (BIN) number, Processor Control Number (PCN), pharmacy benefit Group ID and patient's PBM Member ID.

                ShortPharmacy coverage identifiers
                Comments

                Populate with identifiers retrieved from an eligibility service or other source agreed between trading partners

                LabelPharmacy coverage identifiers
                SlicingThis element introduces a set of slices on Coverage.class. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ type
                • 42. Coverage.class.type
                  BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodes
                  (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

                  Coverage Class Codes

                  44. Coverage.class:bin
                  Slice Namebin
                  ShortIIN (BIN) number
                  Control0..1
                  Must Supporttrue
                  LabelIIN (BIN) number
                  46. Coverage.class:bin.type
                  Pattern Value{
                    "coding" : [{
                      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                      "code" : "rxbin"
                    }]
                  }
                  48. Coverage.class:pcn
                  Slice Namepcn
                  ShortProcessor Control Number (PCN)
                  Control0..1
                  Must Supporttrue
                  LabelProcessor Control Number (PCN)
                  50. Coverage.class:pcn.type
                  Pattern Value{
                    "coding" : [{
                      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                      "code" : "rxpcn"
                    }]
                  }
                  52. Coverage.class:rxgroup-id
                  Slice Namerxgroup-id
                  ShortPharmacy Benefit Group ID
                  Control0..1
                  Must Supporttrue
                  LabelPharmacy Benefit Group ID
                  54. Coverage.class:rxgroup-id.type
                  Pattern Value{
                    "coding" : [{
                      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                      "code" : "rxgroup"
                    }]
                  }
                  56. Coverage.class:member-id
                  Slice Namemember-id
                  ShortPBM Member ID
                  Control0..1
                  Must Supporttrue
                  LabelPBM Member ID
                  58. Coverage.class:member-id.type
                  Pattern Value{
                    "coding" : [{
                      "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                      "code" : "rxid"
                    }]
                  }

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

                  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())
                  us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present (identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.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.

                  ShortLogical 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.

                  Control0..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.

                  ShortMetadata about the resource
                  Control0..1
                  TypeMeta
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  6. 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()))
                  8. 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|4.0.1)

                  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()))
                  10. 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()))
                  12. 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
                  14. 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())
                  16. 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())
                  18. Coverage.identifier
                  Definition

                  A unique identifier assigned to this coverage.

                  ShortMember ID and other identifiers
                  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)
                  Control0..*
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  SlicingThis element introduces a set of slices on Coverage.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ type
                  • 20. Coverage.identifier:memberid
                    Slice Namememberid
                    Definition

                    A unique identifier assigned to this coverage.

                    ShortMember ID
                    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)
                    Control0..1
                    This element is affected by the following invariants: us-core-15
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supporttrue
                    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()))
                    22. Coverage.identifier:memberid.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
                    24. Coverage.identifier:memberid.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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 26. Coverage.identifier:memberid.use
                      Definition

                      The purpose of this identifier.

                      Shortusual | official | temp | secondary | old (If known)
                      Comments

                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUse
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                      Identifies the purpose for this identifier, if known .

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

                      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                      ShortMember Number identifier type
                      Comments

                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                      Control1..1
                      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                      (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                      A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Allows users to make use of identifiers when the identifier system is not known.

                      Pattern Value{
                        "coding" : [{
                          "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                          "code" : "MB"
                        }]
                      }
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      30. Coverage.identifier:memberid.system
                      Definition

                      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                      ShortThe namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

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

                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                      ExampleGeneral: http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      32. Coverage.identifier:memberid.value
                      Definition

                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                      ShortThe value that is unique
                      Comments

                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      ExampleGeneral: 123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      34. Coverage.identifier:memberid.period
                      Definition

                      Time period during which identifier is/was valid for use.

                      ShortTime period when id is/was valid for use
                      Control0..1
                      TypePeriod
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      36. Coverage.identifier:memberid.assigner
                      Definition

                      Organization that issued/manages the identifier.

                      ShortOrganization that issued id (may be just text)
                      Comments

                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                      Control0..1
                      TypeReference(Organization)
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      38. Coverage.status
                      Definition

                      The status of the resource instance.

                      Shortactive | cancelled | draft | entered-in-error
                      Comments

                      The Coverage.status alone does not indicate whether an individual's coverage is terminated or that the individual is not covered. The Coverage.period needs to be considered as well.

                      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
                      Must Supporttrue
                      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'.

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

                      Identifies if the coverage is PPO, HMO, POS, etc.

                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from Payer Type .
                      (extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591)

                      US Public Health Data Consortium Source of Payment Codes

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      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()))
                      42. Coverage.policyHolder
                      Definition

                      The party who 'owns' the insurance policy.

                      ShortOwner of the policy
                      Comments

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

                      Control0..1
                      TypeReference(Patient, RelatedPerson, 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()))
                      44. 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
                      Comments

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

                      Control0..1
                      TypeReference(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()))
                      46. Coverage.subscriberId
                      Definition

                      No personally-identifiable information is included in this profile. Instead, the patient element is populated with a Data Absent Reason = 'masked'

                      ShortSubscriber ID (masked)
                      Comments

                      The identifier assigned by the Payer on the subscriber's ID card

                      Control0..1
                      This element is affected by the following invariants: us-core-15
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

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

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

                      unique id for the element within a resource (for internal references)

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      50. Coverage.subscriberId.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control1..*
                      TypeExtension
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      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.subscriberId.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 52. Coverage.subscriberId.extension:data-masked
                        Slice Namedata-masked
                        Definition

                        Provides a reason why the expected value or elements in the element that is extended are missing.

                        Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
                        Control1..1
                        TypeExtension(Data Absent Reason) (Extension Type: code)
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        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())
                        54. Coverage.subscriberId.extension:data-masked.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
                        This element is affected by the following invariants: ele-1
                        Typeid
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        56. Coverage.subscriberId.extension:data-masked.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..0
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        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.subscriberId.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 58. Coverage.subscriberId.extension:data-masked.url
                          Definition

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

                          Shortidentifies the meaning of the extension
                          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.

                          Control1..1
                          Typeuri
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          Fixed Valuehttp://hl7.org/fhir/StructureDefinition/data-absent-reason
                          60. Coverage.subscriberId.extension:data-masked.value[x]
                          Definition

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

                          ShortValue of extension
                          Control1..1
                          This element is affected by the following invariants: ext-1
                          BindingThe codes SHALL be taken from DataAbsentReason
                          (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
                          Typecode
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summaryfalse
                          Fixed Valuemasked
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          62. Coverage.subscriberId.value
                          Definition

                          The actual value

                          ShortPrimitive value for string
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          Max Length:1048576
                          64. Coverage.beneficiary
                          Definition

                          No personally-identifiable information is included in this profile. Instead, the patient element is populated with a Data Absent Reason = 'masked'

                          ShortPatient information (masked)
                          Comments

                          Identifier for a member assigned by the Payer.

                          Control1..1
                          TypeReference(US Core Patient Profile)
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Requirements

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

                          LabelPatient information (masked)
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          66. Coverage.beneficiary.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
                          68. Coverage.beneficiary.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control1..*
                          TypeExtension
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          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.beneficiary.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 70. Coverage.beneficiary.extension:data-masked
                            Slice Namedata-masked
                            Definition

                            Provides a reason why the expected value or elements in the element that is extended are missing.

                            Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
                            Control1..1
                            TypeExtension(Data Absent Reason) (Extension Type: code)
                            Is Modifierfalse
                            Must Supporttrue
                            Summaryfalse
                            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())
                            72. Coverage.beneficiary.extension:data-masked.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
                            This element is affected by the following invariants: ele-1
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            74. Coverage.beneficiary.extension:data-masked.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..0
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            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.beneficiary.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 76. Coverage.beneficiary.extension:data-masked.url
                              Definition

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

                              Shortidentifies the meaning of the extension
                              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.

                              Control1..1
                              Typeuri
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/data-absent-reason
                              78. Coverage.beneficiary.extension:data-masked.value[x]
                              Definition

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

                              ShortValue of extension
                              Control1..1
                              This element is affected by the following invariants: ext-1
                              BindingThe codes SHALL be taken from DataAbsentReason
                              (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
                              Typecode
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Fixed Valuemasked
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              80. Coverage.beneficiary.reference
                              Definition

                              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                              ShortLiteral reference, Relative, internal or absolute URL
                              Comments

                              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                              Control0..0
                              This element is affected by the following invariants: ref-1
                              Typestring
                              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()))
                              82. Coverage.beneficiary.type
                              Definition

                              The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                              The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                              ShortType the reference refers to (e.g. "Patient")
                              Comments

                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                              Control0..0
                              BindingUnless not suitable, these codes SHALL be taken from ResourceType
                              (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                              Aa resource (or, for logical models, the URI of the logical model).

                              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()))
                              84. Coverage.beneficiary.identifier
                              Definition

                              A unique, non-personally identifiable code such as an anonymous account identifier

                              ShortUnique, non-personally identifiable code
                              Comments

                              The beneficiary.identifier element in this profile is limited to only non-personally-identifiable codes, such as an account or user ID assigned during an anonymous interaction with the server.

                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control0..1
                              TypeIdentifier
                              Is Modifierfalse
                              Summarytrue
                              LabelUnique, non-personally identifiable code
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              86. Coverage.beneficiary.display
                              Definition

                              Plain text narrative that identifies the resource in addition to the resource reference.

                              ShortText alternative for the resource
                              Comments

                              This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                              Control0..0
                              Typestring
                              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()))
                              88. Coverage.dependent
                              Definition

                              A unique identifier for a dependent under the coverage.

                              ShortDependent number
                              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()))
                              90. Coverage.relationship
                              Definition

                              The relationship of beneficiary (patient) to the subscriber.

                              ShortBeneficiary relationship to the subscriber
                              Comments

                              In this non-PHI Coverage profile, always 'self'

                              Control1..1
                              BindingUnless not suitable, these codes SHALL be taken from SubscriberRelationshipCodes
                              (extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship)
                              TypeCodeableConcept
                              Is Modifierfalse
                              Must Supporttrue
                              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()))
                              92. Coverage.relationship.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.relationship.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.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 96. Coverage.relationship.coding
                                Definition

                                A reference to a code defined by a terminology system.

                                ShortCode defined by a terminology system
                                Comments

                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                Control0..*
                                TypeCoding
                                Is Modifierfalse
                                Summarytrue
                                Requirements

                                Allows for alternative encodings within a code system, and translations to other code systems.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                98. Coverage.relationship.coding.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
                                100. Coverage.relationship.coding.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.relationship.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 102. Coverage.relationship.coding.system
                                  Definition

                                  The identification of the code system that defines the meaning of the symbol in the code.

                                  ShortIdentity of the terminology system
                                  Comments

                                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

                                  Need to be unambiguous about the source of the definition of the symbol.

                                  Fixed Valuehttp://terminology.hl7.org/CodeSystem/subscriber-relationship
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  104. Coverage.relationship.coding.version
                                  Definition

                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                  ShortVersion of the system - if relevant
                                  Comments

                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                  Control0..1
                                  Typestring
                                  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()))
                                  106. Coverage.relationship.coding.code
                                  Definition

                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                  ShortSymbol in syntax defined by the system
                                  Control0..1
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need to refer to a particular code in the system.

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

                                  A representation of the meaning of the code in the system, following the rules of the system.

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

                                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

                                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                  ShortIf this coding was chosen directly by the user
                                  Comments

                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                  ShortPlain text representation of the concept
                                  Comments

                                  Very often the text is the same as a displayName of one of the codings.

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

                                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

                                  ShortCoverage start and end dates
                                  Comments

                                  Date that the contract became effective and Date that the contract was terminated or coverage changed.

                                  Control0..1
                                  TypePeriod
                                  Is Modifierfalse
                                  Must Supporttrue
                                  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()))
                                  116. 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
                                  Comments

                                  Issuer of the Policy

                                  Control1..1
                                  TypeReference(US Core Organization Profile, US Core Patient Profile, US Core RelatedPerson Profile)
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Must Support TypesReference(US Core Organization Profile)
                                  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()))
                                  118. Coverage.payor.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
                                  120. Coverage.payor.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.payor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 122. Coverage.payor.reference
                                    Definition

                                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                    ShortLiteral reference, Relative, internal or absolute URL
                                    Comments

                                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                    Control0..1
                                    This element is affected by the following invariants: ref-1
                                    Typestring
                                    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()))
                                    124. Coverage.payor.type
                                    Definition

                                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                    ShortType the reference refers to (e.g. "Patient")
                                    Comments

                                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                    Control0..1
                                    BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                    Aa resource (or, for logical models, the URI of the logical model).

                                    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()))
                                    126. Coverage.payor.identifier
                                    Definition

                                    Payer ID as defined in the participants' environment. E.g., an identifier defined in an eligibility service to represent the payer.

                                    ShortPayer ID
                                    Comments

                                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                    Control0..1
                                    TypeIdentifier
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    LabelPayer ID
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    128. Coverage.payor.identifier.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
                                    130. Coverage.payor.identifier.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.payor.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 132. Coverage.payor.identifier.use
                                      Definition

                                      The purpose of this identifier.

                                      Shortusual | official | temp | secondary | old (If known)
                                      Comments

                                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                      Control0..1
                                      BindingThe codes SHALL be taken from IdentifierUse
                                      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                      Identifies the purpose for this identifier, if known .

                                      Typecode
                                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

                                      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                      ShortDescription of identifier
                                      Comments

                                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                      Control0..1
                                      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                      (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                                      A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summarytrue
                                      Requirements

                                      Allows users to make use of identifiers when the identifier system is not known.

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

                                      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                      ShortThe namespace for the identifier value
                                      Comments

                                      Identifier.system is always case sensitive.

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

                                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                      ExampleGeneral: http://www.acme.com/identifiers/patient
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      138. Coverage.payor.identifier.value
                                      Definition

                                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                      ShortPayer ID Value
                                      Comments

                                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                      Control1..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      LabelPayer ID Value
                                      ExampleGeneral: 123456
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      140. Coverage.payor.identifier.period
                                      Definition

                                      Time period during which identifier is/was valid for use.

                                      ShortTime period when id is/was valid for use
                                      Control0..1
                                      TypePeriod
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      142. Coverage.payor.identifier.assigner
                                      Definition

                                      Organization that issued/manages the identifier.

                                      ShortOrganization that issued id (may be just text)
                                      Comments

                                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                      Control0..1
                                      TypeReference(Organization)
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      144. Coverage.payor.display
                                      Definition

                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                      ShortText alternative for the resource
                                      Comments

                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                      Control0..1
                                      Typestring
                                      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()))
                                      146. Coverage.class
                                      Definition

                                      Identifiers used by the payer/PBM to located the patient's coverage. IIN (BIN) number, Processor Control Number (PCN), pharmacy benefit Group ID and patient's PBM Member ID.

                                      ShortPharmacy coverage identifiers
                                      Comments

                                      Populate with identifiers retrieved from an eligibility service or other source agreed between trading partners

                                      Control0..*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      Requirements

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

                                      LabelPharmacy coverage identifiers
                                      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.class. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ type
                                      • 148. 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
                                        150. 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())
                                        152. 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())
                                        154. 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)

                                        Coverage Class Codes

                                        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()))
                                        156. Coverage.class.value
                                        Definition

                                        The alphanumeric string value associated with the insurer issued label.

                                        ShortValue associated with the type
                                        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()))
                                        158. Coverage.class.name
                                        Definition

                                        A short description for the class.

                                        ShortHuman readable description of the type and value
                                        Control0..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()))
                                        160. Coverage.class:group
                                        Slice Namegroup
                                        Definition

                                        A suite of underwriter specific classifiers.

                                        ShortGroup
                                        Comments

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

                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        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()))
                                        162. Coverage.class:group.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
                                        164. Coverage.class:group.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())
                                        166. Coverage.class:group.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())
                                        168. Coverage.class:group.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|4.0.1)

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

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        The insurer issued label for a specific health card value.

                                        Pattern Value{
                                          "coding" : [{
                                            "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                                            "code" : "group"
                                          }]
                                        }
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        170. Coverage.class:group.value
                                        Definition

                                        The alphanumeric string value associated with the insurer issued label.

                                        ShortGroup Identifier
                                        Comments

                                        Employer account identifier

                                        Control1..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        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()))
                                        172. Coverage.class:group.name
                                        Definition

                                        A short description for the class.

                                        ShortHuman readable description of the type and value
                                        Control0..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()))
                                        174. Coverage.class:plan
                                        Slice Nameplan
                                        Definition

                                        A suite of underwriter specific classifiers.

                                        ShortPlan
                                        Comments

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

                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        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()))
                                        176. Coverage.class:plan.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
                                        178. Coverage.class:plan.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())
                                        180. Coverage.class:plan.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())
                                        182. Coverage.class:plan.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|4.0.1)

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

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        The insurer issued label for a specific health card value.

                                        Pattern Value{
                                          "coding" : [{
                                            "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                                            "code" : "plan"
                                          }]
                                        }
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        184. Coverage.class:plan.value
                                        Definition

                                        The alphanumeric string value associated with the insurer issued label.

                                        ShortPlan Number
                                        Comments

                                        Business concept used by a health plan to describe its benefit offerings

                                        Control1..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        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()))
                                        186. Coverage.class:plan.name
                                        Definition

                                        A short description for the class.

                                        ShortPlan Name
                                        Comments

                                        Name of the health plan benefit offering assigned to the Plan Identifier

                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        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()))
                                        188. Coverage.class:bin
                                        Slice Namebin
                                        Definition

                                        A suite of underwriter specific classifiers.

                                        ShortIIN (BIN) number
                                        Comments

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

                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

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

                                        LabelIIN (BIN) number
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        190. Coverage.class:bin.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
                                        192. Coverage.class:bin.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())
                                        194. Coverage.class:bin.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())
                                        196. Coverage.class:bin.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)

                                        Coverage Class Codes

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        The insurer issued label for a specific health card value.

                                        Pattern Value{
                                          "coding" : [{
                                            "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                                            "code" : "rxbin"
                                          }]
                                        }
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        198. Coverage.class:bin.value
                                        Definition

                                        The alphanumeric string value associated with the insurer issued label.

                                        ShortValue associated with the type
                                        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()))
                                        200. Coverage.class:bin.name
                                        Definition

                                        A short description for the class.

                                        ShortHuman readable description of the type and value
                                        Control0..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()))
                                        202. Coverage.class:pcn
                                        Slice Namepcn
                                        Definition

                                        A suite of underwriter specific classifiers.

                                        ShortProcessor Control Number (PCN)
                                        Comments

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

                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

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

                                        LabelProcessor Control Number (PCN)
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        204. Coverage.class:pcn.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
                                        206. Coverage.class:pcn.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())
                                        208. Coverage.class:pcn.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())
                                        210. Coverage.class:pcn.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)

                                        Coverage Class Codes

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        The insurer issued label for a specific health card value.

                                        Pattern Value{
                                          "coding" : [{
                                            "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                                            "code" : "rxpcn"
                                          }]
                                        }
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        212. Coverage.class:pcn.value
                                        Definition

                                        The alphanumeric string value associated with the insurer issued label.

                                        ShortValue associated with the type
                                        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()))
                                        214. Coverage.class:pcn.name
                                        Definition

                                        A short description for the class.

                                        ShortHuman readable description of the type and value
                                        Control0..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()))
                                        216. Coverage.class:rxgroup-id
                                        Slice Namerxgroup-id
                                        Definition

                                        A suite of underwriter specific classifiers.

                                        ShortPharmacy Benefit Group ID
                                        Comments

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

                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

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

                                        LabelPharmacy Benefit Group ID
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        218. Coverage.class:rxgroup-id.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
                                        220. Coverage.class:rxgroup-id.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())
                                        222. Coverage.class:rxgroup-id.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())
                                        224. Coverage.class:rxgroup-id.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)

                                        Coverage Class Codes

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        The insurer issued label for a specific health card value.

                                        Pattern Value{
                                          "coding" : [{
                                            "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                                            "code" : "rxgroup"
                                          }]
                                        }
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        226. Coverage.class:rxgroup-id.value
                                        Definition

                                        The alphanumeric string value associated with the insurer issued label.

                                        ShortValue associated with the type
                                        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()))
                                        228. Coverage.class:rxgroup-id.name
                                        Definition

                                        A short description for the class.

                                        ShortHuman readable description of the type and value
                                        Control0..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()))
                                        230. Coverage.class:member-id
                                        Slice Namemember-id
                                        Definition

                                        A suite of underwriter specific classifiers.

                                        ShortPBM Member ID
                                        Comments

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

                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Requirements

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

                                        LabelPBM Member ID
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        232. Coverage.class:member-id.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
                                        234. Coverage.class:member-id.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())
                                        236. Coverage.class:member-id.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())
                                        238. Coverage.class:member-id.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)

                                        Coverage Class Codes

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        The insurer issued label for a specific health card value.

                                        Pattern Value{
                                          "coding" : [{
                                            "system" : "http://terminology.hl7.org/CodeSystem/coverage-class",
                                            "code" : "rxid"
                                          }]
                                        }
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        240. Coverage.class:member-id.value
                                        Definition

                                        The alphanumeric string value associated with the insurer issued label.

                                        ShortValue associated with the type
                                        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()))
                                        242. Coverage.class:member-id.name
                                        Definition

                                        A short description for the class.

                                        ShortHuman readable description of the type and value
                                        Control0..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()))
                                        244. 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()))
                                        246. 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()))
                                        248. 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
                                        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()))
                                        250. 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
                                        252. 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())
                                        254. 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())
                                        256. Coverage.costToBeneficiary.type
                                        Definition

                                        The category of patient centric costs associated with treatment.

                                        ShortCost category
                                        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|4.0.1)

                                        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()))
                                        258. 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()))
                                        260. 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()))
                                        262. 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
                                        264. 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())
                                        266. 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())
                                        268. 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|4.0.1)

                                        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()))
                                        270. 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()))
                                        272. 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.

                                        ShortReimbursement 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()))
                                        274. 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()))