Coverage
The Coverage profile that SAP Patient Management supports is the following
GenericCoverageV2 (Coverage) | I | Coverage | There are no (further) constraints on this element Element idCoverage Insurance or medical plan or a payment agreement DefinitionFinancial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCoverage.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCoverage.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCoverage.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCoverage.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCoverage.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCoverage.identifier Business Identifier for the coverage DefinitionA unique identifier assigned to this coverage. Allows coverages to be distinguished and referenced. 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.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCoverage.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. 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'. This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid. A code specifying the state of the resource instance.
|
type | S Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.type Coverage category such as medical or accident DefinitionThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. The order of application of coverages is dependent on the types of coverage. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
|
policyHolder | Σ I | 0..1 | Reference(Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idCoverage.policyHolder Owner of the policy DefinitionThe party who 'owns' the insurance policy. This provides employer information in the case of Worker's Compensation and other policies. For example: may be an individual, corporation or the subscriber's employer. Reference(Patient | RelatedPerson | Organization) Constraints
|
subscriber | Σ I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idCoverage.subscriber Subscriber to the policy DefinitionThe 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. This is the party who is entitled to the benfits under the policy. May be self or a parent in the case of dependants. Reference(Patient | RelatedPerson) Constraints
|
subscriberId | S Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.subscriberId ID assigned to the subscriber DefinitionThe insurer assigned ID for the Subscriber. The insurer requires this identifier on correspondance and claims (digital and otherwise). Note that FHIR strings SHALL NOT exceed 1MB in size
|
beneficiary | S Σ I | 1..1 | Reference(Patient) | There are no (further) constraints on this element Element idCoverage.beneficiary Plan beneficiary DefinitionThe party who benefits from the insurance coverage; the patient when products and/or services are provided. This is the party who receives treatment for which the costs are reimbursed under the coverage. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
dependent | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.dependent Dependent number DefinitionA unique identifier for a dependent under the coverage. For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary. Periodically the member number is constructed from the subscriberId and the dependant number.
|
relationship | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.relationship Beneficiary relationship to the subscriber DefinitionThe relationship of beneficiary (patient) to the subscriber. To determine relationship between the patient and the subscriber to determine coordination of benefits. Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others. The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
| |
period | S Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.period Coverage start and end dates DefinitionTime 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. Some insurers require the submission of the coverage term. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
payor | S Σ I | 1..* | Reference(Organization | Patient | RelatedPerson) | There are no (further) constraints on this element Element idCoverage.payor Issuer of the policy DefinitionThe program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. Need to identify the issuer to target for claim processing and for coordination of benefit processing. 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. Reference(Organization | Patient | RelatedPerson) Constraints
|
class | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.class Additional coverage classifications DefinitionA suite of underwriter specific classifiers. The codes provided on the health card which identify or confirm the specific policy for the insurer. For example may be used to identify a class of coverage or employer group, Policy, Plan.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.class.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.class.type Type of class such as 'group' or 'plan' DefinitionThe 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. The insurer issued label for a specific health card value. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The policy classifications, eg. Group, Plan, Class, etc.
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCoverage.class.value Value associated with the type DefinitionThe alphanumeric string value associated with the insurer issued label. The insurer issued label and value are necessary to identify the specific policy. For example, the Group or Plan number.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.class.name Human readable description of the type and value DefinitionA short description for the class. Used to provide a meaningful description in correspondence to the patient. Note that FHIR strings SHALL NOT exceed 1MB in size
|
order | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idCoverage.order Relative order of the coverage DefinitionThe 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. Used in managing the coordination of benefits. 32 bit number; for values larger than this, use decimal
|
network | Σ | 0..1 | string | There are no (further) constraints on this element Element idCoverage.network Insurer network DefinitionThe 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. Used in referral for treatment and in claims processing. Note that FHIR strings SHALL NOT exceed 1MB in size
|
costToBeneficiary | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary Patient payments for services/products Alternate namesCoPay, Deductible, Exceptions DefinitionA 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. Required by providers to manage financial transaction with the patient. For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.type Cost category DefinitionThe category of patient centric costs associated with treatment. Needed to identify the category associated with the amount for the patient. For example visit, specialist visits, emergency, inpatient care, etc. The types of services to which patient copayments are specified.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.value[x] The amount or percentage due from the beneficiary DefinitionThe amount due from the patient for the cost category. Needed to identify the amount for the patient associated with the category. Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
| |
valueQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
exception | 0..* | BackboneElement | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception Exceptions for patient payments DefinitionA suite of codes indicating exceptions or reductions to patient costs and their effective periods. Required by providers to manage financial transaction with the patient.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.type Exception category DefinitionThe code for the specific exception. Needed to identify the exception associated with the amount for the patient. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The types of exceptions from the part or full value of financial obligations such as copays.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idCoverage.costToBeneficiary.exception.period The effective period of the exception DefinitionThe timeframe during when the exception is in force. Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
subrogation | 0..1 | boolean | There are no (further) constraints on this element Element idCoverage.subrogation Reimbursement to insurer DefinitionWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. See definition for when to be used. Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
| |
contract | I | 0..* | Reference(Contract) | There are no (further) constraints on this element Element idCoverage.contract Contract details DefinitionThe policy(s) which constitute this insurance coverage. To reference the legally binding contract between the policy holder and the insurer. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|