Implementation Guide
27.0.0 - R4 APIs
Publish Box goes here
| Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-pas-coverage-profile.html | Version: 27.0.0 | |||
| Active as of 2026-05-06 | Computable Name: PasCoverage | |||
This profile is used to represent the insurance coverage details associated with an individual's healthcare services under a specific insurance plan. This profile is required as part of the PAS Claim Bundle and is referenced in the PAS Claim resource.
Goal: Retrieve the PAS Coverage resource by ID for inclusion in the Claim Bundle.
Reference: PAS Coverage is referenced in the PAS Claim resource as part of the required Claim Bundle structure.
Required for Claim Bundle. Reference to PAS Coverage in PAS Claim resource.
This profile captures key insurance coverage information such as coverage kind, identifiers (member number, payor IDs), coverage period, policy holder, subscriber, beneficiary references, and payor organization details necessary for claims processing and adjudication.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Member ID and other identifiers Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Member ID |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: MB |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | National Insurance Payor Identifier (Payor) |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Fixed Value: NIIP (National Insurance Payor Identifier) Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: NIIP |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | NIIP value Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: PayerType (20221118) (extensible): US Public Health Data Consortium Source of Payment Codes |
![]() ![]() |
SΣ | 0..1 | Reference(PAS Subscriber Patient) | Subscriber to the policy |
![]() ![]() |
SΣ | 0..1 | string | ID assigned to the subscriber |
![]() ![]() |
SΣ | 1..1 | Reference(PAS Beneficiary Patient) | Plan beneficiary |
![]() ![]() |
S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
![]() ![]() |
SΣ | 0..1 | Period | Coverage start and end dates |
![]() ![]() |
SΣ | 1..1 | Reference(PAS Insurer Organization) | Issuer of the policy |
![]() ![]() |
S | 0..* | BackboneElement | Additional coverage classifications Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Value associated with the type |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Group |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: group |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Group Number |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Group Name |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Plan |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: plan |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plan Number |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plan Name |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Coverage.identifier:memberid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Coverage.identifier:memberid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Coverage.identifier:NIIP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Coverage.identifier:NIIP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Coverage.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/fm-statusFrom the FHIR Standard | |
| Coverage.type | extensible | PayerType ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118 | |
| Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationshipFrom the FHIR Standard | |
| Coverage.relationship.coding:X12Code | required | https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 | |
| Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | |
| Coverage.class:group.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | |
| Coverage.class:plan.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Coverage | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coverage
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |
![]() ![]() |
S | 1..* | Identifier | Member ID and other identifiers Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
S | 1..1 | Identifier | Member ID |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: MB | |
![]() ![]() ![]() |
S | 0..* | Identifier | National Insurance Payor Identifier (Payor) |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Fixed Value: NIIP (National Insurance Payor Identifier) |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: NIIP | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | NIIP value |
![]() ![]() |
S | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active |
![]() ![]() |
S | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: PayerType (20221118) (extensible): US Public Health Data Consortium Source of Payment Codes |
![]() ![]() |
S | 0..1 | Reference(PAS Subscriber Patient) | Subscriber to the policy |
![]() ![]() |
S | 0..1 | string | ID assigned to the subscriber |
![]() ![]() |
S | 1..1 | Reference(PAS Beneficiary Patient) | Plan beneficiary |
![]() ![]() |
S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Code defined by a terminology system Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
![]() ![]() |
S | 0..1 | Period | Coverage start and end dates |
![]() ![]() |
S | 1..1 | Reference(PAS Insurer Organization) | Issuer of the policy |
![]() ![]() |
S | 0..* | BackboneElement | Additional coverage classifications Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Group |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: group | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Group Number |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Group Name |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Plan |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: plan | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Plan Number |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plan Name |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Coverage.identifier:memberid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Coverage.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/fm-statusFrom the FHIR Standard | |
| Coverage.type | extensible | PayerType ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118 | |
| Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationshipFrom the FHIR Standard | |
| Coverage.relationship.coding:X12Code | required | https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 | |
| Coverage.class:group.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | |
| Coverage.class:plan.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Member ID and other identifiers Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Member ID | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: MB | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | National Insurance Payor Identifier (Payor) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Fixed Value: NIIP (National Insurance Payor Identifier) Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: NIIP | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | NIIP value Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: PayerType (20221118) (extensible): US Public Health Data Consortium Source of Payment Codes | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
![]() ![]() |
SΣ | 0..1 | Reference(PAS Subscriber Patient) | Subscriber to the policy | ||||
![]() ![]() |
SΣ | 0..1 | string | ID assigned to the subscriber | ||||
![]() ![]() |
SΣ | 1..1 | Reference(PAS Beneficiary Patient) | Plan beneficiary | ||||
![]() ![]() |
Σ | 0..1 | string | Dependent number | ||||
![]() ![]() |
S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 0..1 | Period | Coverage start and end dates | ||||
![]() ![]() |
SΣ | 1..1 | Reference(PAS Insurer Organization) | Issuer of the policy | ||||
![]() ![]() |
S | 0..* | BackboneElement | Additional coverage classifications Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Value associated with the type | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Human readable description of the type and value | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Group | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: group | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Group Number | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Group Name | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Plan | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: plan | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plan Number | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plan Name | ||||
![]() ![]() |
Σ | 0..1 | positiveInt | Relative order of the coverage | ||||
![]() ![]() |
Σ | 0..1 | string | Insurer network | ||||
![]() ![]() |
0..* | BackboneElement | Patient payments for services/products | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. | ||||
![]() ![]() ![]() |
Σ | 1..1 | The amount or percentage due from the beneficiary | |||||
![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() |
0..* | BackboneElement | Exceptions for patient payments | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | The effective period of the exception | ||||
![]() ![]() |
0..1 | boolean | Reimbursement to insurer | |||||
![]() ![]() |
0..* | Reference(Contract) | Contract details | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Coverage.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Coverage.identifier:memberid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Coverage.identifier:memberid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Coverage.identifier:NIIP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Coverage.identifier:NIIP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Coverage.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/fm-statusFrom the FHIR Standard | ||||
| Coverage.type | extensible | PayerType ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118 | ||||
| Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationshipFrom the FHIR Standard | ||||
| Coverage.relationship.coding:X12Code | required | https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 | ||||
| Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | ||||
| Coverage.class:group.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | ||||
| Coverage.class:plan.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | ||||
| Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodeshttp://hl7.org/fhir/ValueSet/coverage-copay-typeFrom the FHIR Standard | ||||
| Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodeshttp://hl7.org/fhir/ValueSet/coverage-financial-exceptionFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Coverage | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coverage
Summary
Mandatory: 7 elements(11 nested mandatory elements)
Must-Support: 22 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Member ID and other identifiers Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Member ID |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: MB |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | National Insurance Payor Identifier (Payor) |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Fixed Value: NIIP (National Insurance Payor Identifier) Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: NIIP |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | NIIP value Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: PayerType (20221118) (extensible): US Public Health Data Consortium Source of Payment Codes |
![]() ![]() |
SΣ | 0..1 | Reference(PAS Subscriber Patient) | Subscriber to the policy |
![]() ![]() |
SΣ | 0..1 | string | ID assigned to the subscriber |
![]() ![]() |
SΣ | 1..1 | Reference(PAS Beneficiary Patient) | Plan beneficiary |
![]() ![]() |
S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
![]() ![]() |
SΣ | 0..1 | Period | Coverage start and end dates |
![]() ![]() |
SΣ | 1..1 | Reference(PAS Insurer Organization) | Issuer of the policy |
![]() ![]() |
S | 0..* | BackboneElement | Additional coverage classifications Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Value associated with the type |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Group |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: group |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Group Number |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Group Name |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Plan |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: plan |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plan Number |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plan Name |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Coverage.identifier:memberid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Coverage.identifier:memberid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Coverage.identifier:NIIP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Coverage.identifier:NIIP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Coverage.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/fm-statusFrom the FHIR Standard | |
| Coverage.type | extensible | PayerType ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118 | |
| Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationshipFrom the FHIR Standard | |
| Coverage.relationship.coding:X12Code | required | https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 | |
| Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | |
| Coverage.class:group.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | |
| Coverage.class:plan.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Coverage | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Coverage
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |
![]() ![]() |
S | 1..* | Identifier | Member ID and other identifiers Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
S | 1..1 | Identifier | Member ID |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: MB | |
![]() ![]() ![]() |
S | 0..* | Identifier | National Insurance Payor Identifier (Payor) |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Fixed Value: NIIP (National Insurance Payor Identifier) |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: NIIP | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | NIIP value |
![]() ![]() |
S | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active |
![]() ![]() |
S | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: PayerType (20221118) (extensible): US Public Health Data Consortium Source of Payment Codes |
![]() ![]() |
S | 0..1 | Reference(PAS Subscriber Patient) | Subscriber to the policy |
![]() ![]() |
S | 0..1 | string | ID assigned to the subscriber |
![]() ![]() |
S | 1..1 | Reference(PAS Beneficiary Patient) | Plan beneficiary |
![]() ![]() |
S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Code defined by a terminology system Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
![]() ![]() |
S | 0..1 | Period | Coverage start and end dates |
![]() ![]() |
S | 1..1 | Reference(PAS Insurer Organization) | Issuer of the policy |
![]() ![]() |
S | 0..* | BackboneElement | Additional coverage classifications Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Group |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: group | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Group Number |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Group Name |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Plan |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: plan | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Plan Number |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plan Name |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Coverage.identifier:memberid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Coverage.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/fm-statusFrom the FHIR Standard | |
| Coverage.type | extensible | PayerType ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118 | |
| Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationshipFrom the FHIR Standard | |
| Coverage.relationship.coding:X12Code | required | https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 | |
| Coverage.class:group.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | |
| Coverage.class:plan.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Coverage | Insurance or medical plan or a payment agreement | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Member ID and other identifiers Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Member ID | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: MB | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | National Insurance Payor Identifier (Payor) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Fixed Value: NIIP (National Insurance Payor Identifier) Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: NIIP | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | NIIP value Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: PayerType (20221118) (extensible): US Public Health Data Consortium Source of Payment Codes | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
![]() ![]() |
SΣ | 0..1 | Reference(PAS Subscriber Patient) | Subscriber to the policy | ||||
![]() ![]() |
SΣ | 0..1 | string | ID assigned to the subscriber | ||||
![]() ![]() |
SΣ | 1..1 | Reference(PAS Beneficiary Patient) | Plan beneficiary | ||||
![]() ![]() |
Σ | 0..1 | string | Dependent number | ||||
![]() ![]() |
S | 1..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): SubscriberRelationshipCodes | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Code defined by a terminology system Binding: https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 (required): Codes indicating the relationship between two individuals or entities. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 0..1 | Period | Coverage start and end dates | ||||
![]() ![]() |
SΣ | 1..1 | Reference(PAS Insurer Organization) | Issuer of the policy | ||||
![]() ![]() |
S | 0..* | BackboneElement | Additional coverage classifications Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Value associated with the type | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Human readable description of the type and value | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Group | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: group | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Group Number | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Group Name | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Plan | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: plan | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plan Number | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plan Name | ||||
![]() ![]() |
Σ | 0..1 | positiveInt | Relative order of the coverage | ||||
![]() ![]() |
Σ | 0..1 | string | Insurer network | ||||
![]() ![]() |
0..* | BackboneElement | Patient payments for services/products | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified. | ||||
![]() ![]() ![]() |
Σ | 1..1 | The amount or percentage due from the beneficiary | |||||
![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||
![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() |
0..* | BackboneElement | Exceptions for patient payments | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | The effective period of the exception | ||||
![]() ![]() |
0..1 | boolean | Reimbursement to insurer | |||||
![]() ![]() |
0..* | Reference(Contract) | Contract details | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Coverage.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Coverage.identifier:memberid.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Coverage.identifier:memberid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Coverage.identifier:NIIP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Coverage.identifier:NIIP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Coverage.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/fm-statusFrom the FHIR Standard | ||||
| Coverage.type | extensible | PayerType ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591|20221118 | ||||
| Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationshipFrom the FHIR Standard | ||||
| Coverage.relationship.coding:X12Code | required | https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069https://valueset.x12.org/x217/005010/request/2000D/INS/1/02/00/1069 | ||||
| Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | ||||
| Coverage.class:group.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | ||||
| Coverage.class:plan.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-classFrom the FHIR Standard | ||||
| Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodeshttp://hl7.org/fhir/ValueSet/coverage-copay-typeFrom the FHIR Standard | ||||
| Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodeshttp://hl7.org/fhir/ValueSet/coverage-financial-exceptionFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Coverage | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Coverage | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Coverage | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Coverage | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Coverage
Summary
Mandatory: 7 elements(11 nested mandatory elements)
Must-Support: 22 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron