Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2025-06-23 |
Definitions for the eligibility-response resource profile.
Guidance on how to interpret the contents of this table can be found here
0. CoverageEligibilityResponse | |
Invariants | BV-00539: CoverageEligibilityResponse.status SHALL use the fixed value 'active'. (status.exists() implies status = 'active' )ksa-purpose-unique-code: Purpose code values must be unique. ( purpose.exists() implies purpose.isDistinct() )BV-00310: CoverageEligibilityResponse.disposition SHALL have maximum length of 250 English characters and 125 Arabic characters. ( disposition.exists() implies disposition.length() <= 250 )BV-00315: CoverageEligibilityResponse.preAuthRef SHALL have maximum length of 40 characters. ( preAuthRef.exists() implies preAuthRef.length() <= 40 )BV-00503: CoverageEligibiltyResponse.extension.siteEligibility SHALL be provided when CoverageEligibiltyResponse.outcome='complete'. ( outcome.exists() implies (outcome = 'complete' implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').exists()) )BV-00535: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.inforce value is 'false'. ( iif( (insurance.where(inforce = true).count() = 0) and (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count()=1), iif((extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.first().code='eligible') ,false,true), true) )BV-00536: The CoverageEligibilityResponse.error SHALL be provided when CoverageEligibilityResponse.outcome= 'error'. ( outcome.exists() implies (outcome = 'error' implies error.exists()) )BV-00559: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL be 'eligible' if at least in one array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is 'eligible'. ( iif( insurance.extension.exists(), iif( (insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), iif( extension.exists(), (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), true), false), true) )BV-00561: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is not 'eligible'. ( iif( (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count() = 1), iif(extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').first().value.ofType(CodeableConcept).coding.first().code='eligible', iif(insurance.extension.exists(),insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').select(value.ofType(CodeableConcept).coding.select(code='eligible').count()>0),false),false), true) ) |
2. CoverageEligibilityResponse.id | |
Control | 1..? |
Max Length: | 64 |
4. CoverageEligibilityResponse.meta | |
Control | 1..? |
6. CoverageEligibilityResponse.meta.profile | |
Control | 1..? |
Type | canonical(DP_canonical)(StructureDefinition) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. CoverageEligibilityResponse.extension | |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
10. CoverageEligibilityResponse.extension:siteEligibility | |
Slice Name | siteEligibility |
Control | 0..1 |
Type | Extension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept)) |
Must Support | true |
12. CoverageEligibilityResponse.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier(DP_Identifier_A) |
14. CoverageEligibilityResponse.identifier.type | |
Binding | The codes SHALL be taken from Identifier Type Codes (required to http://hl7.org/fhir/ValueSet/identifier-type ) |
16. CoverageEligibilityResponse.status | |
Pattern Value | active |
18. CoverageEligibilityResponse.purpose | |
Binding | The codes SHALL be taken from EligibilityResponsePurpose (required to http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose ) |
Type | code(DP_code) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. CoverageEligibilityResponse.patient | |
Type | Reference(DP_Reference_1or2a)(Nphies Patient) |
22. CoverageEligibilityResponse.patient.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
24. CoverageEligibilityResponse.patient.identifier.type | |
Binding | The codes SHALL be taken from Patient Identifier Type (required to http://nphies.sa/terminology/ValueSet/patient-identifier-type ) |
26. CoverageEligibilityResponse.serviced[x] | |
Control | 1..? |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.serviced[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. CoverageEligibilityResponse.serviced[x]:servicedDate | |
Slice Name | servicedDate |
Control | 0..1 |
Type | date(DP_date) |
[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 |
Must Support | true |
30. CoverageEligibilityResponse.serviced[x]:servicedPeriod | |
Slice Name | servicedPeriod |
Control | 0..1 |
Type | Period(DP_Period_2) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
32. CoverageEligibilityResponse.created | |
Type | dateTime(DP_dateTime) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. CoverageEligibilityResponse.request | |
Type | Reference(DP_Reference_1or3a)(Nphies CoverageEligibilityRequest) |
36. CoverageEligibilityResponse.outcome | |
Type | code(DP_code) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. CoverageEligibilityResponse.disposition | |
Must Support | true |
Max Length: | 250 |
40. CoverageEligibilityResponse.insurer | |
Type | Reference(DP_Reference_1or2a)(Nphies Insurer Organization) |
42. CoverageEligibilityResponse.insurer.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
44. CoverageEligibilityResponse.insurer.identifier.type | |
Binding | The codes SHALL be taken from Organization Identifier (required to http://nphies.sa/terminology/ValueSet/organization-identifier-type ) |
46. CoverageEligibilityResponse.insurance | |
Must Support | true |
48. CoverageEligibilityResponse.insurance.extension | |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
50. CoverageEligibilityResponse.insurance.extension:siteEligibility | |
Slice Name | siteEligibility |
Control | 0..1 |
Type | Extension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept)) |
Must Support | true |
52. CoverageEligibilityResponse.insurance.coverage | |
Type | Reference(DP_Reference_1or2a)(Nphies Coverage) |
54. CoverageEligibilityResponse.insurance.coverage.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
56. CoverageEligibilityResponse.insurance.coverage.identifier.type | |
Binding | The codes SHALL be taken from Identifier Type Codes (required to http://hl7.org/fhir/ValueSet/identifier-type ) |
58. CoverageEligibilityResponse.insurance.inforce | |
Control | 1..? |
60. CoverageEligibilityResponse.insurance.benefitPeriod | |
Type | Period(DP_Period_2) |
Must Support | true |
62. CoverageEligibilityResponse.insurance.item | |
Must Support | true |
Invariants | BV-00311: CoverageEligibilityResponse.insurance.item.name SHALL have maximum length of 100 English characters and 50 Arabic characters. (name.exists() implies name.length() <= 100 )BV-00312: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. ( name.exists() implies name.length() <= 60 ) |
64. CoverageEligibilityResponse.insurance.item.category | |
Binding | The codes SHALL be taken from Benefit Category (required to http://nphies.sa/terminology/ValueSet/benefit-category ) |
Type | CodeableConcept(DP_CodeableConcept) |
Must Support | true |
66. CoverageEligibilityResponse.insurance.item.excluded | |
Must Support | true |
68. CoverageEligibilityResponse.insurance.item.name | |
Must Support | true |
Max Length: | 100 |
70. CoverageEligibilityResponse.insurance.item.description | |
Must Support | true |
Max Length: | 250 |
72. CoverageEligibilityResponse.insurance.item.network | |
Control | 1..? |
Binding | The codes SHALL be taken from NetworkTypeCodes (required to http://hl7.org/fhir/ValueSet/benefit-network ) |
Type | CodeableConcept(DP_CodeableConcept) |
74. CoverageEligibilityResponse.insurance.item.unit | |
Control | 1..? |
Binding | The codes SHALL be taken from UnitTypeCodes (required to http://hl7.org/fhir/ValueSet/benefit-unit ) |
Type | CodeableConcept(DP_CodeableConcept) |
76. CoverageEligibilityResponse.insurance.item.term | |
Control | 1..? |
Binding | The codes SHALL be taken from BenefitTermCodes (required to http://hl7.org/fhir/ValueSet/benefit-term ) |
Type | CodeableConcept(DP_CodeableConcept) |
78. CoverageEligibilityResponse.insurance.item.benefit | |
Must Support | true |
Invariants | BV-00313: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. (allowed.ofType(string).exists() implies allowed.ofType(string).length() <= 60 )BV-00314: CoverageEligibilityResponse.insurance.item.benefit.usedString SHALL have maximum length of 60 characters. ( used.ofType(string).exists() implies used.ofType(string).length() <= 60 ) |
80. CoverageEligibilityResponse.insurance.item.benefit.type | |
Binding | The codes SHALL be taken from Benefit Type (required to http://nphies.sa/terminology/ValueSet/benefit-type ) |
Type | CodeableConcept(DP_CodeableConcept) |
82. CoverageEligibilityResponse.insurance.item.benefit.allowed[x] | |
Control | 1..? |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.allowed[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
84. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedUnsignedInt | |
Slice Name | allowedUnsignedInt |
Control | 0..1 |
Type | unsignedInt(DP_unsignedInt) |
[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 |
Must Support | true |
86. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedString | |
Slice Name | allowedString |
Control | 0..1 |
Type | string |
[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 |
Must Support | true |
Max Length: | 60 |
88. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedMoney | |
Slice Name | allowedMoney |
Control | 0..1 |
Type | Money(DP_Money_SAR) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Invariants | BV-00084: CoverageEligibilityResponse.insurance.item.benefit.allowedMoney.currency SHALL be SAR (currency.exists() implies currency ='SAR' ) |
90. CoverageEligibilityResponse.insurance.item.benefit.used[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.used[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
92. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedUnsignedInt | |
Slice Name | usedUnsignedInt |
Control | 0..1 |
Type | unsignedInt(DP_unsignedInt) |
[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 |
Must Support | true |
94. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedString | |
Slice Name | usedString |
Control | 0..1 |
Type | string |
[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 |
Must Support | true |
Max Length: | 60 |
96. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedMoney | |
Slice Name | usedMoney |
Control | 0..1 |
Type | Money(DP_Money_SAR) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Invariants | BV-00085: CoverageEligibilityResponse.insurance.item.benefit.used.currency SHALL be SAR (currency.exists() implies currency ='SAR' ) |
98. CoverageEligibilityResponse.error | |
Must Support | true |
100. CoverageEligibilityResponse.error.extension | |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.error.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
102. CoverageEligibilityResponse.error.extension:expression | |
Slice Name | expression |
Control | 0..1 |
Type | Extension(Error Expression) (Extension Type: string) |
Must Support | true |
104. CoverageEligibilityResponse.error.code | |
Binding | The codes SHALL be taken from Adjudication Error Codes (required to http://nphies.sa/terminology/ValueSet/adjudication-error ) |
Type | CodeableConcept(DP_CodeableConcept) |
Guidance on how to interpret the contents of this table can be found here
0. CoverageEligibilityResponse | |
Definition | This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource. |
Short | CoverageEligibilityResponse resource |
Control | 0..* |
Is Modifier | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) BV-00539: CoverageEligibilityResponse.status SHALL use the fixed value 'active'. ( status.exists() implies status = 'active' )ksa-purpose-unique-code: Purpose code values must be unique. ( purpose.exists() implies purpose.isDistinct() )BV-00310: CoverageEligibilityResponse.disposition SHALL have maximum length of 250 English characters and 125 Arabic characters. ( disposition.exists() implies disposition.length() <= 250 )BV-00315: CoverageEligibilityResponse.preAuthRef SHALL have maximum length of 40 characters. ( preAuthRef.exists() implies preAuthRef.length() <= 40 )BV-00503: CoverageEligibiltyResponse.extension.siteEligibility SHALL be provided when CoverageEligibiltyResponse.outcome='complete'. ( outcome.exists() implies (outcome = 'complete' implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').exists()) )BV-00535: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.inforce value is 'false'. ( iif( (insurance.where(inforce = true).count() = 0) and (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count()=1), iif((extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.first().code='eligible') ,false,true), true) )BV-00536: The CoverageEligibilityResponse.error SHALL be provided when CoverageEligibilityResponse.outcome= 'error'. ( outcome.exists() implies (outcome = 'error' implies error.exists()) )BV-00559: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL be 'eligible' if at least in one array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is 'eligible'. ( iif( insurance.extension.exists(), iif( (insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), iif( extension.exists(), (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), true), false), true) )BV-00561: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is not 'eligible'. ( iif( (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count() = 1), iif(extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').first().value.ofType(CodeableConcept).coding.first().code='eligible', iif(insurance.extension.exists(),insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').select(value.ofType(CodeableConcept).coding.select(code='eligible').count()>0),false),false), true) ) |
2. CoverageEligibilityResponse.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 | 10..1 |
Type | idstring |
Is Modifier | false |
Summary | true |
Max Length: | 64 |
4. CoverageEligibilityResponse.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Short | Metadata about the resource |
Control | 10..1 |
Type | Meta |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
6. CoverageEligibilityResponse.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Short | Profiles this resource claims to conform to |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Control | 10..* |
Type | canonical(DP_canonical)(StructureDefinition) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. CoverageEligibilityResponse.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. CoverageEligibilityResponse.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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 can 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 | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
12. CoverageEligibilityResponse.extension:siteEligibility | |
Slice Name | siteEligibility |
Definition | Code to indicate whether the patient is eligible or not eligible and why. |
Short | Site Eligibility |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept)) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
14. CoverageEligibilityResponse.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
16. CoverageEligibilityResponse.identifier | |
Definition | A unique identifier assigned to this coverage eligiblity request. |
Short | Business Identifier for coverage eligiblity request |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..1* |
Type | Identifier(DP_Identifier_A) |
Is Modifier | false |
Summary | false |
Requirements | Allows coverage eligibility requests to be distinguished and referenced. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. CoverageEligibilityResponse.identifier.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. CoverageEligibilityResponse.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 0..1 |
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type (required to http://hl7.org/fhir/ValueSet/identifier-type ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. CoverageEligibilityResponse.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 10..1 |
Type | uri(DP_uri) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. CoverageEligibilityResponse.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | The value that is unique |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Max Length: | 50 |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. CoverageEligibilityResponse.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 resource as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1 )A code specifying the state of the resource instance. |
Type | code |
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. |
Pattern Value | active |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. CoverageEligibilityResponse.purpose | |
Definition | Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified. |
Short | auth-requirements | benefits | discovery | validation |
Control | 1..* |
Binding | The codes SHALL be taken from EligibilityResponsePurposehttp://hl7.org/fhir/ValueSet/eligibilityresponse-purpose|4.0.1 (required to http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose ) |
Type | code(DP_code) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | To indicate the processing actions requested. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. CoverageEligibilityResponse.patient | |
Definition | The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. |
Short | Intended recipient of products and services |
Control | 1..1 |
Type | Reference(DP_Reference_1or2a)(Nphies Patient, Patient) |
Is Modifier | false |
Summary | true |
Requirements | Required to provide context and coverage validation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. CoverageEligibilityResponse.patient.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Short | Literal reference, Relative, internal or absolute URL |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Max Length: | 250 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. CoverageEligibilityResponse.patient.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Short | Logical reference, when literal reference is not known |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. CoverageEligibilityResponse.patient.identifier.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. CoverageEligibilityResponse.patient.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 10..1 |
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Patient Identifier Typehttp://hl7.org/fhir/ValueSet/identifier-type (required to http://nphies.sa/terminology/ValueSet/patient-identifier-type ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. CoverageEligibilityResponse.patient.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 10..1 |
Type | uri(DP_uri) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. CoverageEligibilityResponse.patient.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | The value that is unique |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Max Length: | 50 |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. CoverageEligibilityResponse.patient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Short | Text alternative for the resource |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Max Length: | 200 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. CoverageEligibilityResponse.serviced[x] | |
Definition | The date or dates when the enclosed suite of services were performed or completed. |
Short | Estimated date or dates of service |
Control | 10..1 |
Type | Choice of: date, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Required to provide time context for the request. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.serviced[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
48. CoverageEligibilityResponse.serviced[x]:servicedDate | |
Slice Name | servicedDate |
Definition | The date or dates when the enclosed suite of services were performed or completed. |
Short | Estimated date or dates of service |
Control | 0..1 |
Type | date(DP_date), Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Required to provide time context for the request. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
50. CoverageEligibilityResponse.serviced[x]:servicedPeriod | |
Slice Name | servicedPeriod |
Definition | The date or dates when the enclosed suite of services were performed or completed. |
Short | Estimated date or dates of service |
Control | 0..1 |
Type | Period(DP_Period_2), date |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Required to provide time context for the request. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. CoverageEligibilityResponse.created | |
Definition | The date this resource was created. |
Short | Response creation date |
Control | 1..1 |
Type | dateTime(DP_dateTime) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to record a timestamp for use by both the recipient and the issuer. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. CoverageEligibilityResponse.request | |
Definition | Reference to the original request resource. |
Short | Eligibility request reference |
Control | 1..1 |
Type | Reference(DP_Reference_1or3a)(Nphies CoverageEligibilityRequest, CoverageEligibilityRequest) |
Is Modifier | false |
Summary | true |
Requirements | Needed to allow the response to be linked to the request. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
56. CoverageEligibilityResponse.outcome | |
Definition | The outcome of the request processing. |
Short | queued | complete | error | partial |
Comments | The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete). |
Control | 1..1 |
Binding | The codes SHALL be taken from ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 (required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 )The outcome of the processing. |
Type | code(DP_code) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | To advise the requestor of an overall processing outcome. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. CoverageEligibilityResponse.disposition | |
Definition | A human readable description of the status of the adjudication. |
Short | Disposition Message |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Provided for user display. |
Max Length: | 250 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
60. CoverageEligibilityResponse.insurer | |
Definition | The Insurer who issued the coverage in question and is the author of the response. |
Short | Coverage issuer |
Control | 1..1 |
Type | Reference(DP_Reference_1or2a)(Nphies Insurer Organization, Organization) |
Is Modifier | false |
Summary | true |
Requirements | Need to identify the author. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
62. CoverageEligibilityResponse.insurer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Short | Literal reference, Relative, internal or absolute URL |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Max Length: | 250 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. CoverageEligibilityResponse.insurer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Short | Logical reference, when literal reference is not known |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. CoverageEligibilityResponse.insurer.identifier.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. CoverageEligibilityResponse.insurer.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 10..1 |
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Organization Identifierhttp://hl7.org/fhir/ValueSet/identifier-type (required to http://nphies.sa/terminology/ValueSet/organization-identifier-type ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
70. CoverageEligibilityResponse.insurer.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 10..1 |
Type | uri(DP_uri) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. CoverageEligibilityResponse.insurer.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | The value that is unique |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Max Length: | 50 |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. CoverageEligibilityResponse.insurer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Short | Text alternative for the resource |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Max Length: | 200 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
76. CoverageEligibilityResponse.insurance | |
Definition | Financial instruments for reimbursement for the health care products and services. |
Short | Patient insurance information |
Comments | All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | There must be at least one coverage for which eligibility is requested. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
78. CoverageEligibilityResponse.insurance.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
80. CoverageEligibilityResponse.insurance.extension:siteEligibility | |
Slice Name | siteEligibility |
Definition | Code to indicate whether the patient is eligible or not eligible and why. |
Short | Site Eligibility |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept)) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
82. CoverageEligibilityResponse.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
84. CoverageEligibilityResponse.insurance.coverage | |
Definition | Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. |
Short | Insurance information |
Control | 1..1 |
Type | Reference(DP_Reference_1or2a)(Nphies Coverage, Coverage) |
Is Modifier | false |
Summary | true |
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
86. CoverageEligibilityResponse.insurance.coverage.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Short | Literal reference, Relative, internal or absolute URL |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Max Length: | 250 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
88. CoverageEligibilityResponse.insurance.coverage.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Short | Logical reference, when literal reference is not known |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. CoverageEligibilityResponse.insurance.coverage.identifier.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
92. CoverageEligibilityResponse.insurance.coverage.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 10..1 |
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type (required to http://hl7.org/fhir/ValueSet/identifier-type ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
94. CoverageEligibilityResponse.insurance.coverage.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 10..1 |
Type | uri(DP_uri) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
96. CoverageEligibilityResponse.insurance.coverage.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | The value that is unique |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Max Length: | 50 |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
98. CoverageEligibilityResponse.insurance.coverage.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Short | Text alternative for the resource |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Max Length: | 200 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
100. CoverageEligibilityResponse.insurance.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 | 10..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Needed to convey the answer to the eligibility validation request. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
102. CoverageEligibilityResponse.insurance.benefitPeriod | |
Definition | The term of the benefits documented in this response. |
Short | When the benefits are applicable |
Control | 0..1 |
Type | Period(DP_Period_2) |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
104. CoverageEligibilityResponse.insurance.item | |
Definition | Benefits and optionally current balances, and authorization details by category or service. |
Short | Benefits and authorization details |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ces-1: SHALL contain a category or a billcode but not both. (category.exists() xor productOrService.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) BV-00311: CoverageEligibilityResponse.insurance.item.name SHALL have maximum length of 100 English characters and 50 Arabic characters. ( name.exists() implies name.length() <= 100 )BV-00312: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. ( name.exists() implies name.length() <= 60 )ces-1: SHALL contain a category or a billcode but not both. (category.exists() xor productOrService.exists()) |
106. CoverageEligibilityResponse.insurance.item.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
108. CoverageEligibilityResponse.insurance.item.category | |
Definition | Code to identify the general type of benefits under which products and services are provided. |
Short | Benefit classification |
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. |
Control | 0..1 |
Binding | The codes SHALL be taken from For example codes, see Benefit Categoryhttp://hl7.org/fhir/ValueSet/ex-benefitcategory (required to http://nphies.sa/terminology/ValueSet/benefit-category ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Needed to convey the category of service or product for which eligibility is sought. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
110. CoverageEligibilityResponse.insurance.item.excluded | |
Definition | True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage. |
Short | Excluded from the plan |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Needed to identify items that are specifically excluded from the coverage. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
112. CoverageEligibilityResponse.insurance.item.name | |
Definition | A short name or tag for the benefit. |
Short | Short name for the benefit |
Comments | For example: MED01, or DENT2. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Required to align with other plan names. |
Max Length: | 100 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
114. CoverageEligibilityResponse.insurance.item.description | |
Definition | A richer description of the benefit or services covered. |
Short | Description of the benefit or services covered |
Comments | For example 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Needed for human readable reference. |
Max Length: | 250 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
116. CoverageEligibilityResponse.insurance.item.network | |
Definition | Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. |
Short | In or out of network |
Control | 10..1 |
Binding | The codes SHALL be taken from For example codes, see NetworkTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-network (required to http://hl7.org/fhir/ValueSet/benefit-network ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Summary | false |
Requirements | Needed as in or out of network providers are treated differently under the coverage. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
118. CoverageEligibilityResponse.insurance.item.unit | |
Definition | Indicates if the benefits apply to an individual or to the family. |
Short | Individual or family |
Control | 10..1 |
Binding | The codes SHALL be taken from For example codes, see UnitTypeCodeshttp://hl7.org/fhir/ValueSet/benefit-unit (required to http://hl7.org/fhir/ValueSet/benefit-unit ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Summary | false |
Requirements | Needed for the understanding of the benefits. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
120. CoverageEligibilityResponse.insurance.item.term | |
Definition | The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. |
Short | Annual or lifetime |
Control | 10..1 |
Binding | The codes SHALL be taken from For example codes, see BenefitTermCodeshttp://hl7.org/fhir/ValueSet/benefit-term (required to http://hl7.org/fhir/ValueSet/benefit-term ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Summary | false |
Requirements | Needed for the understanding of the benefits. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
122. CoverageEligibilityResponse.insurance.item.benefit | |
Definition | Benefits used to date. |
Short | Benefit Summary |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) BV-00313: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. ( allowed.ofType(string).exists() implies allowed.ofType(string).length() <= 60 )BV-00314: CoverageEligibilityResponse.insurance.item.benefit.usedString SHALL have maximum length of 60 characters. ( used.ofType(string).exists() implies used.ofType(string).length() <= 60 ) |
124. CoverageEligibilityResponse.insurance.item.benefit.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
126. CoverageEligibilityResponse.insurance.item.benefit.type | |
Definition | Classification of benefit being provided. |
Short | Benefit classification |
Comments | For example: deductible, visits, benefit amount. |
Control | 1..1 |
Binding | The codes SHALL be taken from For example codes, see Benefit Typehttp://hl7.org/fhir/ValueSet/benefit-type (required to http://nphies.sa/terminology/ValueSet/benefit-type ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Summary | false |
Requirements | Needed to convey the nature of the benefit. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
128. CoverageEligibilityResponse.insurance.item.benefit.allowed[x] | |
Definition | The quantity of the benefit which is permitted under the coverage. |
Short | Benefits allowed |
Control | 10..1 |
Type | Choice of: unsignedInt, string, Money |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Needed to convey the benefits offered under the coverage. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.allowed[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
130. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedUnsignedInt | |
Slice Name | allowedUnsignedInt |
Definition | The quantity of the benefit which is permitted under the coverage. |
Short | Benefits allowed |
Control | 0..1 |
Type | unsignedInt(DP_unsignedInt), Money, string |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Needed to convey the benefits offered under the coverage. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
132. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedString | |
Slice Name | allowedString |
Definition | The quantity of the benefit which is permitted under the coverage. |
Short | Benefits allowed |
Control | 0..1 |
Type | string, Money, unsignedInt |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Needed to convey the benefits offered under the coverage. |
Max Length: | 60 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
134. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedMoney | |
Slice Name | allowedMoney |
Definition | The quantity of the benefit which is permitted under the coverage. |
Short | Benefits allowed |
Control | 0..1 |
Type | Money(DP_Money_SAR), string, unsignedInt |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Needed to convey the benefits offered under the coverage. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) BV-00084: CoverageEligibilityResponse.insurance.item.benefit.allowedMoney.currency SHALL be SAR ( currency.exists() implies currency ='SAR' ) |
136. CoverageEligibilityResponse.insurance.item.benefit.used[x] | |
Definition | The quantity of the benefit which have been consumed to date. |
Short | Benefits used |
Control | 0..1 |
Type | Choice of: unsignedInt, string, Money |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Requirements | Needed to convey the benefits consumed to date. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.used[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
138. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedUnsignedInt | |
Slice Name | usedUnsignedInt |
Definition | The quantity of the benefit which have been consumed to date. |
Short | Benefits used |
Control | 0..1 |
Type | unsignedInt(DP_unsignedInt), Money, string |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Needed to convey the benefits consumed to date. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
140. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedString | |
Slice Name | usedString |
Definition | The quantity of the benefit which have been consumed to date. |
Short | Benefits used |
Control | 0..1 |
Type | string, Money, unsignedInt |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Needed to convey the benefits consumed to date. |
Max Length: | 60 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
142. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedMoney | |
Slice Name | usedMoney |
Definition | The quantity of the benefit which have been consumed to date. |
Short | Benefits used |
Control | 0..1 |
Type | Money(DP_Money_SAR), string, unsignedInt |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Needed to convey the benefits consumed to date. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) BV-00085: CoverageEligibilityResponse.insurance.item.benefit.used.currency SHALL be SAR ( currency.exists() implies currency ='SAR' ) |
144. CoverageEligibilityResponse.error | |
Definition | Errors encountered during the processing of the request. |
Short | Processing errors |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Need to communicate processing issues to the requestor. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
146. CoverageEligibilityResponse.error.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.error.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
148. CoverageEligibilityResponse.error.extension:expression | |
Slice Name | expression |
Definition | Expression for error location as part of error reporting to indicate the location of error. |
Short | Error Expression |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Error Expression) (Extension Type: string) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
150. CoverageEligibilityResponse.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
152. CoverageEligibilityResponse.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 | The codes SHALL be taken from For example codes, see Adjudication Error Codeshttp://hl7.org/fhir/ValueSet/adjudication-error (required to http://nphies.sa/terminology/ValueSet/adjudication-error ) |
Type | CodeableConcept(DP_CodeableConcept) |
Is Modifier | false |
Summary | false |
Requirements | Required to convey processing errors. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. CoverageEligibilityResponse | |||||
Definition | This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource. | ||||
Short | CoverageEligibilityResponse resource | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )BV-00539: CoverageEligibilityResponse.status SHALL use the fixed value 'active'. ( status.exists() implies status = 'active' )ksa-purpose-unique-code: Purpose code values must be unique. ( purpose.exists() implies purpose.isDistinct() )BV-00310: CoverageEligibilityResponse.disposition SHALL have maximum length of 250 English characters and 125 Arabic characters. ( disposition.exists() implies disposition.length() <= 250 )BV-00315: CoverageEligibilityResponse.preAuthRef SHALL have maximum length of 40 characters. ( preAuthRef.exists() implies preAuthRef.length() <= 40 )BV-00503: CoverageEligibiltyResponse.extension.siteEligibility SHALL be provided when CoverageEligibiltyResponse.outcome='complete'. ( outcome.exists() implies (outcome = 'complete' implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').exists()) )BV-00535: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.inforce value is 'false'. ( iif( (insurance.where(inforce = true).count() = 0) and (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count()=1), iif((extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.first().code='eligible') ,false,true), true) )BV-00536: The CoverageEligibilityResponse.error SHALL be provided when CoverageEligibilityResponse.outcome= 'error'. ( outcome.exists() implies (outcome = 'error' implies error.exists()) )BV-00559: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL be 'eligible' if at least in one array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is 'eligible'. ( iif( insurance.extension.exists(), iif( (insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), iif( extension.exists(), (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').value.ofType(CodeableConcept).coding.where(code='eligible').count() > 0), true), false), true) )BV-00561: The CoverageEligibiltyResponse.extension.siteEligibility value SHALL not be 'eligible' if for every array entry of CoverageEligibiltyResponse.insurance the related CoverageEligibilityResponse.insurance.siteEligibility is not 'eligible'. ( iif( (extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').count() = 1), iif(extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').first().value.ofType(CodeableConcept).coding.first().code='eligible', iif(insurance.extension.exists(),insurance.extension.where(url='http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-siteEligibility').select(value.ofType(CodeableConcept).coding.select(code='eligible').count()>0),false),false), true) ) | ||||
2. CoverageEligibilityResponse.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 | 1..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
Max Length: | 64 | ||||
4. CoverageEligibilityResponse.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 1..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. CoverageEligibilityResponse.meta.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
8. CoverageEligibilityResponse.meta.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.meta.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
10. CoverageEligibilityResponse.meta.versionId | |||||
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
Short | Version specific identifier | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. CoverageEligibilityResponse.meta.lastUpdated | |||||
Definition | When the resource last changed - e.g. when the version changed. | ||||
Short | When the resource version last changed | ||||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
14. CoverageEligibilityResponse.meta.source | |||||
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
Short | Identifies where the resource comes from | ||||
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
16. CoverageEligibilityResponse.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Short | Profiles this resource claims to conform to | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
Control | 1..* | ||||
Type | canonical(DP_canonical)(StructureDefinition) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
18. CoverageEligibilityResponse.meta.security | |||||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
Short | Security Labels applied to this resource | ||||
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels )Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. CoverageEligibilityResponse.meta.tag | |||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Short | Tags applied to this resource | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Control | 0..* | ||||
Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags )Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
22. CoverageEligibilityResponse.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. CoverageEligibilityResponse.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 | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. CoverageEligibilityResponse.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can 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 information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. CoverageEligibilityResponse.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
30. CoverageEligibilityResponse.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
32. CoverageEligibilityResponse.extension:siteEligibility | |||||
Slice Name | siteEligibility | ||||
Definition | Code to indicate whether the patient is eligible or not eligible and why. | ||||
Short | Site Eligibility | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept)) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
34. CoverageEligibilityResponse.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
36. CoverageEligibilityResponse.identifier | |||||
Definition | A unique identifier assigned to this coverage eligiblity request. | ||||
Short | Business Identifier for coverage eligiblity request | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..1 | ||||
Type | Identifier(DP_Identifier_A) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows coverage eligibility requests to be distinguished and referenced. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. CoverageEligibilityResponse.identifier.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
40. CoverageEligibilityResponse.identifier.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
42. CoverageEligibilityResponse.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary | old (If known) | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. CoverageEligibilityResponse.identifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes (required to http://hl7.org/fhir/ValueSet/identifier-type ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. CoverageEligibilityResponse.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 1..1 | ||||
Type | uri(DP_uri) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
48. CoverageEligibilityResponse.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Max Length: | 50 | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
50. CoverageEligibilityResponse.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. CoverageEligibilityResponse.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. CoverageEligibilityResponse.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 resource as not currently valid. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from FinancialResourceStatusCodes (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1 )A code specifying the state of the resource instance. | ||||
Type | code | ||||
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. | ||||
Pattern Value | active | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. CoverageEligibilityResponse.purpose | |||||
Definition | Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified. | ||||
Short | auth-requirements | benefits | discovery | validation | ||||
Control | 1..* | ||||
Binding | The codes SHALL be taken from EligibilityResponsePurpose (required to http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose ) | ||||
Type | code(DP_code) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | To indicate the processing actions requested. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. CoverageEligibilityResponse.patient | |||||
Definition | The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. | ||||
Short | Intended recipient of products and services | ||||
Control | 1..1 | ||||
Type | Reference(DP_Reference_1or2a)(Nphies Patient) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Required to provide context and coverage validation. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. CoverageEligibilityResponse.patient.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
62. CoverageEligibilityResponse.patient.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.patient.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
64. CoverageEligibilityResponse.patient.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Short | Literal reference, Relative, internal or absolute URL | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Max Length: | 250 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
66. CoverageEligibilityResponse.patient.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Short | Type the reference refers to (e.g. "Patient") | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. CoverageEligibilityResponse.patient.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Short | Logical reference, when literal reference is not known | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. CoverageEligibilityResponse.patient.identifier.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
72. CoverageEligibilityResponse.patient.identifier.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.patient.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
74. CoverageEligibilityResponse.patient.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary | old (If known) | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
76. CoverageEligibilityResponse.patient.identifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Patient Identifier Type (required to http://nphies.sa/terminology/ValueSet/patient-identifier-type ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
78. CoverageEligibilityResponse.patient.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 1..1 | ||||
Type | uri(DP_uri) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
80. CoverageEligibilityResponse.patient.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Max Length: | 50 | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
82. CoverageEligibilityResponse.patient.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
84. CoverageEligibilityResponse.patient.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
86. CoverageEligibilityResponse.patient.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text alternative for the resource | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Max Length: | 200 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
88. CoverageEligibilityResponse.serviced[x] | |||||
Definition | The date or dates when the enclosed suite of services were performed or completed. | ||||
Short | Estimated date or dates of service | ||||
Control | 1..1 | ||||
Type | Choice of: date, Period | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Required to provide time context for the request. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.serviced[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
90. CoverageEligibilityResponse.serviced[x]:servicedDate | |||||
Slice Name | servicedDate | ||||
Definition | The date or dates when the enclosed suite of services were performed or completed. | ||||
Short | Estimated date or dates of service | ||||
Control | 0..1 | ||||
Type | date(DP_date) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Required to provide time context for the request. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
92. CoverageEligibilityResponse.serviced[x]:servicedPeriod | |||||
Slice Name | servicedPeriod | ||||
Definition | The date or dates when the enclosed suite of services were performed or completed. | ||||
Short | Estimated date or dates of service | ||||
Control | 0..1 | ||||
Type | Period(DP_Period_2) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Required to provide time context for the request. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
94. CoverageEligibilityResponse.created | |||||
Definition | The date this resource was created. | ||||
Short | Response creation date | ||||
Control | 1..1 | ||||
Type | dateTime(DP_dateTime) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to record a timestamp for use by both the recipient and the issuer. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
96. CoverageEligibilityResponse.requestor | |||||
Definition | The provider which is responsible for the request. | ||||
Short | Party responsible for the request | ||||
Comments | Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below. | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, PractitionerRole, Organization) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
98. CoverageEligibilityResponse.request | |||||
Definition | Reference to the original request resource. | ||||
Short | Eligibility request reference | ||||
Control | 1..1 | ||||
Type | Reference(DP_Reference_1or3a)(Nphies CoverageEligibilityRequest) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Needed to allow the response to be linked to the request. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
100. CoverageEligibilityResponse.outcome | |||||
Definition | The outcome of the request processing. | ||||
Short | queued | complete | error | partial | ||||
Comments | The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete). | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ClaimProcessingCodes (required to http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 )The outcome of the processing. | ||||
Type | code(DP_code) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | To advise the requestor of an overall processing outcome. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
102. CoverageEligibilityResponse.disposition | |||||
Definition | A human readable description of the status of the adjudication. | ||||
Short | Disposition Message | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Provided for user display. | ||||
Max Length: | 250 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
104. CoverageEligibilityResponse.insurer | |||||
Definition | The Insurer who issued the coverage in question and is the author of the response. | ||||
Short | Coverage issuer | ||||
Control | 1..1 | ||||
Type | Reference(DP_Reference_1or2a)(Nphies Insurer Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Need to identify the author. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
106. CoverageEligibilityResponse.insurer.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
108. CoverageEligibilityResponse.insurer.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurer.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
110. CoverageEligibilityResponse.insurer.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Short | Literal reference, Relative, internal or absolute URL | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Max Length: | 250 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
112. CoverageEligibilityResponse.insurer.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Short | Type the reference refers to (e.g. "Patient") | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
114. CoverageEligibilityResponse.insurer.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Short | Logical reference, when literal reference is not known | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
116. CoverageEligibilityResponse.insurer.identifier.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
118. CoverageEligibilityResponse.insurer.identifier.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurer.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
120. CoverageEligibilityResponse.insurer.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary | old (If known) | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
122. CoverageEligibilityResponse.insurer.identifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Organization Identifier (required to http://nphies.sa/terminology/ValueSet/organization-identifier-type ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
124. CoverageEligibilityResponse.insurer.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 1..1 | ||||
Type | uri(DP_uri) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
126. CoverageEligibilityResponse.insurer.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Max Length: | 50 | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
128. CoverageEligibilityResponse.insurer.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
130. CoverageEligibilityResponse.insurer.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
132. CoverageEligibilityResponse.insurer.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text alternative for the resource | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Max Length: | 200 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
134. CoverageEligibilityResponse.insurance | |||||
Definition | Financial instruments for reimbursement for the health care products and services. | ||||
Short | Patient insurance information | ||||
Comments | All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | There must be at least one coverage for which eligibility is requested. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
136. CoverageEligibilityResponse.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
138. CoverageEligibilityResponse.insurance.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
140. CoverageEligibilityResponse.insurance.extension:siteEligibility | |||||
Slice Name | siteEligibility | ||||
Definition | Code to indicate whether the patient is eligible or not eligible and why. | ||||
Short | Site Eligibility | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Site Eligibility) (Extension Type: CodeableConcept(DP_CodeableConcept)) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
142. CoverageEligibilityResponse.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
144. CoverageEligibilityResponse.insurance.coverage | |||||
Definition | Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system. | ||||
Short | Insurance information | ||||
Control | 1..1 | ||||
Type | Reference(DP_Reference_1or2a)(Nphies Coverage) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Required to allow the adjudicator to locate the correct policy and history within their information system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
146. CoverageEligibilityResponse.insurance.coverage.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
148. CoverageEligibilityResponse.insurance.coverage.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.coverage.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
150. CoverageEligibilityResponse.insurance.coverage.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Short | Literal reference, Relative, internal or absolute URL | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Max Length: | 250 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
152. CoverageEligibilityResponse.insurance.coverage.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Short | Type the reference refers to (e.g. "Patient") | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
154. CoverageEligibilityResponse.insurance.coverage.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Short | Logical reference, when literal reference is not known | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
156. CoverageEligibilityResponse.insurance.coverage.identifier.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
158. CoverageEligibilityResponse.insurance.coverage.identifier.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.coverage.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
160. CoverageEligibilityResponse.insurance.coverage.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary | old (If known) | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
162. CoverageEligibilityResponse.insurance.coverage.identifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes (required to http://hl7.org/fhir/ValueSet/identifier-type ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
164. CoverageEligibilityResponse.insurance.coverage.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 1..1 | ||||
Type | uri(DP_uri) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
166. CoverageEligibilityResponse.insurance.coverage.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Max Length: | 50 | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
168. CoverageEligibilityResponse.insurance.coverage.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
170. CoverageEligibilityResponse.insurance.coverage.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
172. CoverageEligibilityResponse.insurance.coverage.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text alternative for the resource | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Max Length: | 200 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
174. CoverageEligibilityResponse.insurance.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 | 1..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Needed to convey the answer to the eligibility validation request. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
176. CoverageEligibilityResponse.insurance.benefitPeriod | |||||
Definition | The term of the benefits documented in this response. | ||||
Short | When the benefits are applicable | ||||
Control | 0..1 | ||||
Type | Period(DP_Period_2) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
178. CoverageEligibilityResponse.insurance.item | |||||
Definition | Benefits and optionally current balances, and authorization details by category or service. | ||||
Short | Benefits and authorization details | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ces-1: SHALL contain a category or a billcode but not both. (category.exists() xor productOrService.exists() )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )BV-00311: CoverageEligibilityResponse.insurance.item.name SHALL have maximum length of 100 English characters and 50 Arabic characters. ( name.exists() implies name.length() <= 100 )BV-00312: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. ( name.exists() implies name.length() <= 60 ) | ||||
180. CoverageEligibilityResponse.insurance.item.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
182. CoverageEligibilityResponse.insurance.item.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
184. CoverageEligibilityResponse.insurance.item.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
186. CoverageEligibilityResponse.insurance.item.category | |||||
Definition | Code to identify the general type of benefits under which products and services are provided. | ||||
Short | Benefit classification | ||||
Comments | Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Benefit Category (required to http://nphies.sa/terminology/ValueSet/benefit-category ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed to convey the category of service or product for which eligibility is sought. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
188. CoverageEligibilityResponse.insurance.item.productOrService | |||||
Definition | This contains the product, service, drug or other billing code for the item. | ||||
Short | Billing, service, product, or drug code | ||||
Comments | Code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). | ||||
Control | 0..1 | ||||
Binding | For example codes, see USCLSCodes (example to http://hl7.org/fhir/ValueSet/service-uscls )Allowable service and product codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed to convey the actual service or product for which eligibility is sought. | ||||
Alternate Names | Drug Code, Bill Code, Service Code | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
190. CoverageEligibilityResponse.insurance.item.modifier | |||||
Definition | Item typification or modifiers codes to convey additional context for the product or service. | ||||
Short | Product or service billing modifiers | ||||
Comments | For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours. | ||||
Control | 0..* | ||||
Binding | For example codes, see ModifierTypeCodes (example to http://hl7.org/fhir/ValueSet/claim-modifiers )Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | To support provision of the item or to charge an elevated fee. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
192. CoverageEligibilityResponse.insurance.item.provider | |||||
Definition | The practitioner who is eligible for the provision of the product or service. | ||||
Short | Performing practitioner | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, PractitionerRole) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed to convey the eligible provider. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
194. CoverageEligibilityResponse.insurance.item.excluded | |||||
Definition | True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage. | ||||
Short | Excluded from the plan | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed to identify items that are specifically excluded from the coverage. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
196. CoverageEligibilityResponse.insurance.item.name | |||||
Definition | A short name or tag for the benefit. | ||||
Short | Short name for the benefit | ||||
Comments | For example: MED01, or DENT2. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Required to align with other plan names. | ||||
Max Length: | 100 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
198. CoverageEligibilityResponse.insurance.item.description | |||||
Definition | A richer description of the benefit or services covered. | ||||
Short | Description of the benefit or services covered | ||||
Comments | For example 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed for human readable reference. | ||||
Max Length: | 250 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
200. CoverageEligibilityResponse.insurance.item.network | |||||
Definition | Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. | ||||
Short | In or out of network | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from NetworkTypeCodes (required to http://hl7.org/fhir/ValueSet/benefit-network ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed as in or out of network providers are treated differently under the coverage. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
202. CoverageEligibilityResponse.insurance.item.unit | |||||
Definition | Indicates if the benefits apply to an individual or to the family. | ||||
Short | Individual or family | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from UnitTypeCodes (required to http://hl7.org/fhir/ValueSet/benefit-unit ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed for the understanding of the benefits. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
204. CoverageEligibilityResponse.insurance.item.term | |||||
Definition | The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. | ||||
Short | Annual or lifetime | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from BenefitTermCodes (required to http://hl7.org/fhir/ValueSet/benefit-term ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed for the understanding of the benefits. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
206. CoverageEligibilityResponse.insurance.item.benefit | |||||
Definition | Benefits used to date. | ||||
Short | Benefit Summary | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )BV-00313: CoverageEligibilityResponse.insurance.item.benefit.allowedString SHALL have maximum length of 60 characters. ( allowed.ofType(string).exists() implies allowed.ofType(string).length() <= 60 )BV-00314: CoverageEligibilityResponse.insurance.item.benefit.usedString SHALL have maximum length of 60 characters. ( used.ofType(string).exists() implies used.ofType(string).length() <= 60 ) | ||||
208. CoverageEligibilityResponse.insurance.item.benefit.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
210. CoverageEligibilityResponse.insurance.item.benefit.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
212. CoverageEligibilityResponse.insurance.item.benefit.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
214. CoverageEligibilityResponse.insurance.item.benefit.type | |||||
Definition | Classification of benefit being provided. | ||||
Short | Benefit classification | ||||
Comments | For example: deductible, visits, benefit amount. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Benefit Type (required to http://nphies.sa/terminology/ValueSet/benefit-type ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed to convey the nature of the benefit. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
216. CoverageEligibilityResponse.insurance.item.benefit.allowed[x] | |||||
Definition | The quantity of the benefit which is permitted under the coverage. | ||||
Short | Benefits allowed | ||||
Control | 1..1 | ||||
Type | Choice of: unsignedInt, string, Money | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Needed to convey the benefits offered under the coverage. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.allowed[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
218. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedUnsignedInt | |||||
Slice Name | allowedUnsignedInt | ||||
Definition | The quantity of the benefit which is permitted under the coverage. | ||||
Short | Benefits allowed | ||||
Control | 0..1 | ||||
Type | unsignedInt(DP_unsignedInt) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed to convey the benefits offered under the coverage. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
220. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedString | |||||
Slice Name | allowedString | ||||
Definition | The quantity of the benefit which is permitted under the coverage. | ||||
Short | Benefits allowed | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed to convey the benefits offered under the coverage. | ||||
Max Length: | 60 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
222. CoverageEligibilityResponse.insurance.item.benefit.allowed[x]:allowedMoney | |||||
Slice Name | allowedMoney | ||||
Definition | The quantity of the benefit which is permitted under the coverage. | ||||
Short | Benefits allowed | ||||
Control | 0..1 | ||||
Type | Money(DP_Money_SAR) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed to convey the benefits offered under the coverage. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )BV-00084: CoverageEligibilityResponse.insurance.item.benefit.allowedMoney.currency SHALL be SAR ( currency.exists() implies currency ='SAR' ) | ||||
224. CoverageEligibilityResponse.insurance.item.benefit.used[x] | |||||
Definition | The quantity of the benefit which have been consumed to date. | ||||
Short | Benefits used | ||||
Control | 0..1 | ||||
Type | Choice of: unsignedInt, string, Money | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | false | ||||
Requirements | Needed to convey the benefits consumed to date. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.insurance.item.benefit.used[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
226. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedUnsignedInt | |||||
Slice Name | usedUnsignedInt | ||||
Definition | The quantity of the benefit which have been consumed to date. | ||||
Short | Benefits used | ||||
Control | 0..1 | ||||
Type | unsignedInt(DP_unsignedInt) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed to convey the benefits consumed to date. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
228. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedString | |||||
Slice Name | usedString | ||||
Definition | The quantity of the benefit which have been consumed to date. | ||||
Short | Benefits used | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed to convey the benefits consumed to date. | ||||
Max Length: | 60 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
230. CoverageEligibilityResponse.insurance.item.benefit.used[x]:usedMoney | |||||
Slice Name | usedMoney | ||||
Definition | The quantity of the benefit which have been consumed to date. | ||||
Short | Benefits used | ||||
Control | 0..1 | ||||
Type | Money(DP_Money_SAR) | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Needed to convey the benefits consumed to date. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )BV-00085: CoverageEligibilityResponse.insurance.item.benefit.used.currency SHALL be SAR ( currency.exists() implies currency ='SAR' ) | ||||
232. CoverageEligibilityResponse.insurance.item.authorizationRequired | |||||
Definition | A boolean flag indicating whether a preauthorization is required prior to actual service delivery. | ||||
Short | Authorization required flag | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Needed to convey that preauthorization is required. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
234. CoverageEligibilityResponse.insurance.item.authorizationSupporting | |||||
Definition | Codes or comments regarding information or actions associated with the preauthorization. | ||||
Short | Type of required supporting materials | ||||
Control | 0..* | ||||
Binding | For example codes, see CoverageEligibilityResponseAuthSupportCodes (example to http://hl7.org/fhir/ValueSet/coverageeligibilityresponse-ex-auth-support )Type of supporting information to provide with a preauthorization. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed to inform the provider of collateral materials or actions needed for preauthorization. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
236. CoverageEligibilityResponse.insurance.item.authorizationUrl | |||||
Definition | A web location for obtaining requirements or descriptive information regarding the preauthorization. | ||||
Short | Preauthorization requirements endpoint | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Needed to enable insurers to advise providers of informative information. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
238. CoverageEligibilityResponse.preAuthRef | |||||
Definition | A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred. | ||||
Short | Preauthorization reference | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | To provide any preauthorization reference for provider use. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
240. CoverageEligibilityResponse.form | |||||
Definition | A code for the form to be used for printing the content. | ||||
Short | Printed form identifier | ||||
Comments | May be needed to identify specific jurisdictional forms. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Form Codes (example to http://hl7.org/fhir/ValueSet/forms )The forms codes. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Needed to specify the specific form used for producing output for this response. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
242. CoverageEligibilityResponse.error | |||||
Definition | Errors encountered during the processing of the request. | ||||
Short | Processing errors | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Need to communicate processing issues to the requestor. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
244. CoverageEligibilityResponse.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 | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
246. CoverageEligibilityResponse.error.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CoverageEligibilityResponse.error.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
248. CoverageEligibilityResponse.error.extension:expression | |||||
Slice Name | expression | ||||
Definition | Expression for error location as part of error reporting to indicate the location of error. | ||||
Short | Error Expression | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Error Expression) (Extension Type: string) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
250. CoverageEligibilityResponse.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
252. CoverageEligibilityResponse.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 | The codes SHALL be taken from Adjudication Error Codes (required to http://nphies.sa/terminology/ValueSet/adjudication-error ) | ||||
Type | CodeableConcept(DP_CodeableConcept) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Required to convey processing errors. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |