HL7 Vietnam VN Core FHIR Implementation Guide

Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam
0.5.0 - Draft for Community Review

Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam - Local Development build (v0.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Hồ sơ kiểu dữ liệu: Địa chỉ VN Core — VN Core Address Profile - Mô tả chi tiết

Draft tại thời điểm 2026-03-21

Các định nghĩa cho vn-core-address hồ sơ kiểu dữ liệu

- Bảng phần tử chính
- Bảng Differential
- Bảng Snapshot

Guidance on how to interpret the contents of this table can be foundhere

0. 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.
Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
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). 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).
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) vn-addr-province: Địa chỉ Việt Nam (country = 'VN') phải có extension:province (mã tỉnh/TP) — theo mẫu CH Core ch-addr-2 (`country.empty() or country != 'VN' or extension.where(url = 'http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-province').exists()`)
2. Address.extension:province
Slice Name | province
Definition | Mã tỉnh/thành phố theo QĐ 19/2025/QĐ-TTg (34 đơn vị)
Short | Mã tỉnh/thành phố (QĐ 19/2025)
Control | 0..1
Type | Extension(Tỉnh/Thành phố (mã hóa) — Vietnam Province Extension) (Extension Type: Coding)
Is Modifier | false
Must Support | true
Summary | false
Invariants | 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())
4. Address.extension:ward
Slice Name | ward
Definition | Mã xã/phường/thị trấn theo QĐ 19/2025/QĐ-TTg Phụ lục II (mã 5 chữ số, 00001–99999)
Short | Mã xã/phường (QĐ 19/2025)
Control | 0..1
Type | Extension(Xã/Phường (mã hóa) — Vietnam Ward/Commune Extension) (Extension Type: Coding)
Is Modifier | false
Must Support | true
Summary | false
Invariants | 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())
6. Address.use
Definition | The purpose of this address.
Short | home | work | temp | old | billing - purpose of this address
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/address-use|4.0.1` ) The use of an address.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Example | General: home
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. 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.
Short | Địa chỉ đầy đủ dạng textText representation of the address
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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | A renderable, unencoded form.
Example | General: 137 Nowhere Street, Erewhon 9132
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. 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.
Short | Số nhà, đường, thôn/ấpStreet name, number, direction & P.O. Box etc.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Example | General: 137 Nowhere Street
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Address.district
Definition | Tên quận/huyện cũ. Giữ lại cho tương thích ngược với dữ liệu HIS cũ. KHÔNG Must Support — khuyến khích chỉ dùng state (tỉnh) + extension:ward (xã). The name of the administrative area (county).
Short | Quận/Huyện (legacy — không còn chính thức sau NQ 202/2025)District name (aka 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | County
Example | General: Madison
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Address.state
Definition | Tên tỉnh/thành phố dạng text — bổ sung cho extension:province (mã hóa) 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).
Short | Tên tỉnh/thành phố (text)Sub-unit of country (abbreviations ok)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Alternate Names | Province, Territory
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Address.postalCode
Definition | A postal code designating a region defined by the postal service.
Short | Mã bưu chínhPostal code for area
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Zip
Example | General: 9132
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Address.country
Definition | Country - a nation as commonly understood or generally accepted.
Short | Quốc gia (mặc định VN)Country (e.g. can be ISO 3166 2 or 3 letter code)
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Address
Invariants | vn-addr-province: Địa chỉ Việt Nam (country = 'VN') phải có extension:province (mã tỉnh/TP) — theo mẫu CH Core ch-addr-2 (`country.empty() or country != 'VN' or extension.where(url = 'http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-province').exists()`)
2. Address.extension:province
Slice Name | province
Definition | Mã tỉnh/thành phố theo QĐ 19/2025/QĐ-TTg (34 đơn vị)
Short | Mã tỉnh/thành phố (QĐ 19/2025)
Control | 0..1
Type | Extension(Tỉnh/Thành phố (mã hóa) — Vietnam Province Extension) (Extension Type: Coding)
Must Support | true
4. Address.extension:ward
Slice Name | ward
Definition | Mã xã/phường/thị trấn theo QĐ 19/2025/QĐ-TTg Phụ lục II (mã 5 chữ số, 00001–99999)
Short | Mã xã/phường (QĐ 19/2025)
Control | 0..1
Type | Extension(Xã/Phường (mã hóa) — Vietnam Ward/Commune Extension) (Extension Type: Coding)
Must Support | true
6. Address.text
Short | Địa chỉ đầy đủ dạng text
Must Support | true
8. Address.line
Short | Số nhà, đường, thôn/ấp
Must Support | true
10. Address.district
Definition | Tên quận/huyện cũ. Giữ lại cho tương thích ngược với dữ liệu HIS cũ. KHÔNG Must Support — khuyến khích chỉ dùng state (tỉnh) + extension:ward (xã).
Short | Quận/Huyện (legacy — không còn chính thức sau NQ 202/2025)
12. Address.state
Definition | Tên tỉnh/thành phố dạng text — bổ sung cho extension:province (mã hóa)
Short | Tên tỉnh/thành phố (text)
Must Support | true
14. Address.postalCode
Short | Mã bưu chính
16. Address.country
Short | Quốc gia (mặc định VN)

Guidance on how to interpret the contents of this table can be foundhere

0. 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.
Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
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).
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) vn-addr-province: Địa chỉ Việt Nam (country = 'VN') phải có extension:province (mã tỉnh/TP) — theo mẫu CH Core ch-addr-2 (`country.empty() or country != 'VN' or extension.where(url = 'http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-province').exists()`)
2. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. 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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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 `Address.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Address.extension:province
Slice Name | province
Definition | Mã tỉnh/thành phố theo QĐ 19/2025/QĐ-TTg (34 đơn vị)
Short | Mã tỉnh/thành phố (QĐ 19/2025)
Control | 0..1
Type | Extension(Tỉnh/Thành phố (mã hóa) — Vietnam Province Extension) (Extension Type: Coding)
Is Modifier | false
Must Support | true
Summary | false
Invariants | 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()`)
8. Address.extension:ward
Slice Name | ward
Definition | Mã xã/phường/thị trấn theo QĐ 19/2025/QĐ-TTg Phụ lục II (mã 5 chữ số, 00001–99999)
Short | Mã xã/phường (QĐ 19/2025)
Control | 0..1
Type | Extension(Xã/Phường (mã hóa) — Vietnam Ward/Commune Extension) (Extension Type: Coding)
Is Modifier | false
Must Support | true
Summary | false
Invariants | 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. Address.use
Definition | The purpose of this address.
Short | home | work | temp | old | billing - purpose of this address
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from AddressUse (required to `http://hl7.org/fhir/ValueSet/address-use|4.0.1` ) The use of an address.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Example | General: home
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. 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.
Short | postal | physical | both
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).
Control | 0..1
Binding | The codes SHALL be taken from AddressType (required to `http://hl7.org/fhir/ValueSet/address-type|4.0.1` ) The type of an address (physical / postal).
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: both
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. 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.
Short | Địa chỉ đầy đủ dạng text
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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | A renderable, unencoded form.
Example | General: 137 Nowhere Street, Erewhon 9132
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. 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.
Short | Số nhà, đường, thôn/ấp
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Example | General: 137 Nowhere Street
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Address.city
Definition | The name of the city, town, suburb, village or other community or delivery center.
Short | Name of city, town etc.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Municpality
Example | General: Erewhon
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Address.district
Definition | Tên quận/huyện cũ. Giữ lại cho tương thích ngược với dữ liệu HIS cũ. KHÔNG Must Support — khuyến khích chỉ dùng state (tỉnh) + extension:ward (xã).
Short | Quận/Huyện (legacy — không còn chính thức sau NQ 202/2025)
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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | County
Example | General: Madison
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Address.state
Definition | Tên tỉnh/thành phố dạng text — bổ sung cho extension:province (mã hóa)
Short | Tên tỉnh/thành phố (text)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Alternate Names | Province, Territory
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Address.postalCode
Definition | A postal code designating a region defined by the postal service.
Short | Mã bưu chính
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Zip
Example | General: 9132
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Address.country
Definition | Country - a nation as commonly understood or generally accepted.
Short | Quốc gia (mặc định VN)
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Address.period
Definition | Time period when address was/is in use.
Short | Time period when address was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows addresses to be placed in historical context.
Example | General: { "start" : "2010-03-23", "end" : "2010-07-01" }
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)