Address (MY Core)
Defining URL | http://fhir.hie.moh.gov.my/StructureDefinition/Address-my-core |
version | 1.0.0 |
Name | AddressMyCore |
Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world |
Title | Address (MY Core) |
Status | Active as of 11-3-2022 |
Publisher | Malaysia MOH - HIE Steering Committee |
Copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
Address | |
Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. |
Cardinality | 0...* |
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Mappings |
|
Address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Address.extension:state | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Address.extension:district | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Address.extension:division | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Address.extension:subDivision | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Address.use | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | 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. |
Invariants |
|
Examples | General home |
Mappings |
|
Address.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. |
Cardinality | 0...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Summary | True |
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). |
Invariants |
|
Examples | General both |
Mappings |
|
Address.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
Address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Cardinality | 0...* |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Binding | ValueSetCityMyCore (example) |
Summary | True |
Alias | Municpality |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | 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. |
Invariants |
|
Examples | General Madison |
Mappings |
|
Address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Province, Territory |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Binding | ValueSetPostcodeMyCore (preferred) |
Summary | True |
Alias | Zip |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
Address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Address-my-core" /> <meta> <versionId value="2" /> <lastUpdated value="2024-02-12T10:56:05.9176916+00:00" /> </meta> <url value="http://fhir.hie.moh.gov.my/StructureDefinition/Address-my-core" /> <name value="AddressMyCore" /> <title value="Address (MY Core)" /> <status value="active" /> <date value="2024-02-14T07:47:10.4519661+00:00" /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <type value="Address" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Address" /> <derivation value="constraint" /> <differential> <element id="Address.extension:state"> <path value="Address.extension" /> <sliceName value="state" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core" /> </type> <isModifier value="false" /> </element> <element id="Address.extension:district"> <path value="Address.extension" /> <sliceName value="district" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core" /> </type> <isModifier value="false" /> </element> <element id="Address.extension:division"> <path value="Address.extension" /> <sliceName value="division" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/address-division-my-core" /> </type> <isModifier value="false" /> </element> <element id="Address.extension:subDivision"> <path value="Address.extension" /> <sliceName value="subDivision" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/address-sub-division-my-core" /> </type> <isModifier value="false" /> </element> <element id="Address.city"> <path value="Address.city" /> <binding> <strength value="example" /> <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/city-my-core" /> </binding> </element> <element id="Address.postalCode"> <path value="Address.postalCode" /> <binding> <strength value="preferred" /> <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/postcode-my-core" /> </binding> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "Address-my-core", "meta": { "versionId": "2", "lastUpdated": "2024-02-12T10:56:05.9176916+00:00" }, "url": "http://fhir.hie.moh.gov.my/StructureDefinition/Address-my-core", "name": "AddressMyCore", "title": "Address (MY Core)", "status": "active", "date": "2024-02-14T07:47:10.4519661+00:00", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "type": "Address", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address", "derivation": "constraint", "differential": { "element": [ { "id": "Address.extension:state", "path": "Address.extension", "sliceName": "state", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/address-state-my-core" ] } ], "isModifier": false }, { "id": "Address.extension:district", "path": "Address.extension", "sliceName": "district", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/address-district-my-core" ] } ], "isModifier": false }, { "id": "Address.extension:division", "path": "Address.extension", "sliceName": "division", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/address-division-my-core" ] } ], "isModifier": false }, { "id": "Address.extension:subDivision", "path": "Address.extension", "sliceName": "subDivision", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.hie.moh.gov.my/StructureDefinition/address-sub-division-my-core" ] } ], "isModifier": false }, { "id": "Address.city", "path": "Address.city", "binding": { "strength": "example", "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/city-my-core" } }, { "id": "Address.postalCode", "path": "Address.postalCode", "binding": { "strength": "preferred", "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/postcode-my-core" } } ] } }
Snapshot
Address | Address | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
state | I | 0..1 | Extension(CodeableConcept) |
district | I | 0..1 | Extension(CodeableConcept) |
division | I | 0..1 | Extension(CodeableConcept) |
subDivision | I | 0..1 | Extension(CodeableConcept) |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | stringBinding |
country | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
Diff
Address | Address | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
state | I | 0..1 | Extension(CodeableConcept) |
district | I | 0..1 | Extension(CodeableConcept) |
division | I | 0..1 | Extension(CodeableConcept) |
subDivision | I | 0..1 | Extension(CodeableConcept) |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | stringBinding |
country | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
Hybrid
Address | Address | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
state | I | 0..1 | Extension(CodeableConcept) |
district | I | 0..1 | Extension(CodeableConcept) |
division | I | 0..1 | Extension(CodeableConcept) |
subDivision | I | 0..1 | Extension(CodeableConcept) |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | stringBinding |
country | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
This profile is derived from the base FHIR Address data type resource.
Requirements
This structure defines these element as mandatory requirement:
Terminology Bindings
Path | Conformance | ValueSet |
---|---|---|
Address.use | required | AddressUse |
Address.type | required | AddressType |