MedNet interface implementation guide
0.16.0 - CI Build
Publication Build: This will be filled in by the publication tooling
Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-coverage | Version: 0.16.0 | |||
Active as of 2022-07-15 | Computable Name: MNICoverage | |||
Copyright/Legal: novcom AG |
MedNet Interface (MNI) - Coverage Profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Coverage | MedNet Interface (MNI) - Coverage | |
![]() ![]() ![]() |
Σ | 0..1 | id | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
S | 0..* | Resource | It is possible to include payors as embedded resources in this contained object. This way it is not needed to include them in the Bundle |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Identifier | insurancecardnumber |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | oid of the insurance card number Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Insurance card number of the patient (20 digits) Example General: 123456 |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Fixed value:active. Only uptodate coverage data are usefull Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Fixed Value: active |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Coverage Type (required) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Plan beneficiary |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient | MedNet Interface (MNI) - Organization | MedNet Interface (MNI) - RelatedPerson) | If the reference is a Patient, this means that the payor is the patient itself. If the reference is an Organization, we assume that the payor is an insurance. If the reference is a relatedPerson we assume that the payor is another person like the parents or someone else |
![]() ![]() ![]() |
S | 0..* | Reference(MedNet Interface (MNI) - Contract) | Contract details |
![]() |
Path | Conformance | ValueSet / Code | URI |
Coverage.identifier:insurancecardnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Coverage.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
Coverage.type | required | ChOrfCoverageTypehttp://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype |
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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Coverage | MedNet Interface (MNI) - Coverage | |
![]() ![]() ![]() |
0..1 | id | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) | |
![]() ![]() ![]() |
S | 0..* | Resource | It is possible to include payors as embedded resources in this contained object. This way it is not needed to include them in the Bundle |
![]() ![]() ![]() |
S | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
S | 0..* | Identifier | insurancecardnumber |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | oid of the insurance card number Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Insurance card number of the patient (20 digits) |
![]() ![]() ![]() |
S | 1..1 | code | Fixed value:active. Only uptodate coverage data are usefull Fixed Value: active |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Coverage Type (required) |
![]() ![]() ![]() |
S | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Plan beneficiary |
![]() ![]() ![]() |
S | 1..1 | Reference(MedNet Interface (MNI) - Patient | MedNet Interface (MNI) - Organization | MedNet Interface (MNI) - RelatedPerson) | If the reference is a Patient, this means that the payor is the patient itself. If the reference is an Organization, we assume that the payor is an insurance. If the reference is a relatedPerson we assume that the payor is another person like the parents or someone else |
![]() ![]() ![]() |
S | 0..* | Reference(MedNet Interface (MNI) - Contract) | Contract details |
![]() |
Path | Conformance | ValueSet | URI |
Coverage.type | required | ChOrfCoverageTypehttp://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Coverage | MedNet Interface (MNI) - Coverage | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
S | 0..* | Resource | It is possible to include payors as embedded resources in this contained object. This way it is not needed to include them in the Bundle | ||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Identifier | insurancecardnumber | ||||
![]() ![]() ![]() ![]() ![]() |
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 . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | oid of the insurance card number Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Insurance card number of the patient (20 digits) 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 | Fixed value:active. Only uptodate coverage data are usefull Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Fixed Value: active | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Coverage Type (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | ID assigned to the subscriber | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Plan beneficiary | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Dependent number | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Coverage start and end dates | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient | MedNet Interface (MNI) - Organization | MedNet Interface (MNI) - RelatedPerson) | If the reference is a Patient, this means that the payor is the patient itself. If the reference is an Organization, we assume that the payor is an insurance. If the reference is a relatedPerson we assume that the payor is another person like the parents or someone else | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Additional coverage classifications | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
S | 0..* | Reference(MedNet Interface (MNI) - Contract) | Contract details | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Coverage.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Coverage.identifier:insurancecardnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Coverage.identifier:insurancecardnumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Coverage.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
Coverage.type | required | ChOrfCoverageTypehttp://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype | ||||
Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationship from the FHIR Standard | ||||
Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard | ||||
Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodeshttp://hl7.org/fhir/ValueSet/coverage-copay-type from the FHIR Standard | ||||
Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodeshttp://hl7.org/fhir/ValueSet/coverage-financial-exception from 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: 0 element(2 nested mandatory elements)
Must-Support: 10 elements
Fixed: 2 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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Coverage | MedNet Interface (MNI) - Coverage | |
![]() ![]() ![]() |
Σ | 0..1 | id | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
S | 0..* | Resource | It is possible to include payors as embedded resources in this contained object. This way it is not needed to include them in the Bundle |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Identifier | insurancecardnumber |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | oid of the insurance card number Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Insurance card number of the patient (20 digits) Example General: 123456 |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Fixed value:active. Only uptodate coverage data are usefull Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Fixed Value: active |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Coverage Type (required) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Plan beneficiary |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient | MedNet Interface (MNI) - Organization | MedNet Interface (MNI) - RelatedPerson) | If the reference is a Patient, this means that the payor is the patient itself. If the reference is an Organization, we assume that the payor is an insurance. If the reference is a relatedPerson we assume that the payor is another person like the parents or someone else |
![]() ![]() ![]() |
S | 0..* | Reference(MedNet Interface (MNI) - Contract) | Contract details |
![]() |
Path | Conformance | ValueSet / Code | URI |
Coverage.identifier:insurancecardnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Coverage.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
Coverage.type | required | ChOrfCoverageTypehttp://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype |
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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Coverage | MedNet Interface (MNI) - Coverage | |
![]() ![]() ![]() |
0..1 | id | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) | |
![]() ![]() ![]() |
S | 0..* | Resource | It is possible to include payors as embedded resources in this contained object. This way it is not needed to include them in the Bundle |
![]() ![]() ![]() |
S | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
S | 0..* | Identifier | insurancecardnumber |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | oid of the insurance card number Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Insurance card number of the patient (20 digits) |
![]() ![]() ![]() |
S | 1..1 | code | Fixed value:active. Only uptodate coverage data are usefull Fixed Value: active |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Coverage Type (required) |
![]() ![]() ![]() |
S | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Plan beneficiary |
![]() ![]() ![]() |
S | 1..1 | Reference(MedNet Interface (MNI) - Patient | MedNet Interface (MNI) - Organization | MedNet Interface (MNI) - RelatedPerson) | If the reference is a Patient, this means that the payor is the patient itself. If the reference is an Organization, we assume that the payor is an insurance. If the reference is a relatedPerson we assume that the payor is another person like the parents or someone else |
![]() ![]() ![]() |
S | 0..* | Reference(MedNet Interface (MNI) - Contract) | Contract details |
![]() |
Path | Conformance | ValueSet | URI |
Coverage.type | required | ChOrfCoverageTypehttp://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Coverage | MedNet Interface (MNI) - Coverage | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.) | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
S | 0..* | Resource | It is possible to include payors as embedded resources in this contained object. This way it is not needed to include them in the Bundle | ||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifier for the coverage Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Identifier | insurancecardnumber | ||||
![]() ![]() ![]() ![]() ![]() |
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 . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | oid of the insurance card number Fixed Value: urn:oid:2.16.756.5.30.1.123.100.1.1.1 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Insurance card number of the patient (20 digits) 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 | Fixed value:active. Only uptodate coverage data are usefull Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Fixed Value: active | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Coverage Type (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | ID assigned to the subscriber | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient) | Plan beneficiary | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Dependent number | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient). | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Coverage start and end dates | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(MedNet Interface (MNI) - Patient | MedNet Interface (MNI) - Organization | MedNet Interface (MNI) - RelatedPerson) | If the reference is a Patient, this means that the payor is the patient itself. If the reference is an Organization, we assume that the payor is an insurance. If the reference is a relatedPerson we assume that the payor is another person like the parents or someone else | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Additional coverage classifications | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
S | 0..* | Reference(MedNet Interface (MNI) - Contract) | Contract details | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Coverage.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Coverage.identifier:insurancecardnumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Coverage.identifier:insurancecardnumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Coverage.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
Coverage.type | required | ChOrfCoverageTypehttp://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype | ||||
Coverage.relationship | extensible | SubscriberRelationshipCodeshttp://hl7.org/fhir/ValueSet/subscriber-relationship from the FHIR Standard | ||||
Coverage.class.type | extensible | CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard | ||||
Coverage.costToBeneficiary.type | extensible | CoverageCopayTypeCodeshttp://hl7.org/fhir/ValueSet/coverage-copay-type from the FHIR Standard | ||||
Coverage.costToBeneficiary.exception.type | example | ExampleCoverageFinancialExceptionCodeshttp://hl7.org/fhir/ValueSet/coverage-financial-exception from 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: 0 element(2 nested mandatory elements)
Must-Support: 10 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron