Skip to content

Coverage Profile

Canonical../StructureDefinition/nexus-emr-core-coverage
Statusdraft (experimental) · 1.26.0
BaseCoverage (constraint)
SourceFSH · JSON

Nexus EMR profile for Coverage -- the payor context for billing and the demo dataset. First pass: the Ontario-GP shape (public plan keyed by the patient's health-card number, payor as a logical Organization reference). Private/extended plans and coordination of benefits are deliberately unmodelled. Closed to SMART apps pending an exposure decision.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Coverage

Short Nexus EMR Coverage Core
Definition Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
Comments The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.
Cardinality 0..*
Invariants dom-2, dom-3, dom-4, dom-5, dom-6

Coverage.id

Short Logical id of this artifact
Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Coverage.meta

Short Metadata about the resource
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.
Cardinality 0..1
Type Meta
Invariants ele-1

Coverage.implicitRules

Short A set of rules under which this content was created
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.
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.
Cardinality 0..1
Type uri
Modifier yes — 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
Invariants ele-1

Coverage.language

Short Language of the resource content
Definition The base language in which the resource is written.
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).
Cardinality 0..1
Type code
Binding languages (preferred)
Invariants ele-1

Coverage.text

Short Text summary of the resource, for human interpretation
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.
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.
Cardinality 0..1
Type Narrative
Invariants ele-1
Also called narrative, html, xhtml, display

Coverage.contained

Short Contained, inline Resources
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.
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.
Cardinality 0..*
Type Resource
Also called inline resources, anonymous resources, contained resources

Coverage.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Coverage.modifierExtension

Short Extensions that cannot be ignored
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).
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.
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.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Invariants ele-1, ext-1
Also called extensions, user content

Coverage.identifier

Short Business Identifier for the coverage
Definition A unique identifier assigned to this coverage.
Requirements Allows coverages to be distinguished and referenced.
Comments The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.
Cardinality 0..*
Type Identifier
Invariants ele-1

Coverage.status

Short active | cancelled | draft | entered-in-error
Definition The status of the resource instance.
Requirements Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
Comments This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.
Cardinality 1..1
Type code
Must Support yes
Modifier yes — 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
Binding fm-status (required)
Invariants ele-1

Coverage.type

Short Kind of coverage (public provincial plan, private, ...)
Definition The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
Requirements The order of application of coverages is dependent on the types of coverage.
Comments First pass leaves the vocabulary open: OHIP rides as text + a payor identifier; a plan-type value set is deferred until a second plan actually flows. Where this code was mapped from a source system's own vocabulary, carry the raw coding alongside the mapped one, flagged userSelected = true. See Carrying the raw code.
Cardinality 0..1
Type CodeableConcept
Must Support yes
Binding coverage-type (preferred)
Invariants ele-1

Coverage.policyHolder

Short Owner of the policy
Definition The party who 'owns' the insurance policy.
Requirements This provides employer information in the case of Worker's Compensation and other policies.
Comments For example: may be an individual, corporation or the subscriber's employer.
Cardinality 0..1
Type Reference(Patient | RelatedPerson | Organization)
Invariants ele-1

Coverage.subscriber

Short Subscriber to the policy
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.
Requirements This is the party who is entitled to the benfits under the policy.
Comments May be self or a parent in the case of dependants.
Cardinality 0..1
Type Reference(Patient | RelatedPerson)
Invariants ele-1

Coverage.subscriberId

Short The patient's identifier with the insurance plan
Definition The identifier the PLAN knows the covered person by. For Ontario's public plan this is the health card number; the same value appears on Patient.identifier under the canadian-phn-systems machinery -- this element carries the value the payor bills against, it does not replace the Patient identifier slice.
Requirements The insurer requires this identifier on correspondance and claims (digital and otherwise).
Comments For OHIP this is the health card number.
Cardinality 0..1
Type string
Must Support yes
Invariants ele-1

Coverage.beneficiary

Short The patient covered
Definition The party who benefits from the insurance coverage; the patient when products and/or services are provided.
Requirements This is the party who receives treatment for which the costs are reimbursed under the coverage.
Cardinality 1..1
Type Reference(Patient Profile)
Must Support yes
Invariants ele-1

Coverage.dependent

Short Dependent number
Definition A unique identifier for a dependent under the coverage.
Requirements For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.
Comments Periodically the member number is constructed from the subscriberId and the dependant number.
Cardinality 0..1
Type string
Invariants ele-1

Coverage.relationship

Short Beneficiary relationship to the subscriber
Definition The relationship of beneficiary (patient) to the subscriber.
Requirements To determine relationship between the patient and the subscriber to determine coordination of benefits.
Comments Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.
Cardinality 0..1
Type CodeableConcept
Binding subscriber-relationship (extensible)
Invariants ele-1

Coverage.period

Short Coverage validity period, when the source records one
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.
Requirements Some insurers require the submission of the coverage term.
Cardinality 0..1
Type Period
Must Support yes
Invariants ele-1

Coverage.payor

Short Who pays -- typically a LOGICAL Organization reference (e.g. OHIP)
Definition The payor organization. A logical reference (Reference.identifier naming the plan authority, display carrying the human-readable name) is the expected first-pass shape -- provincial payors are not resources the EMR maintains.
Requirements Need to identify the issuer to target for claim processing and for coordination of benefit processing.
Comments May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.
Cardinality 1..*
Type Reference(Organization | Patient | RelatedPerson)
Must Support yes
Invariants ele-1

Coverage.class

Short Additional coverage classifications
Definition A suite of underwriter specific classifiers.
Requirements The codes provided on the health card which identify or confirm the specific policy for the insurer.
Comments For example may be used to identify a class of coverage or employer group, Policy, Plan.
Cardinality 0..*
Type BackboneElement
Invariants ele-1

Coverage.class.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Coverage.class.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Coverage.class.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
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).
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.
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.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

Coverage.class.type

Short Type of class such as 'group' or 'plan'
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.
Requirements The insurer issued label for a specific health card value.
Cardinality 1..1
Type CodeableConcept
Binding coverage-class (extensible)
Invariants ele-1

Coverage.class.value

Short Value associated with the type
Definition The alphanumeric string value associated with the insurer issued label.
Requirements The insurer issued label and value are necessary to identify the specific policy.
Comments For example, the Group or Plan number.
Cardinality 1..1
Type string
Invariants ele-1

Coverage.class.name

Short Human readable description of the type and value
Definition A short description for the class.
Requirements Used to provide a meaningful description in correspondence to the patient.
Cardinality 0..1
Type string
Invariants ele-1

Coverage.order

Short Relative order of the coverage
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.
Requirements Used in managing the coordination of benefits.
Cardinality 0..1
Type positiveInt
Invariants ele-1

Coverage.network

Short Insurer 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.
Requirements Used in referral for treatment and in claims processing.
Cardinality 0..1
Type string
Invariants ele-1

Coverage.costToBeneficiary

Short Patient payments for services/products
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.
Requirements Required by providers to manage financial transaction with the patient.
Comments For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
Cardinality 0..*
Type BackboneElement
Invariants ele-1
Also called CoPay, Deductible, Exceptions

Coverage.costToBeneficiary.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Coverage.costToBeneficiary.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Coverage.costToBeneficiary.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
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).
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.
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.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

Coverage.costToBeneficiary.type

Short Cost category
Definition The category of patient centric costs associated with treatment.
Requirements Needed to identify the category associated with the amount for the patient.
Comments For example visit, specialist visits, emergency, inpatient care, etc.
Cardinality 0..1
Type CodeableConcept
Binding coverage-copay-type (extensible)
Invariants ele-1

Coverage.costToBeneficiary.value[x]

Short The amount or percentage due from the beneficiary
Definition The amount due from the patient for the cost category.
Requirements Needed to identify the amount for the patient associated with the category.
Comments Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
Cardinality 1..1
Type Quantity(SimpleQuantity), Money
Invariants ele-1

Coverage.costToBeneficiary.exception

Short Exceptions for patient payments
Definition A suite of codes indicating exceptions or reductions to patient costs and their effective periods.
Requirements Required by providers to manage financial transaction with the patient.
Cardinality 0..*
Type BackboneElement
Invariants ele-1

Coverage.costToBeneficiary.exception.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Coverage.costToBeneficiary.exception.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Coverage.costToBeneficiary.exception.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
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).
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.
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.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

Coverage.costToBeneficiary.exception.type

Short Exception category
Definition The code for the specific exception.
Requirements Needed to identify the exception associated with the amount for the patient.
Cardinality 1..1
Type CodeableConcept
Binding coverage-financial-exception (example)
Invariants ele-1

Coverage.costToBeneficiary.exception.period

Short The effective period of the exception
Definition The timeframe during when the exception is in force.
Requirements Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.
Cardinality 0..1
Type Period
Invariants ele-1

Coverage.subrogation

Short Reimbursement to insurer
Definition When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
Requirements See definition for when to be used.
Comments Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
Cardinality 0..1
Type boolean
Invariants ele-1

Coverage.contract

Short Contract details
Definition The policy(s) which constitute this insurance coverage.
Requirements To reference the legally binding contract between the policy holder and the insurer.
Cardinality 0..*
Type Reference(Contract)
Invariants ele-1