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
Defining URL: | https://ig.hcxprotocol.io/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 |
Maturity: | 1 |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://ig.hcxprotocol.io/v0.7/StructureDefinition-CoverageEligibilityRequest.html
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CoverageEligibilityRequest
Summary
Mandatory: 6 elements (1 nested mandatory element)
Structures
This structure refers to these other structures:
Maturity: 1
This structure is derived from CoverageEligibilityRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CoverageEligibilityRequest | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
identifier | 1..1 | Identifier | Business Identifier for coverage eligiblity request | |
priority | 1..1 | CodeableConcept | Desired processing priority Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. | |
patient | Σ | 1..1 | Reference(Patient) | Intended recipient of products and services |
enterer | 1..1 | Reference(Practitioner | PractitionerRole) | Author | |
provider | 1..1 | Reference(Practitioner | Organization) | Party responsible for the request | |
insurer | Σ | 1..1 | Reference(Organization) | Coverage issuer |
insurance | ||||
coverage | 1..1 | Reference(Coverage) | Insurance information | |
item | ||||
category | 0..1 | CodeableConcept | Benefit classification Binding: ClaimServiceCategories (example): Benefit categories such as: oral, medical, vision etc. | |
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: ClaimServiceCodes (example): Allowable service and product codes. | |
provider | 0..1 | Reference(Practitioner | PractitionerRole) | Perfoming practitioner | |
facility | 0..1 | Reference(Location | Organization) | Servicing facility | |
diagnosis | ||||
diagnosis[x] | 0..1 | Nature of illness or problem Binding: ICD-10Codes (example): ICD10 Diagnostic codes. | ||
diagnosisCodeableConcept | CodeableConcept | |||
diagnosisReference | Reference(Condition) | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CoverageEligibilityRequest | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 1..1 | Identifier | Business Identifier for coverage eligiblity request | |||||
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
priority | 1..1 | CodeableConcept | Desired processing priority Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. | |||||
purpose | Σ | 1..* | code | auth-requirements | benefits | discovery | validation Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. | ||||
patient | Σ | 1..1 | Reference(Patient) | Intended recipient of products and services | ||||
serviced[x] | 0..1 | Estimated date or dates of service | ||||||
servicedDate | date | |||||||
servicedPeriod | Period | |||||||
created | Σ | 1..1 | dateTime | Creation date | ||||
enterer | 1..1 | Reference(Practitioner | PractitionerRole) | Author | |||||
provider | 1..1 | Reference(Practitioner | Organization) | Party responsible for the request | |||||
insurer | Σ | 1..1 | Reference(Organization) | Coverage issuer | ||||
facility | 0..1 | Reference(Location) | Servicing facility | |||||
supportingInfo | 0..* | BackboneElement | Supporting information | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Information instance identifier | |||||
information | 1..1 | Reference(Resource) | Data to be provided | |||||
appliesToAll | 0..1 | boolean | Applies to all items | |||||
insurance | 0..* | BackboneElement | Patient insurance information | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
focal | 0..1 | boolean | Applicable coverage | |||||
coverage | 1..1 | Reference(Coverage) | Insurance information | |||||
businessArrangement | 0..1 | string | Additional provider contract number | |||||
item | 0..* | BackboneElement | Item to be evaluated for eligibiity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
supportingInfoSequence | 0..* | positiveInt | Applicable exception or supporting information | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: ClaimServiceCategories (example): Benefit categories such as: oral, medical, vision etc. | |||||
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: ClaimServiceCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Product 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..1 | Reference(Practitioner | PractitionerRole) | Perfoming practitioner | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
facility | 0..1 | Reference(Location | Organization) | Servicing facility | |||||
diagnosis | 0..* | BackboneElement | Applicable diagnosis | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
diagnosis[x] | 0..1 | Nature of illness or problem Binding: ICD-10Codes (example): ICD10 Diagnostic codes. | ||||||
diagnosisCodeableConcept | CodeableConcept | |||||||
diagnosisReference | Reference(Condition) | |||||||
detail | 0..* | Reference(Resource) | Product or service details | |||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CoverageEligibilityRequest | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
Documentation for this format |
This structure is derived from CoverageEligibilityRequest
Summary
Mandatory: 6 elements (1 nested mandatory element)
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from CoverageEligibilityRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CoverageEligibilityRequest | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
identifier | 1..1 | Identifier | Business Identifier for coverage eligiblity request | |
priority | 1..1 | CodeableConcept | Desired processing priority Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. | |
patient | Σ | 1..1 | Reference(Patient) | Intended recipient of products and services |
enterer | 1..1 | Reference(Practitioner | PractitionerRole) | Author | |
provider | 1..1 | Reference(Practitioner | Organization) | Party responsible for the request | |
insurer | Σ | 1..1 | Reference(Organization) | Coverage issuer |
insurance | ||||
coverage | 1..1 | Reference(Coverage) | Insurance information | |
item | ||||
category | 0..1 | CodeableConcept | Benefit classification Binding: ClaimServiceCategories (example): Benefit categories such as: oral, medical, vision etc. | |
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: ClaimServiceCodes (example): Allowable service and product codes. | |
provider | 0..1 | Reference(Practitioner | PractitionerRole) | Perfoming practitioner | |
facility | 0..1 | Reference(Location | Organization) | Servicing facility | |
diagnosis | ||||
diagnosis[x] | 0..1 | Nature of illness or problem Binding: ICD-10Codes (example): ICD10 Diagnostic codes. | ||
diagnosisCodeableConcept | CodeableConcept | |||
diagnosisReference | Reference(Condition) | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CoverageEligibilityRequest | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 1..1 | Identifier | Business Identifier for coverage eligiblity request | |||||
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
priority | 1..1 | CodeableConcept | Desired processing priority Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. | |||||
purpose | Σ | 1..* | code | auth-requirements | benefits | discovery | validation Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. | ||||
patient | Σ | 1..1 | Reference(Patient) | Intended recipient of products and services | ||||
serviced[x] | 0..1 | Estimated date or dates of service | ||||||
servicedDate | date | |||||||
servicedPeriod | Period | |||||||
created | Σ | 1..1 | dateTime | Creation date | ||||
enterer | 1..1 | Reference(Practitioner | PractitionerRole) | Author | |||||
provider | 1..1 | Reference(Practitioner | Organization) | Party responsible for the request | |||||
insurer | Σ | 1..1 | Reference(Organization) | Coverage issuer | ||||
facility | 0..1 | Reference(Location) | Servicing facility | |||||
supportingInfo | 0..* | BackboneElement | Supporting information | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | 1..1 | positiveInt | Information instance identifier | |||||
information | 1..1 | Reference(Resource) | Data to be provided | |||||
appliesToAll | 0..1 | boolean | Applies to all items | |||||
insurance | 0..* | BackboneElement | Patient insurance information | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
focal | 0..1 | boolean | Applicable coverage | |||||
coverage | 1..1 | Reference(Coverage) | Insurance information | |||||
businessArrangement | 0..1 | string | Additional provider contract number | |||||
item | 0..* | BackboneElement | Item to be evaluated for eligibiity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
supportingInfoSequence | 0..* | positiveInt | Applicable exception or supporting information | |||||
category | 0..1 | CodeableConcept | Benefit classification Binding: ClaimServiceCategories (example): Benefit categories such as: oral, medical, vision etc. | |||||
productOrService | 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: ClaimServiceCodes (example): Allowable service and product codes. | |||||
modifier | 0..* | CodeableConcept | Product 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..1 | Reference(Practitioner | PractitionerRole) | Perfoming practitioner | |||||
quantity | 0..1 | SimpleQuantity | Count of products or services | |||||
unitPrice | 0..1 | Money | Fee, charge or cost per item | |||||
facility | 0..1 | Reference(Location | Organization) | Servicing facility | |||||
diagnosis | 0..* | BackboneElement | Applicable diagnosis | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
diagnosis[x] | 0..1 | Nature of illness or problem Binding: ICD-10Codes (example): ICD10 Diagnostic codes. | ||||||
diagnosisCodeableConcept | CodeableConcept | |||||||
diagnosisReference | Reference(Condition) | |||||||
detail | 0..* | Reference(Resource) | Product or service details | |||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet | ||||
CoverageEligibilityRequest.language | preferred | CommonLanguages
| ||||
CoverageEligibilityRequest.status | required | FinancialResourceStatusCodes | ||||
CoverageEligibilityRequest.priority | example | ProcessPriorityCodes | ||||
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurpose | ||||
CoverageEligibilityRequest.item.category | example | ClaimServiceCategories | ||||
CoverageEligibilityRequest.item.productOrService | example | ClaimServiceCodes | ||||
CoverageEligibilityRequest.item.modifier | example | ModifierTypeCodes | ||||
CoverageEligibilityRequest.item.diagnosis.diagnosis[x] | example | ICD-10Codes |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |