FHIR Implementation Guide for HCX
0.7.1 - CI Build
FHIR Implementation Guide for HCX
0.7.1 - CI Build
FHIR Implementation Guide for HCX - Local Development build (v0.7.1). See the Directory of published versions
| Defining URL: | https://ig.hcxprotocol.io/v0.7.1/StructureDefinition-CoverageEligibilityResponseBundle.html |
| Version: | 0.7.1 |
| Name: | CoverageEligibilityResponseBundle |
| Title: | Covereage Eligibility Response Bundle |
| Status: | Draft as of 2022-12-21 01:04:20+0000 (Standards Status: Trial Use) |
| Definition: | Coverage Eligibility Response constraints on Bundle resource ensuring that a coverage eligibility response resource is present. |
| Publisher: | HCX Open Community |
| Maturity: | 1 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://ig.hcxprotocol.io/v0.7.1/StructureDefinition-CoverageEligibilityResponseBundle.html
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | Contains a collection of resources | |
  type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: collection | |
| timestamp | S | 1..1 | instant | When the bundle was assembled |
  Slices for entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource |
  entry:All Slices | Content/Rules for all slices | |||
  fullUrl | S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | S | 1..1 | Resource | A resource in the bundle |
| search | 0..0 | |||
| request | 0..0 | |||
 response | 0..0 | |||
  entry:CoverageEligibilityResponse | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
 resource | 0..1 | CoverageEligibilityResponse | CoverageEligibilityResponse resource | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources | ||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: collection | ||||
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled | ||||
| total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
 link | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
 url | Σ | 1..1 | uri | Reference details for the link | ||||
| Slices for entry | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | SΣ | 1..1 | Resource | A resource in the bundle | ||||
| entry:CoverageEligibilityResponse | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 0..1 | CoverageEligibilityResponse | CoverageEligibilityResponse resource | |||||
 search | ΣC | 0..1 | BackboneElement | Search related information | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
 response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| signature | ΣTU | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources |
| timestamp | Σ | 1..1 | instant | When the bundle was assembled |
| Slices for entry | ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| entry:All Slices | Content/Rules for all slices | |||
| fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | Σ | 1..1 | Resource | A resource in the bundle |
| entry:CoverageEligibilityResponse | ΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| Documentation for this format | ||||
This structure is derived from Bundle
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | Contains a collection of resources | |
| type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: collection | |
| timestamp | S | 1..1 | instant | When the bundle was assembled |
| Slices for entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource |
| entry:All Slices | Content/Rules for all slices | |||
| fullUrl | S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | S | 1..1 | Resource | A resource in the bundle |
| search | 0..0 | |||
| request | 0..0 | |||
| response | 0..0 | |||
| entry:CoverageEligibilityResponse | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| resource | 0..1 | CoverageEligibilityResponse | CoverageEligibilityResponse resource | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: collection | ||||
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled | ||||
| total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url | Σ | 1..1 | uri | Reference details for the link | ||||
| Slices for entry | SΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | SΣ | 1..1 | Resource | A resource in the bundle | ||||
| entry:CoverageEligibilityResponse | SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 0..1 | CoverageEligibilityResponse | CoverageEligibilityResponse resource | |||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| signature | ΣTU | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code | ||||
| Bundle.language | preferred | CommonLanguages
| ||||
| Bundle.type | required | Fixed Value: collection | ||||
| Bundle.entry.search.mode | required | SearchEntryMode | ||||
| Bundle.entry.request.method | required | HTTPVerb | ||||
| Bundle.entry:CoverageEligibilityResponse.search.mode | required | SearchEntryMode | ||||
| Bundle.entry:CoverageEligibilityResponse.request.method | required | HTTPVerb |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-5 | error | Bundle.entry, Bundle.entry:CoverageEligibilityResponse | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-8 | error | Bundle.entry, Bundle.entry:CoverageEligibilityResponse | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| dom-2 | error | Bundle.entry:CoverageEligibilityResponse.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Bundle.entry:CoverageEligibilityResponse.resource | 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 | Bundle.entry:CoverageEligibilityResponse.resource | 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 | Bundle.entry:CoverageEligibilityResponse.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Bundle.entry:CoverageEligibilityResponse.resource | 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() |