CH ORF (R4)
0.10.0 - STU 1 Ballot

This page is part of the CH ORF (R4) (v0.10.0: STU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CH ORF Coverage

Defining URL:http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-coverage
Version:0.10.0
Name:ChOrfCoverage
Title:CH ORF Coverage
Status:Active as of 2021-06-15T14:23:15+02:00
Definition:

Profile on Coverage for CH ORF

Publisher:HL7 Switzerland
Copyright:

CC-BY-SA-4.0

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-coverage

Formal Views of Profile Content

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

This structure is derived from Coverage

Summary

Mandatory: 0 element (5 nested mandatory elements)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageCH ORF Coverage
... contained S0..*ResourceContained, inline Resources
... identifier S0..*IdentifierBusiness Identifier for the coverage
.... type S1..1CodeableConceptDescription of identifier
Binding: Coverage Identifier Type (required)
..... coding S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
...... code S1..1codeSymbol in syntax defined by the system
..... text S0..1stringPlain text representation of the concept
.... value S1..1stringThe value that is unique
... status S1..1codeactive | cancelled | draft | entered-in-error
... beneficiary S1..1Reference(CH Core Patient Profile)Plan beneficiary
... payor S1..*Reference(CH Core Organization Profile | CH Core Patient Profile)Issuer of the policy

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageCH ORF Coverage
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained S0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for the coverage
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ1..1CodeableConceptDescription of identifier
Binding: Coverage Identifier Type (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ0..1stringPlain text representation of the concept
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... type SΣ0..1CodeableConceptCoverage category such as medical or accident
Binding: Coverage Type (required)
... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
... subscriber Σ0..1Reference(Patient | RelatedPerson)Subscriber to the policy
... subscriberId Σ0..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(CH Core Patient Profile)Plan beneficiary
... dependent Σ0..1stringDependent number
... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period Σ0..1PeriodCoverage start and end dates
... payor SΣ1..*Reference(CH Core Organization Profile | CH Core Patient Profile)Issuer of the policy
... class 0..*BackboneElementAdditional coverage classifications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

.... value Σ1..1stringValue associated with the type
.... name Σ0..1stringHuman readable description of the type and value
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... costToBeneficiary 0..*BackboneElementPatient payments for services/products
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ1..1The amount or percentage due from the beneficiary
..... valueQuantityQuantity(SimpleQuantity)
..... valueMoneyMoney
.... exception 0..*BackboneElementExceptions for patient payments
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ0..1PeriodThe effective period of the exception
... subrogation 0..1booleanReimbursement to insurer
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageCH ORF Coverage
... contained 0..*ResourceContained, inline Resources
... identifier Σ0..*IdentifierBusiness Identifier for the coverage
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Coverage Identifier Type (required)
..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
...... code Σ1..1codeSymbol in syntax defined by the system
..... text Σ0..1stringPlain text representation of the concept
.... value Σ1..1stringThe value that is unique
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... beneficiary Σ1..1Reference(CH Core Patient Profile)Plan beneficiary
... payor Σ1..*Reference(CH Core Organization Profile | CH Core Patient Profile)Issuer of the policy

doco Documentation for this format

This structure is derived from Coverage

Summary

Mandatory: 0 element (5 nested mandatory elements)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageCH ORF Coverage
... contained S0..*ResourceContained, inline Resources
... identifier S0..*IdentifierBusiness Identifier for the coverage
.... type S1..1CodeableConceptDescription of identifier
Binding: Coverage Identifier Type (required)
..... coding S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
...... code S1..1codeSymbol in syntax defined by the system
..... text S0..1stringPlain text representation of the concept
.... value S1..1stringThe value that is unique
... status S1..1codeactive | cancelled | draft | entered-in-error
... beneficiary S1..1Reference(CH Core Patient Profile)Plan beneficiary
... payor S1..*Reference(CH Core Organization Profile | CH Core Patient Profile)Issuer of the policy

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*CoverageCH ORF Coverage
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained S0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifier for the coverage
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ1..1CodeableConceptDescription of identifier
Binding: Coverage Identifier Type (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ0..1stringPlain text representation of the concept
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

... type SΣ0..1CodeableConceptCoverage category such as medical or accident
Binding: Coverage Type (required)
... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
... subscriber Σ0..1Reference(Patient | RelatedPerson)Subscriber to the policy
... subscriberId Σ0..1stringID assigned to the subscriber
... beneficiary SΣ1..1Reference(CH Core Patient Profile)Plan beneficiary
... dependent Σ0..1stringDependent number
... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

... period Σ0..1PeriodCoverage start and end dates
... payor SΣ1..*Reference(CH Core Organization Profile | CH Core Patient Profile)Issuer of the policy
... class 0..*BackboneElementAdditional coverage classifications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

.... value Σ1..1stringValue associated with the type
.... name Σ0..1stringHuman readable description of the type and value
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... costToBeneficiary 0..*BackboneElementPatient payments for services/products
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

.... value[x] Σ1..1The amount or percentage due from the beneficiary
..... valueQuantityQuantity(SimpleQuantity)
..... valueMoneyMoney
.... exception 0..*BackboneElementExceptions for patient payments
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

..... period Σ0..1PeriodThe effective period of the exception
... subrogation 0..1booleanReimbursement to insurer
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Coverage.languagepreferredCommonLanguages
Max Binding: AllLanguages
Coverage.identifier.userequiredIdentifierUse
Coverage.identifier.typerequiredChOrfCoverageIdentifierType
Coverage.statusrequiredFinancialResourceStatusCodes
Coverage.typerequiredChOrfCoverageType
Coverage.relationshipextensibleSubscriberRelationshipCodes
Coverage.class.typeextensibleCoverageClassCodes
Coverage.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Coverage.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes

Constraints

IdPathDetailsRequirements
dom-2CoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3CoverageIf 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-4CoverageIf 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-5CoverageIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6CoverageA resource should have narrative for robust management
: text.`div`.exists()
ele-1Coverage.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.type.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.identifier.type.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.identifier.type.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.type.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.identifier.type.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.identifier.type.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.type.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.type.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.type.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.type.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.type.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.policyHolderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.subscriberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.subscriberIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.beneficiaryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.dependentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.payorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.classAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.class.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.class.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.class.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.class.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.class.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.class.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.class.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.orderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.networkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.costToBeneficiaryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.costToBeneficiary.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.costToBeneficiary.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.costToBeneficiary.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.costToBeneficiary.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.costToBeneficiary.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.costToBeneficiary.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.costToBeneficiary.exceptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.costToBeneficiary.exception.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.costToBeneficiary.exception.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.costToBeneficiary.exception.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Coverage.costToBeneficiary.exception.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Coverage.costToBeneficiary.exception.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.costToBeneficiary.exception.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.subrogationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Coverage.contractAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())