FHIR Implementation Guide for HCX
0.7.0 - CI Build

FHIR Implementation Guide for HCX - Local Development build (v0.7.0). See the Directory of published versions

Resource Profile: HCX Coverage Eligibility Request

Defining URL:https://swasth-digital-health-foundation.github.io/standards/v0.7/StructureDefinition-CoverageEligibilityRequest.html
Version:0.7.0
Name:CoverageEligibilityRequest
Status:Draft as of 2019-11-01 09:29:23+1100 (Standards Status: Trial Use)
Definition:

The CoverageEligibilityRequest provides 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.

Publisher:HCX Open Community
Committee:Financial Management
Maturity:0
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://swasth-digital-health-foundation.github.io/standards/v0.7/StructureDefinition-CoverageEligibilityRequest.html

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 1..1IdentifierBusiness Identifier for coverage eligiblity request
... priority 1..1CodeableConceptDesired processing priority
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred.

... patient Σ1..1Reference(Patient)Intended recipient of products and services
... provider 1..1Reference(Practitioner | Organization)Party responsible for the request
... insurer Σ1..1Reference(Organization)Coverage issuer
... insurance
.... coverage 1..1Reference(Coverage)Insurance information
... item
.... provider 0..1Reference(Practitioner | PractitionerRole)Perfoming practitioner
.... facility 0..1Reference(Location | Organization)Servicing facility
.... diagnosis
..... diagnosis[x] 0..1Nature of illness or problem
Binding: ICD-10Codes (example): ICD10 Diagnostic codes.

...... diagnosisCodeableConceptCodeableConcept
...... diagnosisReferenceReference(Condition)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..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 Σ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 | Organization)Party responsible for the request
... insurer Σ1..1Reference(Organization)Coverage issuer
... facility 0..1Reference(Location)Servicing facility
... supportingInfo 0..*BackboneElementSupporting information
.... 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 0..*BackboneElementPatient insurance information
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... focal 0..1booleanApplicable coverage
.... coverage 1..1Reference(Coverage)Insurance information
.... businessArrangement 0..1stringAdditional provider contract number
... item 0..*BackboneElementItem to be evaluated for eligibiity
.... 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: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision etc.

.... productOrService 0..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... 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 0..*BackboneElementApplicable diagnosis
..... 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

Differential View

This structure is derived from CoverageEligibilityRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... identifier 1..1IdentifierBusiness Identifier for coverage eligiblity request
... priority 1..1CodeableConceptDesired processing priority
Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred.

... patient Σ1..1Reference(Patient)Intended recipient of products and services
... provider 1..1Reference(Practitioner | Organization)Party responsible for the request
... insurer Σ1..1Reference(Organization)Coverage issuer
... insurance
.... coverage 1..1Reference(Coverage)Insurance information
... item
.... provider 0..1Reference(Practitioner | PractitionerRole)Perfoming practitioner
.... facility 0..1Reference(Location | Organization)Servicing facility
.... diagnosis
..... diagnosis[x] 0..1Nature of illness or problem
Binding: ICD-10Codes (example): ICD10 Diagnostic codes.

...... diagnosisCodeableConceptCodeableConcept
...... diagnosisReferenceReference(Condition)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CoverageEligibilityRequest 0..*CoverageEligibilityRequestCoverageEligibilityRequest resource
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..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 Σ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 | Organization)Party responsible for the request
... insurer Σ1..1Reference(Organization)Coverage issuer
... facility 0..1Reference(Location)Servicing facility
... supportingInfo 0..*BackboneElementSupporting information
.... 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 0..*BackboneElementPatient insurance information
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... focal 0..1booleanApplicable coverage
.... coverage 1..1Reference(Coverage)Insurance information
.... businessArrangement 0..1stringAdditional provider contract number
... item 0..*BackboneElementItem to be evaluated for eligibiity
.... 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: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision etc.

.... productOrService 0..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... 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 0..*BackboneElementApplicable diagnosis
..... 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
CoverageEligibilityRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
CoverageEligibilityRequest.statusrequiredFinancialResourceStatusCodes
CoverageEligibilityRequest.priorityexampleProcessPriorityCodes
CoverageEligibilityRequest.purposerequiredEligibilityRequestPurpose
CoverageEligibilityRequest.item.categoryexampleBenefitCategoryCodes
CoverageEligibilityRequest.item.productOrServiceexampleUSCLSCodes
CoverageEligibilityRequest.item.modifierexampleModifierTypeCodes
CoverageEligibilityRequest.item.diagnosis.diagnosis[x]exampleICD-10Codes

Constraints

IdGradePathDetailsRequirements
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-1errorCoverageEligibilityRequest.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.serviced[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.createdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.entererAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.providerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.insurerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.facilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.supportingInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.supportingInfo.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.supportingInfo.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.supportingInfo.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.supportingInfo.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.supportingInfo.sequenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.supportingInfo.informationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.supportingInfo.appliesToAllAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.insuranceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.insurance.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.insurance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.insurance.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.insurance.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.insurance.focalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.insurance.coverageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.insurance.businessArrangementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.item.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.item.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.item.supportingInfoSequenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.productOrServiceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.modifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.providerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.quantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.unitPriceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.facilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.diagnosisAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.diagnosis.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.item.diagnosis.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.item.diagnosis.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCoverageEligibilityRequest.item.diagnosis.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCoverageEligibilityRequest.item.diagnosis.diagnosis[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCoverageEligibilityRequest.item.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())