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
| Active as of 2022-05-31 |
Definitions for the group-address extension.
| 1. Extension | |
| Definition | Whether the Group has the poverty status. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 2. Extension.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 3. Extension.extension | |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/group-address |
| 5. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 |
| Type | Address |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
| 6. Extension.value[x]:valueAddress | |
| SliceName | valueAddress |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 |
| Type | Address |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 7. Extension.value[x]:valueAddress.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 8. Extension.value[x]:valueAddress.extension | |
| Definition | Specifies the Group Location reference to the city/village level. |
| Control | 1..* |
| Type | Extension |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 9. Extension.value[x]:valueAddress.extension:municipality | |
| SliceName | municipality |
| Definition | The location level between District and City/Village. |
| Control | 0..1 |
| Type | Extension(AddressMunicipalityExtension) (Extension Type: string) |
| Must Support | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 10. Extension.value[x]:valueAddress.extension:location | |
| SliceName | location |
| Definition | The reference to address' location for City/Village level. |
| Control | 1..1 |
| Type | Extension(AddressLocationReferenceExtension) (Extension Type: Reference(OpenIMISLocation)) |
| Must Support | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 11. Extension.value[x]:valueAddress.use | |
| Definition | The purpose of this address. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AddressUse The use of an address. |
| Type | code |
| Is Modifier | true |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Pattern Value | home |
| Example | General:home |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 12. Extension.value[x]:valueAddress.type | |
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AddressType The type of an address (physical / postal). |
| Type | code |
| Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Pattern Value | physical |
| Example | General:both |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 13. Extension.value[x]:valueAddress.text | |
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
| Control | 0..1 |
| Type | string |
| Requirements | A renderable, unencoded form. |
| Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Example | General:137 Nowhere Street, Erewhon 9132 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 14. Extension.value[x]:valueAddress.line | |
| Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| Control | 0..1 |
| Type | string |
| Example | General:137 Nowhere Street |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 15. Extension.value[x]:valueAddress.city | |
| Definition | Insuree's City/Village name as it is configured in openIMIS. |
| Control | 0..1 |
| Type | string |
| Must Support | true |
| Alternate Names | Municpality |
| Example | General:Erewhon |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 16. Extension.value[x]:valueAddress.district | |
| Definition | Insuree's District name as it is configured in openIMIS. |
| Control | 0..1 |
| Type | string |
| Must Support | true |
| Alternate Names | County |
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
| Example | General:Madison |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 17. Extension.value[x]:valueAddress.state | |
| Definition | Insuree's State/Region name as it is configured in openIMIS. |
| Control | 0..1 |
| Type | string |
| Must Support | true |
| Alternate Names | Province, Territory |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 18. Extension.value[x]:valueAddress.postalCode | |
| Definition | A postal code designating a region defined by the postal service. |
| Control | 0..0 |
| Type | string |
| Alternate Names | Zip |
| Example | General:9132 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 19. Extension.value[x]:valueAddress.country | |
| Definition | Country - a nation as commonly understood or generally accepted. |
| Control | 0..0 |
| Type | string |
| Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 20. Extension.value[x]:valueAddress.period | |
| Definition | Time period when address was/is in use. |
| Control | 0..1 |
| Type | Period |
| Requirements | Allows addresses to be placed in historical context. |
| Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23"/> <end value="2010-07-01"/> </valuePeriod> |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |