openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build

openIMIS FHIR R4 Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions

Extension: Premium (Contract)

Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/contract-premium Version: 1.0.0
Active as of 2022-05-31 Responsible: openIMIS Initiative Computable Name: ContractPremiumExtension

Indicates a premium for a Contract. This is a complex extension.

Context of Use

This extension may be used on the following element(s):

  • OpenIMISContract

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 3 elements
Fixed Value: 7 elements
Prohibited: 7 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPremium (Contract)
... extension 5..*ExtensionExtension
... extension:payer S0..1ExtensionPremium payer
.... extension 0..0
.... url 1..1uri"payer"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Payer (Contract) (extensible)
... extension:category S1..1ExtensionPremium category
.... extension 0..0
.... url 1..1uri"category"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Category (Contract) (required)
.... extension 0..0
.... url 1..1uri"amount"
.... value[x] 0..1MoneyValue of extension
Slice: Unordered, Open by type:$this
.... valueMoney 0..1MoneyValue of extension
..... value 1..1decimalNumerical value (with implicit precision)
... extension:receipt 1..1ExtensionPremium receipt
.... extension 0..0
.... url 1..1uri"receipt"
.... value[x] 0..1stringValue of extension
... extension:date 1..1ExtensionPremium payment date
.... extension 0..0
.... url 1..1uri"date"
.... value[x] 0..1dateValue of extension
... extension:type 1..1ExtensionPremium payment type
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Type (Contract) (required)
... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/contract-premium"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPremium (Contract)
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 5..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:payer S0..1ExtensionPremium payer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"payer"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Payer (Contract) (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"category"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Category (Contract) (required)
... extension:amount S1..1ExtensionPremium amount
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"amount"
.... Slices for value[x] 0..1MoneyValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueMoney 0..1MoneyValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ1..1decimalNumerical value (with implicit precision)
...... currency Σ0..1codeISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... extension:receipt 1..1ExtensionPremium receipt
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"receipt"
.... value[x] 0..1stringValue of extension
... extension:date 1..1ExtensionPremium payment date
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"date"
.... value[x] 0..1dateValue of extension
... extension:type 1..1ExtensionPremium payment type
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Type (Contract) (required)
... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/contract-premium"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 3 elements
Fixed Value: 7 elements
Prohibited: 7 elements

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPremium (Contract)
... extension 5..*ExtensionExtension
... extension:payer S0..1ExtensionPremium payer
.... extension 0..0
.... url 1..1uri"payer"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Payer (Contract) (extensible)
... extension:category S1..1ExtensionPremium category
.... extension 0..0
.... url 1..1uri"category"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Category (Contract) (required)
.... extension 0..0
.... url 1..1uri"amount"
.... value[x] 0..1MoneyValue of extension
Slice: Unordered, Open by type:$this
.... valueMoney 0..1MoneyValue of extension
..... value 1..1decimalNumerical value (with implicit precision)
... extension:receipt 1..1ExtensionPremium receipt
.... extension 0..0
.... url 1..1uri"receipt"
.... value[x] 0..1stringValue of extension
... extension:date 1..1ExtensionPremium payment date
.... extension 0..0
.... url 1..1uri"date"
.... value[x] 0..1dateValue of extension
... extension:type 1..1ExtensionPremium payment type
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Open by type:$this
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Type (Contract) (required)
... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/contract-premium"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPremium (Contract)
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 5..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:payer S0..1ExtensionPremium payer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"payer"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Payer (Contract) (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"category"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Category (Contract) (required)
... extension:amount S1..1ExtensionPremium amount
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"amount"
.... Slices for value[x] 0..1MoneyValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueMoney 0..1MoneyValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ1..1decimalNumerical value (with implicit precision)
...... currency Σ0..1codeISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... extension:receipt 1..1ExtensionPremium receipt
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"receipt"
.... value[x] 0..1stringValue of extension
... extension:date 1..1ExtensionPremium payment date
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"date"
.... value[x] 0..1dateValue of extension
... extension:type 1..1ExtensionPremium payment type
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Premium Type (Contract) (required)
... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/contract-premium"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:payer.value[x]:valueCodeableConceptextensibleContractPremiumPayerVS
Extension.extension:category.value[x]:valueCodeableConceptrequiredContractPremiumCategoryVS
Extension.extension:amount.value[x]:valueMoney.currencyrequiredCurrencies
Extension.extension:type.value[x]:valueCodeableConceptrequiredContractPremiumTypeVS

Constraints

IdGradePathDetailsRequirements
ele-1errorExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:payerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:payerMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:payer.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:payer.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:categoryMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:category.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:category.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:amountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:amountMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:amount.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:amount.value[x]:valueMoneyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:amount.value[x]:valueMoney.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:amount.value[x]:valueMoney.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:amount.value[x]:valueMoney.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:amount.value[x]:valueMoney.currencyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:receiptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:receiptMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:receipt.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:dateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:date.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:type.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())