HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
2.0.0 - STU2 Release 1 - Standard for Trial-Use International flag

This page is part of the HRSA Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+ or uds-plus) FHIR IG (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: DeIdentifiedUDSPlusCoverage - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the uds-plus-coverage resource profile.

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

0. Coverage
Definition

The UDS+ profile is based on the **QI Core Coverage profile and establishes the core elements, extensions, vocabularies and value sets for representing Coverage for UDS+ program.


Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

ShortUDS Plus CoverageInsurance or medical plan or a payment agreement
Comments

The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Coverage.id
Definition

De-dentified Coverage identifier.


The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortThe de-identified Coverage identifier created by the health center to send data to HRSA.Logical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeidstring
Is Modifierfalse
Must Supporttrue
Summarytrue
4. Coverage.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Coverage.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortCannot include any text in the resource as part of the de-identified data.Text summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..01
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Coverage.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortCannot include any contained resources in the resource as part of the de-identified data.Contained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..0*
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
10. Coverage.extension:capitatedMemberMonths
Slice NamecapitatedMemberMonths
Definition

Indicates the capitated member months of the Patient. This is computed based on data obtaind by the Health Center from the plans.

ShortIndicates the capitated member months of the Patient.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(UDS Plus Capitated Member Months Extension) (Extension Type: Quantity)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Coverage.extension:feeForServiceMemberMonths
Slice NamefeeForServiceMemberMonths
Definition

Indicates the FeeForService member months of the Patient. This is computed based on data obtaind by the Health Center from the plans.

ShortIndicates the FeeForService member months of the Patient.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(UDS Plus FeeForService Member Months Extension) (Extension Type: Quantity)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Coverage.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Coverage.status
Definition

The status of the resource instance.

Shortactive | cancelled | draft | entered-in-error
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.

Control1..1
BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

A code specifying the state of the resource instance.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

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

The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

ShortCoverage category such as medical or accident
Control10..1
BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Uds Plus Insurance Codeshttp://hl7.org/fhir/ValueSet/coverage-type
(extensible to http://fhir.org/guides/hrsa/uds-plus/ValueSet/uds-plus-insurance-codes)

The set of codes to be used for UDS+ reporting.


The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

The order of application of coverages is dependent on the types of coverage.

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

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

ShortPlan beneficiary
Control1..1
TypeReference(De-Identified UDS Plus Patient, Patient)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Coverage.beneficiary.display
Definition

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

ShortText alternative for the resource
Comments

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

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

Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

ShortCoverage start and end dates
Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Some insurers require the submission of the coverage term.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
uds-plus-cov-1: All Period.start data elements should be truncated to a year only for de-identified resources. ($this is Period and Period.start.exists() implies $this.start.toString().length() = 4)
uds-plus-cov-1a: All Period.start data elements should have valid year > 1900 ($this is Period and Period.start.exists() implies $this.start.toString() >= '1900')
uds-plus-cov-1b: All Period.start data elements should have valid year < 2030 ($this is Period and Period.start.exists() implies $this.start.toString() <= '2030')
uds-plus-cov-2: All Period.emd data elements should be truncated to a year only for de-identified resources. ($this is Period and Period.end.exists() implies $this.end.toString().length() = 4)
uds-plus-cov-2a: All Period.end data elements should have valid year > 1900 ($this is Period and Period.end.exists() implies $this.end.toString() >= '1900')
uds-plus-cov-2b: All Period.end data elements should have valid year < 2030 ($this is Period and Period.end.exists() implies $this.end.toString() <= '2030')
26. Coverage.payor
Definition

The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

ShortIssuer of the policy
Comments

May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

Control1..*
TypeReference(De-Identified UDS Plus Patient, US Core Organization Profile, De-Identified UDS Plus RelatedPerson, Organization, Patient, RelatedPerson)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Requirements

Need to identify the issuer to target for claim processing and for coordination of benefit processing.

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

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

ShortText alternative for the resource
Comments

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

Control0..01
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Coverage.costToBeneficiary
Definition

A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

ShortPatient payments for services/products
Comments

For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.

Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Required by providers to manage financial transaction with the patient.

Alternate NamesCoPay, Deductible, Exceptions
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))