Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-CoverageEligibilityResponse-for-EligibilityResponse resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. EligibilityResponse | |
| Definition | This resource provides eligibility and plan details from the processing of an Eligibility resource. |
| Short | EligibilityResponse resource |
| Control | 0..* |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 2. EligibilityResponse.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. EligibilityResponse.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 20..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on EligibilityResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. EligibilityResponse.extension:purpose | |
| Slice Name | purpose |
| Definition | R4: |
| Short | R4: auth-requirements | benefits | discovery | validation (new) |
| Comments | Element |
| Control | 1..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: auth-requirements | benefits | discovery | validation (new)) (Extension Type: code) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. EligibilityResponse.extension:patient | |
| Slice Name | patient |
| Definition | R4: |
| Short | R4: Intended recipient of products and services (new) |
| Comments | Element |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Intended recipient of products and services (new)) (Extension Type: Reference(Cross-version Profile for R4.Patient for use in FHIR STU3, Patient)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. EligibilityResponse.extension:serviced | |
| Slice Name | serviced |
| Definition | R4: |
| Short | R4: Estimated date or dates of service (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Estimated date or dates of service (new)) (Extension Type: Choice of: date, Period) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. EligibilityResponse.extension:requestor | |
| Slice Name | requestor |
| Definition | R4: |
| Short | R4: Party responsible for the request |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 14. EligibilityResponse.extension:preAuthRef | |
| Slice Name | preAuthRef |
| Definition | R4: |
| Short | R4: Preauthorization reference (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Preauthorization reference (new)) (Extension Type: string) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. EligibilityResponse.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 18. EligibilityResponse.status | |
| Definition | The status of the resource instance. |
| Short | active | cancelled | draft | entered-in-error |
| Comments | This element is labeled as a modifier because the status contains codes that mark the response as not currently valid. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Financial Resource Status Codeshttp://hl7.org/fhir/ValueSet/fm-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/fm-status|3.0.2)A code specifying the state of the resource instance. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EligibilityResponse | |
| 2. EligibilityResponse.extension | |
| Control | 2..* |
| Slicing | This element introduces a set of slices on EligibilityResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. EligibilityResponse.extension:purpose | |
| Slice Name | purpose |
| Definition | R4: |
| Short | R4: auth-requirements | benefits | discovery | validation (new) |
| Comments | Element |
| Control | 1..* |
| Type | Extension(R4: auth-requirements | benefits | discovery | validation (new)) (Extension Type: code) |
| 6. EligibilityResponse.extension:patient | |
| Slice Name | patient |
| Definition | R4: |
| Short | R4: Intended recipient of products and services (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R4: Intended recipient of products and services (new)) (Extension Type: Reference(Cross-version Profile for R4.Patient for use in FHIR STU3, Patient)) |
| 8. EligibilityResponse.extension:serviced | |
| Slice Name | serviced |
| Definition | R4: |
| Short | R4: Estimated date or dates of service (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Estimated date or dates of service (new)) (Extension Type: Choice of: date, Period) |
| 10. EligibilityResponse.extension:requestor | |
| Slice Name | requestor |
| Definition | R4: |
| Short | R4: Party responsible for the request |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 12. EligibilityResponse.extension:preAuthRef | |
| Slice Name | preAuthRef |
| Definition | R4: |
| Short | R4: Preauthorization reference (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Preauthorization reference (new)) (Extension Type: string) |
| 14. EligibilityResponse.outcome | |
| 16. EligibilityResponse.outcome.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on EligibilityResponse.outcome.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. EligibilityResponse.outcome.extension:outcome | |
| Slice Name | outcome |
| Definition | R4: |
| Short | R4: queued | complete | error | partial |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R4: queued | complete | error | partial) (Extension Type: code) |
| 20. EligibilityResponse.insurance | |
| 22. EligibilityResponse.insurance.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on EligibilityResponse.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. EligibilityResponse.insurance.extension:benefitPeriod | |
| Slice Name | benefitPeriod |
| Definition | R4: |
| Short | R4: When the benefits are applicable (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: When the benefits are applicable (new)) (Extension Type: Period) |
| 26. EligibilityResponse.insurance.benefitBalance | |
| 28. EligibilityResponse.insurance.benefitBalance.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on EligibilityResponse.insurance.benefitBalance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. EligibilityResponse.insurance.benefitBalance.extension:modifier | |
| Slice Name | modifier |
| Definition | R4: |
| Short | R4: Product or service billing modifiers (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Product or service billing modifiers (new)) (Extension Type: CodeableConcept) |
| 32. EligibilityResponse.insurance.benefitBalance.extension:provider | |
| Slice Name | provider |
| Definition | R4: |
| Short | R4: Performing practitioner (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Performing practitioner (new)) (Extension Type: Reference(Cross-version Profile for R4.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R4.PractitionerRole for use in FHIR STU3, PractitionerRole)) |
| 34. EligibilityResponse.insurance.benefitBalance.extension:authorizationRequired | |
| Slice Name | authorizationRequired |
| Definition | R4: |
| Short | R4: Authorization required flag (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Authorization required flag (new)) (Extension Type: boolean) |
| 36. EligibilityResponse.insurance.benefitBalance.extension:authorizationSupporting | |
| Slice Name | authorizationSupporting |
| Definition | R4: |
| Short | R4: Type of required supporting materials (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Type of required supporting materials (new)) (Extension Type: CodeableConcept) |
| 38. EligibilityResponse.insurance.benefitBalance.extension:authorizationUrl | |
| Slice Name | authorizationUrl |
| Definition | R4: |
| Short | R4: Preauthorization requirements endpoint (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Preauthorization requirements endpoint (new)) (Extension Type: uri) |
| 40. EligibilityResponse.insurance.benefitBalance.financial | |
| 42. EligibilityResponse.insurance.benefitBalance.financial.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on EligibilityResponse.insurance.benefitBalance.financial.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. EligibilityResponse.insurance.benefitBalance.financial.extension:used | |
| Slice Name | used |
| Definition | R4: |
| Short | R4: used additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: used additional types) (Extension Type: string) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EligibilityResponse | |||||
| Definition | This resource provides eligibility and plan details from the processing of an Eligibility resource. | ||||
| Short | EligibilityResponse resource | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 2. EligibilityResponse.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. EligibilityResponse.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. EligibilityResponse.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. EligibilityResponse.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. EligibilityResponse.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. EligibilityResponse.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. EligibilityResponse.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 2..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on EligibilityResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. EligibilityResponse.extension:purpose | |||||
| Slice Name | purpose | ||||
| Definition | R4: | ||||
| Short | R4: auth-requirements | benefits | discovery | validation (new) | ||||
| Comments | Element | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: auth-requirements | benefits | discovery | validation (new)) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. EligibilityResponse.extension:patient | |||||
| Slice Name | patient | ||||
| Definition | R4: | ||||
| Short | R4: Intended recipient of products and services (new) | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Intended recipient of products and services (new)) (Extension Type: Reference(Cross-version Profile for R4.Patient for use in FHIR STU3, Patient)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. EligibilityResponse.extension:serviced | |||||
| Slice Name | serviced | ||||
| Definition | R4: | ||||
| Short | R4: Estimated date or dates of service (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Estimated date or dates of service (new)) (Extension Type: Choice of: date, Period) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. EligibilityResponse.extension:requestor | |||||
| Slice Name | requestor | ||||
| Definition | R4: | ||||
| Short | R4: Party responsible for the request | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 24. EligibilityResponse.extension:preAuthRef | |||||
| Slice Name | preAuthRef | ||||
| Definition | R4: | ||||
| Short | R4: Preauthorization reference (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Preauthorization reference (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. EligibilityResponse.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 28. EligibilityResponse.identifier | |||||
| Definition | The Response business identifier. | ||||
| Short | Business Identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| 30. EligibilityResponse.status | |||||
| Definition | The status of the resource instance. | ||||
| Short | active | cancelled | draft | entered-in-error | ||||
| Comments | This element is labeled as a modifier because the status contains codes that mark the response as not currently valid. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from Financial Resource Status Codes (required to http://hl7.org/fhir/ValueSet/fm-status|3.0.2)A code specifying the state of the resource instance. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 32. EligibilityResponse.created | |||||
| Definition | The date when the enclosed suite of services were performed or completed. | ||||
| Short | Creation date | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 34. EligibilityResponse.requestProvider | |||||
| Definition | The practitioner who is responsible for the services rendered to the patient. | ||||
| Short | Responsible practitioner | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner) | ||||
| 36. EligibilityResponse.requestOrganization | |||||
| Definition | The organization which is responsible for the services rendered to the patient. | ||||
| Short | Responsible organization | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| 38. EligibilityResponse.request | |||||
| Definition | Original request resource reference. | ||||
| Short | Eligibility reference | ||||
| Control | 0..1 | ||||
| Type | Reference(EligibilityRequest) | ||||
| 40. EligibilityResponse.outcome | |||||
| Definition | Transaction status: error, complete. | ||||
| Short | complete | error | partial | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from Claim Processing Codes ![]() (required to http://hl7.org/fhir/ValueSet/remittance-outcome|3.0.2)The outcome of the processing. | ||||
| Type | CodeableConcept | ||||
| 42. EligibilityResponse.outcome.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 44. EligibilityResponse.outcome.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on EligibilityResponse.outcome.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 46. EligibilityResponse.outcome.extension:outcome | |||||
| Slice Name | outcome | ||||
| Definition | R4: | ||||
| Short | R4: queued | complete | error | partial | ||||
| Comments | Element | ||||
| Control | 1..1 | ||||
| Type | Extension(R4: queued | complete | error | partial) (Extension Type: code) | ||||
| 48. EligibilityResponse.outcome.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..* | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
| 50. EligibilityResponse.outcome.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
| 52. EligibilityResponse.disposition | |||||
| Definition | A description of the status of the adjudication. | ||||
| Short | Disposition Message | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 54. EligibilityResponse.insurer | |||||
| Definition | The Insurer who produced this adjudicated response. | ||||
| Short | Insurer issuing the coverage | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| 56. EligibilityResponse.inforce | |||||
| Definition | Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates. | ||||
| Short | Coverage inforce indicator | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 58. EligibilityResponse.insurance | |||||
| Definition | The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer. | ||||
| Short | Details by insurance coverage | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 60. EligibilityResponse.insurance.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 62. EligibilityResponse.insurance.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on EligibilityResponse.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 64. EligibilityResponse.insurance.extension:benefitPeriod | |||||
| Slice Name | benefitPeriod | ||||
| Definition | R4: | ||||
| Short | R4: When the benefits are applicable (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: When the benefits are applicable (new)) (Extension Type: Period) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 66. EligibilityResponse.insurance.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 68. EligibilityResponse.insurance.coverage | |||||
| Definition | A suite of updated or additional Coverages from the Insurer. | ||||
| Short | Updated Coverage details | ||||
| Control | 0..1 | ||||
| Type | Reference(Coverage) | ||||
| 70. EligibilityResponse.insurance.contract | |||||
| Definition | The contract resource which may provide more detailed information. | ||||
| Short | Contract details | ||||
| Control | 0..1 | ||||
| Type | Reference(Contract) | ||||
| 72. EligibilityResponse.insurance.benefitBalance | |||||
| Definition | Benefits and optionally current balances by Category. | ||||
| Short | Benefits by Category | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 74. EligibilityResponse.insurance.benefitBalance.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 76. EligibilityResponse.insurance.benefitBalance.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on EligibilityResponse.insurance.benefitBalance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 78. EligibilityResponse.insurance.benefitBalance.extension:modifier | |||||
| Slice Name | modifier | ||||
| Definition | R4: | ||||
| Short | R4: Product or service billing modifiers (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Product or service billing modifiers (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 80. EligibilityResponse.insurance.benefitBalance.extension:provider | |||||
| Slice Name | provider | ||||
| Definition | R4: | ||||
| Short | R4: Performing practitioner (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Performing practitioner (new)) (Extension Type: Reference(Cross-version Profile for R4.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R4.PractitionerRole for use in FHIR STU3, PractitionerRole)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 82. EligibilityResponse.insurance.benefitBalance.extension:authorizationRequired | |||||
| Slice Name | authorizationRequired | ||||
| Definition | R4: | ||||
| Short | R4: Authorization required flag (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Authorization required flag (new)) (Extension Type: boolean) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 84. EligibilityResponse.insurance.benefitBalance.extension:authorizationSupporting | |||||
| Slice Name | authorizationSupporting | ||||
| Definition | R4: | ||||
| Short | R4: Type of required supporting materials (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Type of required supporting materials (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 86. EligibilityResponse.insurance.benefitBalance.extension:authorizationUrl | |||||
| Slice Name | authorizationUrl | ||||
| Definition | R4: | ||||
| Short | R4: Preauthorization requirements endpoint (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Preauthorization requirements endpoint (new)) (Extension Type: uri) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 88. EligibilityResponse.insurance.benefitBalance.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 90. EligibilityResponse.insurance.benefitBalance.category | |||||
| Definition | Dental, Vision, Medical, Pharmacy, Rehab etc. | ||||
| Short | Type of services covered | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see Benefit Category Codes (example to http://hl7.org/fhir/ValueSet/benefit-category|3.0.2)Benefit categories such as: oral, medical, vision etc. | ||||
| Type | CodeableConcept | ||||
| 92. EligibilityResponse.insurance.benefitBalance.subCategory | |||||
| Definition | Dental: basic, major, ortho; Vision exam, glasses, contacts; etc. | ||||
| Short | Detailed services covered within the type | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Benefit SubCategory Codes (example to http://hl7.org/fhir/ValueSet/benefit-subcategory|3.0.2)Benefit subcategories such as: oral-basic, major, glasses | ||||
| Type | CodeableConcept | ||||
| 94. EligibilityResponse.insurance.benefitBalance.excluded | |||||
| Definition | True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage. | ||||
| Short | Excluded from the plan | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 96. EligibilityResponse.insurance.benefitBalance.name | |||||
| Definition | A short name or tag for the benefit, for example MED01, or DENT2. | ||||
| Short | Short name for the benefit | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 98. EligibilityResponse.insurance.benefitBalance.description | |||||
| Definition | A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services'. | ||||
| Short | Description of the benefit or services covered | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 100. EligibilityResponse.insurance.benefitBalance.network | |||||
| Definition | Network designation. | ||||
| Short | In or out of network | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Network Type Codes (example to http://hl7.org/fhir/ValueSet/benefit-network|3.0.2)Code to classify in or out of network services | ||||
| Type | CodeableConcept | ||||
| 102. EligibilityResponse.insurance.benefitBalance.unit | |||||
| Definition | Unit designation: individual or family. | ||||
| Short | Individual or family | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Unit Type Codes (example to http://hl7.org/fhir/ValueSet/benefit-unit|3.0.2)Unit covered/serviced - individual or family | ||||
| Type | CodeableConcept | ||||
| 104. EligibilityResponse.insurance.benefitBalance.term | |||||
| Definition | The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual vistis'. | ||||
| Short | Annual or lifetime | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Benefit Term Codes (example to http://hl7.org/fhir/ValueSet/benefit-term|3.0.2)Coverage unit - annual, lifetime | ||||
| Type | CodeableConcept | ||||
| 106. EligibilityResponse.insurance.benefitBalance.financial | |||||
| Definition | Benefits Used to date. | ||||
| Short | Benefit Summary | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 108. EligibilityResponse.insurance.benefitBalance.financial.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 110. EligibilityResponse.insurance.benefitBalance.financial.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on EligibilityResponse.insurance.benefitBalance.financial.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 112. EligibilityResponse.insurance.benefitBalance.financial.extension:used | |||||
| Slice Name | used | ||||
| Definition | R4: | ||||
| Short | R4: used additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: used additional types) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 114. EligibilityResponse.insurance.benefitBalance.financial.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 116. EligibilityResponse.insurance.benefitBalance.financial.type | |||||
| Definition | Deductable, visits, benefit amount. | ||||
| Short | Deductable, visits, benefit amount | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see Benefit Type Codes (example to http://hl7.org/fhir/ValueSet/benefit-type|3.0.2)Deductable, visits, co-pay, etc. | ||||
| Type | CodeableConcept | ||||
| 118. EligibilityResponse.insurance.benefitBalance.financial.allowed[x] | |||||
| Definition | Benefits allowed. | ||||
| Short | Benefits allowed | ||||
| Control | 0..1 | ||||
| Type | Choice of: unsignedInt, string, Money | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 120. EligibilityResponse.insurance.benefitBalance.financial.used[x] | |||||
| Definition | Benefits used. | ||||
| Short | Benefits used | ||||
| Control | 0..1 | ||||
| Type | Choice of: unsignedInt, Money | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 122. EligibilityResponse.form | |||||
| Definition | The form to be used for printing the content. | ||||
| Short | Printed Form Identifier | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Form Codes (example to http://hl7.org/fhir/ValueSet/forms|3.0.2)The forms codes. | ||||
| Type | CodeableConcept | ||||
| 124. EligibilityResponse.error | |||||
| Definition | Mutually exclusive with Services Provided (Item). | ||||
| Short | Processing errors | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 126. EligibilityResponse.error.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 128. EligibilityResponse.error.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 130. EligibilityResponse.error.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 132. EligibilityResponse.error.code | |||||
| Definition | An error code,from a specified code system, which details why the eligibility check could not be performed. | ||||
| Short | Error code detailing processing issues | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see Adjudication Error Codes (example to http://hl7.org/fhir/ValueSet/adjudication-error|3.0.2)The error codes for adjudication processing. | ||||
| Type | CodeableConcept | ||||