FHIR Implementation Guide for ABDM
3.1.0 - active India flag

Banner

FHIR Implementation Guide for ABDM - Local Development build (v3.1.0). See the Directory of published versions

Resource Profile: StructureDefinition/CoverageEligibilityRequest

Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/CoverageEligibilityRequest Version: 3.1.0
Draft as of 2023-08-10 Computable Name: CoverageEligibilityRequest

This profile sets minimum expectations for CoverageEligibilityRequest to provide patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CoverageEligibilityRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... identifier S1..1IdentifierBusiness Identifier for coverage eligiblity request
... priority 1..1CodeableConceptDesired processing priority
... purpose S1..*codeauth-requirements | benefits | discovery | validation
... created 1..1dateTimeCreation date
... enterer 1..1Reference(Practitioner | PractitionerRole)Author
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Party responsible for the request
... insurer 1..1Reference(Organization)Coverage issuer
... facility 1..1Reference(Location)Servicing facility
... supportingInfo S0..*BackboneElementSupporting information
... insurance S1..*BackboneElementPatient insurance information
.... coverage S1..1Reference(Coverage)Insurance information
... item S0..*BackboneElementItem to be evaluated for eligibiity
.... category 0..1CodeableConceptBenefit classification
Binding: Benefit Category (example)
.... productOrService S1..1CodeableConceptBilling, service, product, or drug code
Binding: ProductorService (example)
.... provider 0..1Reference(Practitioner | PractitionerRole)Perfoming practitioner
.... facility 0..1Reference(Location | Organization)Servicing facility
.... diagnosis S0..*BackboneElementApplicable diagnosis
..... diagnosis[x] 0..1Nature of illness or problem
...... diagnosisCodeableConceptCodeableConcept
...... diagnosisReferenceReference(Condition)
.... detail 0..*Reference(Resource)Product or service details

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CoverageEligibilityRequest.item.categoryexampleBenefitCategory
CoverageEligibilityRequest.item.productOrServiceexampleProductorService
NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness Identifier for coverage eligiblity request
... priority 1..1CodeableConceptDesired processing priority
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred.

... purpose SΣ1..*codeauth-requirements | benefits | discovery | validation
Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested.


... patient Σ1..1Reference(Patient)Intended recipient of products and services
... created Σ1..1dateTimeCreation date
... enterer 1..1Reference(Practitioner | PractitionerRole)Author
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Party responsible for the request
... insurer Σ1..1Reference(Organization)Coverage issuer
... facility 1..1Reference(Location)Servicing facility
... supportingInfo S0..*BackboneElementSupporting information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInformation instance identifier
.... information 1..1Reference(Resource)Data to be provided
... insurance S1..*BackboneElementPatient insurance information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... coverage S1..1Reference(Coverage)Insurance information
... item S0..*BackboneElementItem to be evaluated for eligibiity
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptBenefit classification
Binding: Benefit Category (example)
.... productOrService S1..1CodeableConceptBilling, service, product, or drug code
Binding: ProductorService (example)
.... provider 0..1Reference(Practitioner | PractitionerRole)Perfoming practitioner
.... facility 0..1Reference(Location | Organization)Servicing facility
.... diagnosis S0..*BackboneElementApplicable diagnosis
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... diagnosis[x] 0..1Nature of illness or problem
Binding: ICD-10Codes (example): ICD10 Diagnostic codes.

...... diagnosisCodeableConceptCodeableConcept
...... diagnosisReferenceReference(Condition)
.... detail 0..*Reference(Resource)Product or service details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CoverageEligibilityRequest.statusrequiredFinancialResourceStatusCodes
CoverageEligibilityRequest.priorityexampleProcessPriorityCodes
CoverageEligibilityRequest.purposerequiredEligibilityRequestPurpose
CoverageEligibilityRequest.item.categoryexampleBenefitCategory
CoverageEligibilityRequest.item.productOrServiceexampleProductorService
CoverageEligibilityRequest.item.diagnosis.diagnosis[x]exampleICD-10Codes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageEligibilityRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageEligibilityRequestIf 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-4errorCoverageEligibilityRequestIf 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-5errorCoverageEligibilityRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageEligibilityRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness Identifier for coverage eligiblity request
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... priority 1..1CodeableConceptDesired processing priority
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred.

... purpose SΣ1..*codeauth-requirements | benefits | discovery | validation
Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested.


