openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
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
| Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/insurance-plan-period | Version: 1.0.0 | |||
| Active as of 2022-05-31 | Responsible: openIMIS Initiative | Computable Name: InsurancePlanPeriodExtension | ||
Defines the number of months a certain period is valid in InsurancePlan.
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | Period (InsurancePlan) | |
  extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/insurance-plan-period" | |
 value[x] | 0..1 | Quantity | Value of extension Slice: Unordered, Open by type:$this | |
 valueQuantity | 0..1 | Quantity | Value of extension | |
 value | 1..1 | decimal | Numerical value (with implicit precision) | |
 unit | 0..1 | string | Unit representation Required Pattern: months | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Period (InsurancePlan) | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/insurance-plan-period" | |
| Slices for value[x] | 0..1 | Quantity | Value of extension Slice: Unordered, Closed by type:$this | |
  value[x]:valueQuantity | 0..1 | Quantity | Value of extension | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit | Σ | 0..1 | string | Unit representation Required Pattern: months |
| system | ΣI | 0..1 | uri | System that defines coded unit form |
 code | Σ | 0..1 | code | Coded form of the unit |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Period (InsurancePlan) | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/insurance-plan-period" | |
| value[x] | 0..1 | Quantity | Value of extension Slice: Unordered, Open by type:$this | |
| valueQuantity | 0..1 | Quantity | Value of extension | |
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| unit | 0..1 | string | Unit representation Required Pattern: months | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Period (InsurancePlan) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/insurance-plan-period" | |
| Slices for value[x] | 0..1 | Quantity | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueQuantity | 0..1 | Quantity | Value of extension | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit | Σ | 0..1 | string | Unit representation Required Pattern: months |
| system | ΣI | 0..1 | uri | System that defines coded unit form |
| code | Σ | 0..1 | code | Coded form of the unit |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Extension.value[x]:valueQuantity.comparator | required | QuantityComparator |
| Id | Grade | Path | Details | Requirements |
| ele-1 | error | Extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueQuantity.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.value[x]:valueQuantity.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x]:valueQuantity.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueQuantity.comparator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueQuantity.unit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueQuantity.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueQuantity.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |