MedNet interface implementation guide
0.16.0 - CI Build

Publication Build: This will be filled in by the publication tooling

Resource Profile: MedNet Interface (MNI) - Coverage

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..* Coverage MedNet Interface (MNI) - Coverage
... id Σ 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.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 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
... Slices for identifier SΣ 0..* Identifier Business Identifier for the coverage
Slice: Unordered, Open by value:system
.... identifier:insurancecardnumber SΣ 0..* Identifier insurancecardnumber
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system 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
..... value SΣ 1..1 string Insurance card number of the patient (20 digits)
Example General: 123456
... status ?!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
... type SΣ 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Coverage Type (required)
... beneficiary SΣ 1..1 Reference(MedNet Interface (MNI) - Patient) Plan beneficiary
... payor 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
... contract S 0..* Reference(MedNet Interface (MNI) - Contract) Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Coverage.identifier:insurancecardnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Coverage.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Coverage.typerequiredChOrfCoverageType
http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf 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-4errorCoverageIf 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-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..* Coverage MedNet Interface (MNI) - Coverage
... id 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.)
... contained 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
... Slices for identifier S 0..* Identifier Business Identifier for the coverage
Slice: Unordered, Open by value:system
.... identifier:insurancecardnumber S 0..* Identifier insurancecardnumber
..... system 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
..... value S 1..1 string Insurance card number of the patient (20 digits)
... type S 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Coverage Type (required)
... beneficiary S 1..1 Reference(MedNet Interface (MNI) - Patient) Plan beneficiary
... payor 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
... contract S 0..* Reference(MedNet Interface (MNI) - Contract) Contract details

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Coverage.typerequiredChOrfCoverageType
http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..* Coverage MedNet Interface (MNI) - Coverage
... id Σ 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.)
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Business Identifier for the coverage
Slice: Unordered, Open by value:system
.... identifier:insurancecardnumber SΣ 0..* Identifier insurancecardnumber
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 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.

..... system 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
..... value SΣ 1..1 string Insurance card number of the patient (20 digits)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!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
... type SΣ 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Coverage Type (required)
... policyHolder Σ 0..1 Reference(Patient | RelatedPerson | Organization) Owner of the policy
... subscriber Σ 0..1 Reference(Patient | RelatedPerson) Subscriber to the policy
... subscriberId Σ 0..1 string ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(MedNet Interface (MNI) - Patient) Plan beneficiary
... dependent Σ 0..1 string Dependent number
... relationship 0..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period Σ 0..1 Period Coverage start and end dates
... payor 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
... class 0..* BackboneElement Additional coverage classifications
.... 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
.... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

.... value Σ 1..1 string Value associated with the type
.... name Σ 0..1 string Human readable description of the type and value
... order Σ 0..1 positiveInt Relative order of the coverage
... network Σ 0..1 string Insurer network
... costToBeneficiary 0..* BackboneElement Patient payments for services/products
.... 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
.... type Σ 0..1 CodeableConcept Cost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ 1..1 The amount or percentage due from the beneficiary
..... valueQuantity Quantity(SimpleQuantity)
..... valueMoney Money
.... exception 0..* BackboneElement Exceptions for patient payments
..... 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
..... type Σ 1..1 CodeableConcept Exception category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ 0..1 Period The effective period of the exception
... subrogation 0..1 boolean Reimbursement to insurer
... contract S 0..* Reference(MedNet Interface (MNI) - Contract) Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Coverage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Coverage.identifier:insurancecardnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Coverage.identifier:insurancecardnumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Coverage.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Coverage.typerequiredChOrfCoverageType
http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
from the FHIR Standard
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
http://hl7.org/fhir/ValueSet/coverage-copay-type
from the FHIR Standard
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes
http://hl7.org/fhir/ValueSet/coverage-financial-exception
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf 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-4errorCoverageIf 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-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element 1 is sliced based on the value of Coverage.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..* Coverage MedNet Interface (MNI) - Coverage
... id Σ 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.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 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
... Slices for identifier SΣ 0..* Identifier Business Identifier for the coverage
Slice: Unordered, Open by value:system
.... identifier:insurancecardnumber SΣ 0..* Identifier insurancecardnumber
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system 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
..... value SΣ 1..1 string Insurance card number of the patient (20 digits)
Example General: 123456
... status ?!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
... type SΣ 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Coverage Type (required)
... beneficiary SΣ 1..1 Reference(MedNet Interface (MNI) - Patient) Plan beneficiary
... payor 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
... contract S 0..* Reference(MedNet Interface (MNI) - Contract) Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Coverage.identifier:insurancecardnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Coverage.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Coverage.typerequiredChOrfCoverageType
http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf 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-4errorCoverageIf 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-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..* Coverage MedNet Interface (MNI) - Coverage
... id 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.)
... contained 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
... Slices for identifier S 0..* Identifier Business Identifier for the coverage
Slice: Unordered, Open by value:system
.... identifier:insurancecardnumber S 0..* Identifier insurancecardnumber
..... system 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
..... value S 1..1 string Insurance card number of the patient (20 digits)
... type S 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Coverage Type (required)
... beneficiary S 1..1 Reference(MedNet Interface (MNI) - Patient) Plan beneficiary
... payor 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
... contract S 0..* Reference(MedNet Interface (MNI) - Contract) Contract details

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Coverage.typerequiredChOrfCoverageType
http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..* Coverage MedNet Interface (MNI) - Coverage
... id Σ 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.)
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Business Identifier for the coverage
Slice: Unordered, Open by value:system
.... identifier:insurancecardnumber SΣ 0..* Identifier insurancecardnumber
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 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.

..... system 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
..... value SΣ 1..1 string Insurance card number of the patient (20 digits)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!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
... type SΣ 0..1 CodeableConcept Coverage category such as medical or accident
Binding: Coverage Type (required)
... policyHolder Σ 0..1 Reference(Patient | RelatedPerson | Organization) Owner of the policy
... subscriber Σ 0..1 Reference(Patient | RelatedPerson) Subscriber to the policy
... subscriberId Σ 0..1 string ID assigned to the subscriber
... beneficiary SΣ 1..1 Reference(MedNet Interface (MNI) - Patient) Plan beneficiary
... dependent Σ 0..1 string Dependent number
... relationship 0..1 CodeableConcept Beneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period Σ 0..1 Period Coverage start and end dates
... payor 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
... class 0..* BackboneElement Additional coverage classifications
.... 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
.... type Σ 1..1 CodeableConcept Type of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

.... value Σ 1..1 string Value associated with the type
.... name Σ 0..1 string Human readable description of the type and value
... order Σ 0..1 positiveInt Relative order of the coverage
... network Σ 0..1 string Insurer network
... costToBeneficiary 0..* BackboneElement Patient payments for services/products
.... 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
.... type Σ 0..1 CodeableConcept Cost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ 1..1 The amount or percentage due from the beneficiary
..... valueQuantity Quantity(SimpleQuantity)
..... valueMoney Money
.... exception 0..* BackboneElement Exceptions for patient payments
..... 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
..... type Σ 1..1 CodeableConcept Exception category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ 0..1 Period The effective period of the exception
... subrogation 0..1 boolean Reimbursement to insurer
... contract S 0..* Reference(MedNet Interface (MNI) - Contract) Contract details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Coverage.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Coverage.identifier:insurancecardnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Coverage.identifier:insurancecardnumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Coverage.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
Coverage.typerequiredChOrfCoverageType
http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-coveragetype
Coverage.relationshipextensibleSubscriberRelationshipCodes
http://hl7.org/fhir/ValueSet/subscriber-relationship
from the FHIR Standard
Coverage.class.typeextensibleCoverageClassCodes
http://hl7.org/fhir/ValueSet/coverage-class
from the FHIR Standard
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
http://hl7.org/fhir/ValueSet/coverage-copay-type
from the FHIR Standard
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes
http://hl7.org/fhir/ValueSet/coverage-financial-exception
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCoverageIf 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-4errorCoverageIf 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-5errorCoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element 1 is sliced based on the value of Coverage.identifier

 

Other representations of profile: CSV, Excel, Schematron