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/group-address | Version: 1.0.0 | |||
| Active as of 2022-05-31 | Responsible: openIMIS Initiative | Computable Name: GroupAddressExtension | ||
Whether the Group has the poverty status.
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
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 5 elements
Fixed Value: 1 element
Prohibited: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | Poverty Status (Group) | |
  extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/group-address" | |
 value[x] | 0..1 | Address | Value of extension Slice: Unordered, Open by type:$this | |
 valueAddress | 0..1 | Address | Value of extension | |
 extension | 1..* | Extension | Group Location Reference | |
 address-municipality | S | 0..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| use | 0..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: home | |
| type | 0..1 | code | postal | physical | both Required Pattern: physical | |
| line | 0..1 | string | Street name, number, direction & P.O. Box etc. | |
| city | S | 0..1 | string | City/Village |
| district | S | 0..1 | string | District |
| state | S | 0..1 | string | State/Region |
| postalCode | 0..0 | |||
 country | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Poverty Status (Group) | |
 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/group-address" | |
| Slices for value[x] | 0..1 | Address | Value of extension Slice: Unordered, Closed by type:$this | |
 value[x]:valueAddress | 0..1 | Address | Value of extension | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 1..* | Extension | Group Location Reference Slice: Unordered, Open by value:url | |
| address-municipality | S | 0..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city | SΣ | 0..1 | string | City/Village Example General: Erewhon |
| district | SΣ | 0..1 | string | District Example General: Madison |
| state | SΣ | 0..1 | string | State/Region |
  period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 5 elements
Fixed Value: 1 element
Prohibited: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Poverty Status (Group) | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/group-address" | |
| value[x] | 0..1 | Address | Value of extension Slice: Unordered, Open by type:$this | |
| valueAddress | 0..1 | Address | Value of extension | |
| extension | 1..* | Extension | Group Location Reference | |
| address-municipality | S | 0..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| use | 0..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: home | |
| type | 0..1 | code | postal | physical | both Required Pattern: physical | |
| line | 0..1 | string | Street name, number, direction & P.O. Box etc. | |
| city | S | 0..1 | string | City/Village |
| district | S | 0..1 | string | District |
| state | S | 0..1 | string | State/Region |
| postalCode | 0..0 | |||
| country | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Poverty Status (Group) | |
| 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/group-address" | |
| Slices for value[x] | 0..1 | Address | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueAddress | 0..1 | Address | Value of extension | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 1..* | Extension | Group Location Reference Slice: Unordered, Open by value:url | |
| address-municipality | S | 0..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city | SΣ | 0..1 | string | City/Village Example General: Erewhon |
| district | SΣ | 0..1 | string | District Example General: Madison |
| state | SΣ | 0..1 | string | State/Region |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Extension.value[x]:valueAddress.use | required | Pattern: home |
| Extension.value[x]:valueAddress.type | required | Pattern: physical |
| 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]:valueAddress | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueAddress.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.value[x]:valueAddress.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x]:valueAddress.extension:municipality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.value[x]:valueAddress.extension:municipality | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x]:valueAddress.extension:location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.value[x]:valueAddress.extension:location | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x]:valueAddress.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueAddress.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueAddress.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueAddress.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueAddress.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueAddress.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueAddress.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueAddress.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |