Skip to main content

Coverage

PropertyValue
Publisher
NameCoverage
URLhttp://hl7.org/fhir/StructureDefinition/Coverage
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Coverage0..*CoverageFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
Coverage.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Coverage.meta0..1MetaThe 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.
Coverage.implicitRules0..1uriA 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.
Coverage.language0..1codeThe base language in which the resource is written.
Coverage.text0..1NarrativeA 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.
Coverage.contained0..*ResourceThese 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.
Coverage.extension0..*ExtensionMay 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.
Coverage.modifierExtension0..*ExtensionMay 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).
Coverage.identifier0..*IdentifierA unique identifier assigned to this coverage.
Coverage.status1..1codeThe status of the resource instance.
Coverage.type0..1CodeableConceptThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
Coverage.policyHolder0..1ReferenceThe party who 'owns' the insurance policy.
Coverage.subscriber0..1ReferenceThe 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.
Coverage.subscriberId0..1stringThe insurer assigned ID for the Subscriber.
Coverage.beneficiary1..1ReferenceThe party who benefits from the insurance coverage; the patient when products and/or services are provided.
Coverage.dependent0..1stringA unique identifier for a dependent under the coverage.
Coverage.relationship0..1CodeableConceptThe relationship of beneficiary (patient) to the subscriber.
Coverage.period0..1PeriodTime 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.
Coverage.payor1..*ReferenceThe program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
Coverage.class0..*BackboneElementA suite of underwriter specific classifiers.
Coverage.class.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Coverage.class.extension0..*ExtensionMay 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.
Coverage.class.modifierExtension0..*ExtensionMay 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).
Coverage.class.type1..1CodeableConceptThe 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.
Coverage.class.value1..1stringThe alphanumeric string value associated with the insurer issued label.
Coverage.class.name0..1stringA short description for the class.
Coverage.order0..1positiveIntThe 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.
Coverage.network0..1stringThe 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.
Coverage.costToBeneficiary0..*BackboneElementA 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.
Coverage.costToBeneficiary.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Coverage.costToBeneficiary.extension0..*ExtensionMay 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.
Coverage.costToBeneficiary.modifierExtension0..*ExtensionMay 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).
Coverage.costToBeneficiary.type0..1CodeableConceptThe category of patient centric costs associated with treatment.
Coverage.costToBeneficiary.value[x]1..1QuantityThe amount due from the patient for the cost category.
Coverage.costToBeneficiary.exception0..*BackboneElementA suite of codes indicating exceptions or reductions to patient costs and their effective periods.
Coverage.costToBeneficiary.exception.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Coverage.costToBeneficiary.exception.extension0..*ExtensionMay 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.
Coverage.costToBeneficiary.exception.modifierExtension0..*ExtensionMay 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).
Coverage.costToBeneficiary.exception.type1..1CodeableConceptThe code for the specific exception.
Coverage.costToBeneficiary.exception.period0..1PeriodThe timeframe during when the exception is in force.
Coverage.subrogation0..1booleanWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
Coverage.contract0..*ReferenceThe policy(s) which constitute this insurance coverage.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
beneficiaryreferenceCovered partyCoverage.beneficiary
class-typetokenCoverage class (eg. plan, group)Coverage.class.type
class-valuestringValue of the class (eg. Plan number, group number)Coverage.class.value
dependentstringDependent numberCoverage.dependent
identifiertokenThe primary identifier of the insured and the coverageCoverage.identifier
patientreferenceRetrieve coverages for a patientCoverage.beneficiary
payorreferenceThe identity of the insurer or party paying for servicesCoverage.payor
policy-holderreferenceReference to the policyholderCoverage.policyHolder
statustokenThe status of the CoverageCoverage.status
subscriberreferenceReference to the subscriberCoverage.subscriber
typetokenThe kind of coverage (health plan, auto, Workers Compensation)Coverage.type