0.1.0 - ci-build
kenyaClaimsIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/SHACoverageEligibilityRequest | Version: 0.1.0 | |||
Draft as of 2024-09-06 | Computable Name: SHACoverageEligibilityRequest |
An eligibility request for a patient.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CoverageEligibilityRequest
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
![]() ![]() ![]() |
1..1 | id | Item | |
![]() ![]() ![]() |
1..1 | Meta | Metadata about a resource | |
![]() ![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
0..* | Extension | Optional Extensions Element Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Transfer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/transfer | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | Organization) | Referrer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/referrer | |
![]() ![]() ![]() |
1..1 | Identifier | A business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response. | |
![]() ![]() ![]() |
1..1 | code | Financial Resource Status Code Required Pattern: active | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Desired processing priority. A coding element defining the system and code of the priority. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: normal | |
![]() ![]() ![]() |
1..* | code | EligibilityRequestPurpose | |
![]() ![]() ![]() |
1..1 | Reference(SHAPatient) | The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA Patient | |
![]() ![]() ![]() |
0..1 | date, Period | Estimated date or dates of service Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
0..1 | date | The date or dates when the enclosed suite of services were performed or completed. Choice element: Either date or Period required | |
![]() ![]() ![]() ![]() |
0..1 | Period | The period when the enclosed suite of services were performed or completed. | |
![]() ![]() ![]() |
1..1 | dateTime | Creation date of this CoverageEligibilityRequest | |
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers. | |
![]() ![]() ![]() |
1..1 | Reference(Organization) | Coverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry. | |
![]() ![]() ![]() |
0..1 | Reference(Location) | Servicing Facility. reference to the provider organization resource | |
![]() ![]() ![]() |
1..* | BackboneElement | An element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request. | |
![]() ![]() ![]() ![]() |
1..1 | Reference(SHACoverage) | Insurance information. A Reference to the insurance coverage resource | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
![]() ![]() ![]() |
Σ | 1..1 | id | Item |
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about a resource |
![]() ![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Optional Extensions Element Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Transfer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/transfer | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | Organization) | Referrer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/referrer | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
1..1 | Identifier | A business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response. | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | Financial Resource Status Code Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active |
![]() ![]() ![]() |
1..1 | CodeableConcept | Desired processing priority. A coding element defining the system and code of the priority. Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: normal | |
![]() ![]() ![]() |
Σ | 1..* | code | EligibilityRequestPurpose Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. |
![]() ![]() ![]() |
Σ | 1..1 | Reference(SHAPatient) | The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA Patient |
![]() ![]() ![]() |
0..1 | Estimated date or dates of service Slice: Unordered, Closed by type:$this | ||
![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
0..1 | date | The date or dates when the enclosed suite of services were performed or completed. Choice element: Either date or Period required | |
![]() ![]() ![]() ![]() |
0..1 | Period | The period when the enclosed suite of services were performed or completed. | |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Creation date of this CoverageEligibilityRequest |
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers. | |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Coverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry. |
![]() ![]() ![]() |
0..1 | Reference(Location) | Servicing Facility. reference to the provider organization resource | |
![]() ![]() ![]() |
1..* | BackboneElement | An element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request. | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Reference(SHACoverage) | Insurance information. A Reference to the insurance coverage resource | |
![]() |
Path | Conformance | ValueSet / Code | URI |
CoverageEligibilityRequest.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
CoverageEligibilityRequest.priority | example | Pattern: normalhttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | |
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurposehttp://hl7.org/fhir/ValueSet/eligibilityrequest-purpose|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CoverageEligibilityRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CoverageEligibilityRequest | 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 | error | CoverageEligibilityRequest | 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 | error | CoverageEligibilityRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CoverageEligibilityRequest | A resource should have narrative for robust management : text.`div`.exists() | |
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() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |||||
![]() ![]() ![]() |
Σ | 1..1 | id | Item | ||||
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about a resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Optional Extensions Element Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Transfer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/transfer | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | Organization) | Referrer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/referrer | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
1..1 | Identifier | A business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response. | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | Financial Resource Status Code Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Desired processing priority. A coding element defining the system and code of the priority. Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: normal | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
Σ | 1..* | code | EligibilityRequestPurpose Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(SHAPatient) | The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA Patient | ||||
![]() ![]() ![]() |
0..1 | Estimated date or dates of service Slice: Unordered, Closed by type:$this | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
0..1 | date | The date or dates when the enclosed suite of services were performed or completed. Choice element: Either date or Period required | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period when the enclosed suite of services were performed or completed. | |||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Creation date of this CoverageEligibilityRequest | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Author | |||||
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers. | |||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Coverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry. | ||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Servicing Facility. reference to the provider organization resource | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Supporting information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Resource) | Data to be provided | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Applies to all items | |||||
![]() ![]() ![]() |
1..* | BackboneElement | An element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Applicable coverage | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(SHACoverage) | Insurance information. A Reference to the insurance coverage resource | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Additional provider contract number | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Item to be evaluated for eligibiity | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable exception or supporting information | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision etc. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Perfoming practitioner | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Count of products or services | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Servicing facility | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Applicable diagnosis | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Nature of illness or problem Binding: ICD-10Codes (example): ICD10 Diagnostic codes. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Condition) | |||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Product or service details | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
CoverageEligibilityRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
CoverageEligibilityRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
CoverageEligibilityRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CoverageEligibilityRequest.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
CoverageEligibilityRequest.priority | example | Pattern: normalhttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | ||||
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurposehttp://hl7.org/fhir/ValueSet/eligibilityrequest-purpose|4.0.1 from the FHIR Standard | ||||
CoverageEligibilityRequest.item.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
CoverageEligibilityRequest.item.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
CoverageEligibilityRequest.item.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
CoverageEligibilityRequest.item.diagnosis.diagnosis[x] | example | ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CoverageEligibilityRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CoverageEligibilityRequest | 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 | error | CoverageEligibilityRequest | 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 | error | CoverageEligibilityRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CoverageEligibilityRequest | A resource should have narrative for robust management : text.`div`.exists() | |
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() |
This structure is derived from CoverageEligibilityRequest
Summary
Mandatory: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CoverageEligibilityRequest
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
![]() ![]() ![]() |
1..1 | id | Item | |
![]() ![]() ![]() |
1..1 | Meta | Metadata about a resource | |
![]() ![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
0..* | Extension | Optional Extensions Element Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Transfer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/transfer | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | Organization) | Referrer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/referrer | |
![]() ![]() ![]() |
1..1 | Identifier | A business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response. | |
![]() ![]() ![]() |
1..1 | code | Financial Resource Status Code Required Pattern: active | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Desired processing priority. A coding element defining the system and code of the priority. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: normal | |
![]() ![]() ![]() |
1..* | code | EligibilityRequestPurpose | |
![]() ![]() ![]() |
1..1 | Reference(SHAPatient) | The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA Patient | |
![]() ![]() ![]() |
0..1 | date, Period | Estimated date or dates of service Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
0..1 | date | The date or dates when the enclosed suite of services were performed or completed. Choice element: Either date or Period required | |
![]() ![]() ![]() ![]() |
0..1 | Period | The period when the enclosed suite of services were performed or completed. | |
![]() ![]() ![]() |
1..1 | dateTime | Creation date of this CoverageEligibilityRequest | |
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers. | |
![]() ![]() ![]() |
1..1 | Reference(Organization) | Coverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry. | |
![]() ![]() ![]() |
0..1 | Reference(Location) | Servicing Facility. reference to the provider organization resource | |
![]() ![]() ![]() |
1..* | BackboneElement | An element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request. | |
![]() ![]() ![]() ![]() |
1..1 | Reference(SHACoverage) | Insurance information. A Reference to the insurance coverage resource | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
![]() ![]() ![]() |
Σ | 1..1 | id | Item |
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about a resource |
![]() ![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Optional Extensions Element Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Transfer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/transfer | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | Organization) | Referrer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/referrer | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
1..1 | Identifier | A business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response. | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | Financial Resource Status Code Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active |
![]() ![]() ![]() |
1..1 | CodeableConcept | Desired processing priority. A coding element defining the system and code of the priority. Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: normal | |
![]() ![]() ![]() |
Σ | 1..* | code | EligibilityRequestPurpose Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. |
![]() ![]() ![]() |
Σ | 1..1 | Reference(SHAPatient) | The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA Patient |
![]() ![]() ![]() |
0..1 | Estimated date or dates of service Slice: Unordered, Closed by type:$this | ||
![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
0..1 | date | The date or dates when the enclosed suite of services were performed or completed. Choice element: Either date or Period required | |
![]() ![]() ![]() ![]() |
0..1 | Period | The period when the enclosed suite of services were performed or completed. | |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Creation date of this CoverageEligibilityRequest |
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers. | |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Coverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry. |
![]() ![]() ![]() |
0..1 | Reference(Location) | Servicing Facility. reference to the provider organization resource | |
![]() ![]() ![]() |
1..* | BackboneElement | An element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request. | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Reference(SHACoverage) | Insurance information. A Reference to the insurance coverage resource | |
![]() |
Path | Conformance | ValueSet / Code | URI |
CoverageEligibilityRequest.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
CoverageEligibilityRequest.priority | example | Pattern: normalhttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | |
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurposehttp://hl7.org/fhir/ValueSet/eligibilityrequest-purpose|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CoverageEligibilityRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CoverageEligibilityRequest | 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 | error | CoverageEligibilityRequest | 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 | error | CoverageEligibilityRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CoverageEligibilityRequest | A resource should have narrative for robust management : text.`div`.exists() | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |||||
![]() ![]() ![]() |
Σ | 1..1 | id | Item | ||||
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about a resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Optional Extensions Element Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Transfer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/transfer | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | Organization) | Referrer URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/referrer | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
1..1 | Identifier | A business unique identifier for the CoverageEligibilityRequest. This Identifier will be utilized in the CoverageEligibilityResponse prepared by the payer to reference and link the Request with the Response. | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | Financial Resource Status Code Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Desired processing priority. A coding element defining the system and code of the priority. Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: normal | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
Σ | 1..* | code | EligibilityRequestPurpose Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(SHAPatient) | The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. A reference to the Patient element within the bundle. SHA Patient | ||||
![]() ![]() ![]() |
0..1 | Estimated date or dates of service Slice: Unordered, Closed by type:$this | ||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
0..1 | date | The date or dates when the enclosed suite of services were performed or completed. Choice element: Either date or Period required | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period when the enclosed suite of services were performed or completed. | |||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Creation date of this CoverageEligibilityRequest | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Author | |||||
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request. A reference to the healthcare provider license issed by the regulator and maintained in the Health Worker Registry. Use the reference.identifier for well know identifiers. | |||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Coverage issuer. A reference to the payor organization license issed by the regulator and maintained in the Facility Registry. | ||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Servicing Facility. reference to the provider organization resource | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Supporting information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Information instance identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Resource) | Data to be provided | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Applies to all items | |||||
![]() ![]() ![]() |
1..* | BackboneElement | An element to include the insurance coverage of the member in case it is known by the provider at the time of preparing the eligiblity request. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Applicable coverage | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(SHACoverage) | Insurance information. A Reference to the insurance coverage resource | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Additional provider contract number | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Item to be evaluated for eligibiity | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable exception or supporting information | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Benefit classification Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision etc. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Perfoming practitioner | |||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Count of products or services | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Servicing facility | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Applicable diagnosis | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Nature of illness or problem Binding: ICD-10Codes (example): ICD10 Diagnostic codes. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Condition) | |||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Product or service details | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
CoverageEligibilityRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
CoverageEligibilityRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
CoverageEligibilityRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CoverageEligibilityRequest.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
CoverageEligibilityRequest.priority | example | Pattern: normalhttp://hl7.org/fhir/ValueSet/process-priority from the FHIR Standard | ||||
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurposehttp://hl7.org/fhir/ValueSet/eligibilityrequest-purpose|4.0.1 from the FHIR Standard | ||||
CoverageEligibilityRequest.item.category | example | BenefitCategoryCodeshttp://hl7.org/fhir/ValueSet/ex-benefitcategory from the FHIR Standard | ||||
CoverageEligibilityRequest.item.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
CoverageEligibilityRequest.item.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
CoverageEligibilityRequest.item.diagnosis.diagnosis[x] | example | ICD-10Codeshttp://hl7.org/fhir/ValueSet/icd-10 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CoverageEligibilityRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CoverageEligibilityRequest | 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 | error | CoverageEligibilityRequest | 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 | error | CoverageEligibilityRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CoverageEligibilityRequest | A resource should have narrative for robust management : text.`div`.exists() | |
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() |
This structure is derived from CoverageEligibilityRequest
Summary
Mandatory: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron