Generated Narrative: StructureDefinition athena-coverage-profile Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Coverage 0..* Coverage Insurance or medical plan or a payment agreement #xD; id S 1..1 id Logical id of this artifact #xD; meta 0..1 Meta Metadata about the resource #xD; versionId 0..1 id Version specific identifier #xD; lastUpdated 0..1 instant When the resource version last changed #xD; Slices for profile Content/Rules for all slices #xD; profile:ATHENA Coverage Profile 1..1 canonical() Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-coverage-profile #xD; security 0..1 Coding Security Labels applied to this resource #xD; Slices for extension Content/Rules for all slices #xD; extension:coverage-type 0..1 (Complex) Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-coverage-extension-coverage-type #xD; url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-coverage-extension-coverage-type" #xD; value[x] 1..1 string Value of extension #xD; extension:subscriber-name 0..1 (Complex) Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-coverage-extension-subscriber-name #xD; url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-coverage-extension-subscriber-name" #xD; value[x] 1..1 HumanName Value of extension #xD; identifier 0..* Identifier Business Identifier for the coverage #xD; status S 1..1 code active | cancelled | draft | entered-in-error #xD; type 0..1 CodeableConcept Coverage category such as medical or accident #xD; policyHolder 0..1 Reference(Patient | RelatedPerson | Organization) Owner of the policy #xD; subscriber 0..1 Reference(Patient) Subscriber to the policy #xD; subscriberId 0..1 string ID assigned to the subscriber #xD; beneficiary S 1..1 Reference(Patient) Plan beneficiary #xD; relationship S 1..1 CodeableConcept Beneficiary relationship to the subscriber #xD; period 0..1 Period Coverage start and end dates #xD; payor S 1..* Reference(Organization | Patient | RelatedPerson) Issuer of the policy #xD; Slices for class 0..* BackboneElement Additional coverage classifications Slice: Unordered, Open by value:BackboneElement #xD; class:Group 0..1 BackboneElement Additional coverage classifications #xD; type S 1..1 CodeableConcept Type of class such as 'group' or 'plan' #xD; value S 1..1 string Value associated with the type #xD; name S 1..1 string Human readable description of the type and value #xD; class:Plan 0..1 BackboneElement Additional coverage classifications #xD; type S 1..1 CodeableConcept Type of class such as 'group' or 'plan' #xD; value S 1..1 string Value associated with the type #xD; name S 1..1 string Human readable description of the type and value #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
Defines constraints and extensions on the condition resource as supported by Athena Products.
Canadian Dental Association eclaims standard
Canadian Pharmacy Associaiton eclaims standard
Insurance or medical plan or a payment agreement
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
Financial instrument which may be used to pay for or reimburse health care products and services.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The 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.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.
Identifies where the resource comes from
A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Coverage.meta.profile:ATHENA Coverage Profile
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Security Labels from the Healthcare Privacy and Security Classification System.
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
A set of rules under which this content was created
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.
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.
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
The 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).
Text summary of the resource, for human interpretation
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.
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.
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.
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.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Source of the definition for the extension code - a logical name or a URL.
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.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
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).
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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
A unique identifier assigned to this coverage.
Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business.
Allows coverages to be distinguished and referenced.
active | cancelled | draft | entered-in-error
This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.
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 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
A code specifying the state of the resource instance.
Coverage category such as medical or accident
The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.
The order of application of coverages is dependent on the types of coverage.
The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
The party who 'owns' the insurance policy.
This provides employer information in the case of Worker's Compensation and other policies.
IN1-16, 18, 19-name of insured, address, date of birth
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.
The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.
This is the party who is entitled to the benfits under the policy.
The insurer assigned ID for the Subscriber.
The insurer requires this identifier on correspondance and claims (digital and otherwise).
The 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.
A unique identifier for a dependent under the coverage.
Periodically the member number is constructed from the subscriberId and the dependant number.
For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.
- No exact HL7 v2 equivalent concept seems to exist;
Beneficiary relationship to the subscriber
The relationship of beneficiary (patient) to the subscriber.
Beneficiary relationship to the subscriber.
To determine relationship between the patient and the subscriber to determine coordination of benefits.
The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
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.
Some insurers require the submission of the coverage term.
The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
The program or plan underwriter or payor.
Need to identify the issuer to target for claim processing and for coordination of benefit processing.
MakeReference("INSCARRIER",%BUSID%,"Organization",%NAME% )
MakeReference("INSCARRIER",%INSURANCECARRIERSID%,"Organization", %INSURANCECARRIERNAME%)
A suite of underwriter specific classifiers.
For example may be used to identify a class of coverage or employer group, Policy, Plan.
The codes provided on the health card which identify or confirm the specific policy for the insurer.
Extensions that cannot be ignored even if unrecognized
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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
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.
The insurer issued label for a specific health card value.
The policy classifications, eg. Group, Plan, Class, etc.
The alphanumeric string value associated with the insurer issued label.
The insurer issued label and value are necessary to identify the specific policy.
Human readable description of the type and value
Used to provide a meaningful description in correspondence to the patient.
Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.
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.
Used in managing the coordination of benefits.
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.
Used in referral for treatment and in claims processing.
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.
For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
Required by providers to manage financial transaction with the patient.
The category of patient centric costs associated with treatment.
For example visit, specialist visits, emergency, inpatient care, etc.
Needed to identify the category associated with the amount for the patient.
The types of services to which patient copayments are specified.
The amount or percentage due from the beneficiary
The amount due from the patient for the cost category.
Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
Needed to identify the amount for the patient associated with the category.
A suite of codes indicating exceptions or reductions to patient costs and their effective periods.
Needed to identify the exception associated with the amount for the patient.
The types of exceptions from the part or full value of financial obligations such as copays.
The timeframe during when the exception is in force.
Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.
When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.
The policy(s) which constitute this insurance coverage.
To reference the legally binding contract between the policy holder and the insurer.