Universal API Implementation Guide
1.1.19 - ci-build
Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions
Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-coverage-eligibility-request | Version: 1.1.19 | |||
Active as of 2020-12-11 | Responsible: Genentech USIX PE |
Realm: |
Computable Name: UapiCoverageEligibilityRequest |
This profile constrains the CoverageEligibilityRequest resource to be used in sharing service request results in UAPI
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 | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest ServiceRequestType URL: https://fhir.developer.gene.com/StructureDefinition/SRType Binding: UAPI Value Set - Service Request Type (required) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest Product URL: https://fhir.developer.gene.com/StructureDefinition/Product Binding: UAPI Value Set - Product Name (required) | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest ServiceRequestType URL: https://fhir.developer.gene.com/StructureDefinition/SRType Binding: UAPI Value Set - Service Request Type (required) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest Product URL: https://fhir.developer.gene.com/StructureDefinition/Product Binding: UAPI Value Set - Product Name (required) | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
![]() ![]() ![]() | Σ | 1..* | code | auth-requirements | benefits | discovery | validation Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. |
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient) | Intended recipient of products and services |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Creation date |
![]() ![]() ![]() | Σ | 1..1 | Reference(Organization) | Coverage issuer |
![]() |
Path | Conformance | ValueSet |
CoverageEligibilityRequest.status | required | FinancialResourceStatusCodes |
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurpose |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest ServiceRequestType URL: https://fhir.developer.gene.com/StructureDefinition/SRType Binding: UAPI Value Set - Service Request Type (required) | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest Product URL: https://fhir.developer.gene.com/StructureDefinition/Product Binding: UAPI Value Set - Product Name (required) | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | 0..* | Identifier | Business Identifier for coverage eligiblity request | |||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Desired processing priority Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. | |||||
![]() ![]() ![]() | Σ | 1..* | code | auth-requirements | benefits | discovery | validation Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient) | Intended recipient of products and services | ||||
![]() ![]() ![]() | 0..1 | Estimated date or dates of service | ||||||
![]() ![]() ![]() ![]() | date | |||||||
![]() ![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() | Σ | 1..1 | dateTime | Creation date | ||||
![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole) | Author | |||||
![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request | |||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Organization) | Coverage issuer | ||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Servicing facility | |||||
![]() ![]() ![]() | 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 | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Patient insurance 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Applicable coverage | |||||
![]() ![]() ![]() ![]() | 1..1 | Reference(Coverage) | Insurance information | |||||
![]() ![]() ![]() ![]() | 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 | ||||
CoverageEligibilityRequest.language | preferred | CommonLanguages
| ||||
CoverageEligibilityRequest.status | required | FinancialResourceStatusCodes | ||||
CoverageEligibilityRequest.priority | example | ProcessPriorityCodes | ||||
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurpose | ||||
CoverageEligibilityRequest.item.category | example | BenefitCategoryCodes | ||||
CoverageEligibilityRequest.item.productOrService | example | USCLSCodes | ||||
CoverageEligibilityRequest.item.modifier | example | ModifierTypeCodes | ||||
CoverageEligibilityRequest.item.diagnosis.diagnosis[x] | example | ICD-10Codes |
This structure is derived from CoverageEligibilityRequest
Differential View
This structure is derived from CoverageEligibilityRequest
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest ServiceRequestType URL: https://fhir.developer.gene.com/StructureDefinition/SRType Binding: UAPI Value Set - Service Request Type (required) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest Product URL: https://fhir.developer.gene.com/StructureDefinition/Product Binding: UAPI Value Set - Product Name (required) | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest ServiceRequestType URL: https://fhir.developer.gene.com/StructureDefinition/SRType Binding: UAPI Value Set - Service Request Type (required) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest Product URL: https://fhir.developer.gene.com/StructureDefinition/Product Binding: UAPI Value Set - Product Name (required) | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
![]() ![]() ![]() | Σ | 1..* | code | auth-requirements | benefits | discovery | validation Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. |
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient) | Intended recipient of products and services |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Creation date |
![]() ![]() ![]() | Σ | 1..1 | Reference(Organization) | Coverage issuer |
![]() |
Path | Conformance | ValueSet |
CoverageEligibilityRequest.status | required | FinancialResourceStatusCodes |
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurpose |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | CoverageEligibilityRequest | CoverageEligibilityRequest resource | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest ServiceRequestType URL: https://fhir.developer.gene.com/StructureDefinition/SRType Binding: UAPI Value Set - Service Request Type (required) | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | UAPI CoverageEligibilityRequest Product URL: https://fhir.developer.gene.com/StructureDefinition/Product Binding: UAPI Value Set - Product Name (required) | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | 0..* | Identifier | Business Identifier for coverage eligiblity request | |||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Desired processing priority Binding: ProcessPriorityCodes (example): The timeliness with which processing is required: STAT, normal, Deferred. | |||||
![]() ![]() ![]() | Σ | 1..* | code | auth-requirements | benefits | discovery | validation Binding: EligibilityRequestPurpose (required): A code specifying the types of information being requested. | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient) | Intended recipient of products and services | ||||
![]() ![]() ![]() | 0..1 | Estimated date or dates of service | ||||||
![]() ![]() ![]() ![]() | date | |||||||
![]() ![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() | Σ | 1..1 | dateTime | Creation date | ||||
![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole) | Author | |||||
![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request | |||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Organization) | Coverage issuer | ||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Servicing facility | |||||
![]() ![]() ![]() | 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 | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Patient insurance 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Applicable coverage | |||||
![]() ![]() ![]() ![]() | 1..1 | Reference(Coverage) | Insurance information | |||||
![]() ![]() ![]() ![]() | 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 | ||||
CoverageEligibilityRequest.language | preferred | CommonLanguages
| ||||
CoverageEligibilityRequest.status | required | FinancialResourceStatusCodes | ||||
CoverageEligibilityRequest.priority | example | ProcessPriorityCodes | ||||
CoverageEligibilityRequest.purpose | required | EligibilityRequestPurpose | ||||
CoverageEligibilityRequest.item.category | example | BenefitCategoryCodes | ||||
CoverageEligibilityRequest.item.productOrService | example | USCLSCodes | ||||
CoverageEligibilityRequest.item.modifier | example | ModifierTypeCodes | ||||
CoverageEligibilityRequest.item.diagnosis.diagnosis[x] | example | ICD-10Codes |
This structure is derived from CoverageEligibilityRequest
Other representations of profile: CSV, Excel, Schematron