... patient Σ1..1Reference(Patient)Intended recipient of products and services
... serviced[x] 0..1Estimated date or dates of service
.... servicedDatedate
.... servicedPeriodPeriod
... created Σ1..1dateTimeCreation date
... enterer 1..1Reference(Practitioner | PractitionerRole)Author
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Party responsible for the request
... insurer Σ1..1Reference(Organization)Coverage issuer
... facility 1..1Reference(Location)Servicing facility
... supportingInfo S0..*BackboneElementSupporting information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInformation instance identifier
.... information 1..1Reference(Resource)Data to be provided
.... appliesToAll 0..1booleanApplies to all items
... insurance S1..*BackboneElementPatient insurance information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... focal 0..1booleanApplicable coverage
.... coverage S1..1Reference(Coverage)Insurance information
.... businessArrangement 0..1stringAdditional provider contract number
... item S0..*BackboneElementItem to be evaluated for eligibiity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... supportingInfoSequence 0..*positiveIntApplicable exception or supporting information
.... category 0..1CodeableConceptBenefit classification
Binding: Benefit Category (example)
.... productOrService S1..1CodeableConceptBilling, service, product, or drug code
Binding: ProductorService (example)
.... modifier 0..*CodeableConceptProduct or service billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


.... provider 0..1Reference(Practitioner | PractitionerRole)Perfoming practitioner
.... quantity 0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... facility 0..1Reference(Location | Organization)Servicing facility
.... diagnosis S0..*BackboneElementApplicable diagnosis
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... diagnosis[x] 0..1Nature of illness or problem
Binding: ICD-10Codes (example): ICD10 Diagnostic codes.

...... diagnosisCodeableConceptCodeableConcept
...... diagnosisReferenceReference(Condition)
.... detail 0..*Reference(Resource)Product or service details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CoverageEligibilityRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CoverageEligibilityRequest.statusrequiredFinancialResourceStatusCodes
CoverageEligibilityRequest.priorityexampleProcessPriorityCodes
CoverageEligibilityRequest.purposerequiredEligibilityRequestPurpose
CoverageEligibilityRequest.item.categoryexampleBenefitCategory
CoverageEligibilityRequest.item.productOrServiceexampleProductorService
CoverageEligibilityRequest.item.modifierexampleModifierTypeCodes
CoverageEligibilityRequest.item.diagnosis.diagnosis[x]exampleICD-10Codes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from CoverageEligibilityRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... identifier S1..1IdentifierBusiness Identifier for coverage eligiblity request
... priority 1..1CodeableConceptDesired processing priority
... purpose S1..*codeauth-requirements | benefits | discovery | validation
... created 1..1dateTimeCreation date
... enterer 1..1Reference(Practitioner | PractitionerRole)Author
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Party responsible for the request
... insurer 1..1Reference(Organization)Coverage issuer
... facility 1..1Reference(Location)Servicing facility
... supportingInfo S0..*BackboneElementSupporting information
... insurance S1..*BackboneElementPatient insurance information
.... coverage S1..1Reference(Coverage)Insurance information
... item S0..*BackboneElementItem to be evaluated for eligibiity
.... category 0..1CodeableConceptBenefit classification
Binding: Benefit Category (example)
.... productOrService S1..1CodeableConceptBilling, service, product, or drug code
Binding: ProductorService (example)
.... provider 0..1Reference(Practitioner | PractitionerRole)Perfoming practitioner
.... facility 0..1Reference(Location | Organization)Servicing facility
.... diagnosis S0..*BackboneElementApplicable diagnosis
..... diagnosis[x] 0..1Nature of illness or problem
...... diagnosisCodeableConceptCodeableConcept
...... diagnosisReferenceReference(Condition)
.... detail 0..*Reference(Resource)Product or service details

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CoverageEligibilityRequest.item.categoryexampleBenefitCategory
CoverageEligibilityRequest.item.productOrServiceexampleProductorService

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness Identifier for coverage eligiblity request
... priority 1..1CodeableConceptDesired processing priority
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred.

... purpose SΣ1..*codeauth-requirements | benefits | discovery | validation
Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested.


... patient Σ1..1Reference(Patient)Intended recipient of products and services
... created Σ1..1dateTimeCreation date
... enterer 1..1Reference(Practitioner | PractitionerRole)Author
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Party responsible for the request
... insurer Σ1..1Reference(Organization)Coverage issuer
... facility 1..1Reference(Location)Servicing facility
... supportingInfo S0..*BackboneElementSupporting information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInformation instance identifier
.... information 1..1Reference(Resource)Data to be provided
... insurance S1..*BackboneElementPatient insurance information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... coverage S1..1Reference(Coverage)Insurance information
... item S0..*BackboneElementItem to be evaluated for eligibiity
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptBenefit classification
Binding: Benefit Category (example)
.... productOrService S1..1CodeableConceptBilling, service, product, or drug code
Binding: ProductorService (example)
.... provider 0..1Reference(Practitioner | PractitionerRole)Perfoming practitioner
.... facility 0..1Reference(Location | Organization)Servicing facility
.... diagnosis S0..*BackboneElementApplicable diagnosis
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... diagnosis[x] 0..1Nature of illness or problem
Binding: ICD-10Codes (example): ICD10 Diagnostic codes.

...... diagnosisCodeableConceptCodeableConcept
...... diagnosisReferenceReference(Condition)
.... detail 0..*Reference(Resource)Product or service details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CoverageEligibilityRequest.statusrequiredFinancialResourceStatusCodes
CoverageEligibilityRequest.priorityexampleProcessPriorityCodes
CoverageEligibilityRequest.purposerequiredEligibilityRequestPurpose
CoverageEligibilityRequest.item.categoryexampleBenefitCategory
CoverageEligibilityRequest.item.productOrServiceexampleProductorService
CoverageEligibilityRequest.item.diagnosis.diagnosis[x]exampleICD-10Codes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageEligibilityRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageEligibilityRequestIf 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-4errorCoverageEligibilityRequestIf 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-5errorCoverageEligibilityRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageEligibilityRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness Identifier for coverage eligiblity request
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... priority 1..1CodeableConceptDesired processing priority
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred.

... purpose SΣ1..*codeauth-requirements | benefits | discovery | validation
Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested.


... patient Σ1..1Reference(Patient)Intended recipient of products and services
... serviced[x] 0..1Estimated date or dates of service
.... servicedDatedate
.... servicedPeriodPeriod
... created Σ1..1dateTimeCreation date
... enterer 1..1Reference(Practitioner | PractitionerRole)Author
... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Party responsible for the request
... insurer Σ1..1Reference(Organization)Coverage issuer
... facility 1..1Reference(Location)Servicing facility
... supportingInfo S0..*BackboneElementSupporting information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInformation instance identifier
.... information 1..1Reference(Resource)Data to be provided
.... appliesToAll 0..1booleanApplies to all items
... insurance S1..*BackboneElementPatient insurance information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... focal 0..1booleanApplicable coverage
.... coverage S1..1Reference(Coverage)Insurance information
.... businessArrangement 0..1stringAdditional provider contract number
... item S0..*BackboneElementItem to be evaluated for eligibiity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... supportingInfoSequence 0..*positiveIntApplicable exception or supporting information
.... category 0..1CodeableConceptBenefit classification
Binding: Benefit Category (example)
.... productOrService S1..1CodeableConceptBilling, service, product, or drug code
Binding: ProductorService (example)
.... modifier 0..*CodeableConceptProduct or service billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


.... provider 0..1Reference(Practitioner | PractitionerRole)Perfoming practitioner
.... quantity 0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... facility 0..1Reference(Location | Organization)Servicing facility
.... diagnosis S0..*BackboneElementApplicable diagnosis
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... diagnosis[x] 0..1Nature of illness or problem
Binding: ICD-10Codes (example): ICD10 Diagnostic codes.

...... diagnosisCodeableConceptCodeableConcept
...... diagnosisReferenceReference(Condition)
.... detail 0..*Reference(Resource)Product or service details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CoverageEligibilityRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CoverageEligibilityRequest.statusrequiredFinancialResourceStatusCodes
CoverageEligibilityRequest.priorityexampleProcessPriorityCodes
CoverageEligibilityRequest.purposerequiredEligibilityRequestPurpose
CoverageEligibilityRequest.item.categoryexampleBenefitCategory
CoverageEligibilityRequest.item.productOrServiceexampleProductorService
CoverageEligibilityRequest.item.modifierexampleModifierTypeCodes
CoverageEligibilityRequest.item.diagnosis.diagnosis[x]exampleICD-10Codes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron